Deposit

Retrieve deposit information of single currency¶

GET https://connect.cabital.com/api/v1/accounts/{account_id}/balances/{symbol}/deposit/{method}

User Account Status¶

Linked
KYC Pass

Request Path Parameters¶

Parameter	Required	Description
`account_id`	Yes	Customer account ID provided by Cabital.
`symbol`	Yes	Currency code
`method`	No	Deposit method

Response Parameters¶

Parameter	Type	Description
`symbol`	string	Currency code
`method`	string	Deposit method
`meta`	string	Deposit information

Example (`BRL-PIX` - With a valid CPF)¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/BRL/deposit/PIX"

Response Data (200)¶

{
    "symbol": "BRL",
    "method": "PIX",
    "meta": {
        "account_name": "3RZ SERVICOS DIGITAIS LTDA",
        "account_number": "4663-9",
        "bank_name": "BANCO GENIAL S.A.",
        "bank_country": "Brazil",
        "cpf": "158.317.337-42",
        "branch_code": "0001",
        "pix_key": {
            "type": "Email",
            "value": "cabital@brztoken.io",
            "qr_code": "00020101021126410014br.gov.bcb.pix0119cabital@brztoken.io5204000053039865802BR59243RZ SERVICOS DIGITAIS LT6009SAO PAULO62070503***6304F521"
        },
        "tax_id": "32.611.536/0001-30"
    }
}

Example (`BRL-PIX` - Without a valid CPF)¶

Response Data¶

curl "/api/v1/accounts/9ca67029-140e-4491-945e-988a232b8913/balances/BRL/deposit/PIX"

Response Data (400)¶

{
  "code": "PA051",
  "message": "This account currently does not have a valid CPF."
}

User flow

When you get this error message, we recommend to guide customer to complete submitting the CPF process on Widget.

Example (`CHF-SIC`)¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/CHF/deposit/SIC"

Response Data¶

{
    "symbol": "CHF",
    "method": "SIC",
    "meta": {
        "account_name": "Cabital Fintech (LT) UAB",
        "iban": "CH7408799927511421001",
        "ref_code": "V3B7QC",
        "bic": "INCOCHZZ",
        "bank_name": "InCore Bank AG",
        "bank_address": "Wiesenstrasse 17, Schlieren, 8952",
        "bank_country": "Switzerland"
    }
}

Example (`EUR-SEPA`)¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/EUR/deposit/SEPA"

Response Data¶

{
    "symbol": "EUR",
    "method": "SEPA",
    "meta": {
        "account_name": "Cabital Fintech (LT) UAB",
        "iban": "CH1808799927511379814",
        "ref_code": "8TCTP5",
        "bic": "INCOCHZZXXX",
        "bank_name": "InCore Bank AG",
        "bank_address": "Wiesenstrasse 17",
        "bank_country": "Switzerland"
    }
}

Example (`GBP-FPS`)¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/GBP/deposit/FPS"

Response Data¶

{
    "symbol": "GBP",
    "method": "Faster Payments",
    "meta": {
        "account_name": "Cabital Fintech (LT) UAB",
        "ref_code": "V3B7QC",
        "account_number": "00003157",
        "sort_code": "040541",
        "bank_name": "BCB Payments Ltd",
        "bank_address": "5 Merchant Square London",
        "bank_country": "United Kingdom"
    }
}

(Coming Soon)

Example (`USD-SWIFT` - With bound accounts）¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/USD/deposit/SWIFT"

Bank account information

You can refer to Widget to design UI / UX.
If the customer successfully binds accounts, 1 ~ 3 sets of bank account information can be returned in 1 request.
Depending on the country of the customer's bonded bank account, the parameters of source_bank_account will be slightly different, please refer to the following example.
Customer needs to add / delete bound accounts on Widget.

Response Data (200)¶

{
    "symbol": "USD",
    "method": "SWIFT",
    "meta": {
        "bound_bank_accounts": [
            {
                "source_bank_account": {
                    "account_name": "John Doe",
                    "account_number": "6831895333741025",
                    "aba_routing_number": "912284187"
                },
                "virtual_bank_account": {
                    "account_name": "CIRCLE INTERNET FINANCIAL INC",
                    "account_number": "234473136823",
                    "aba_routing_number": "999999999",
                    "swift_code": "CRYPTO99",
                    "bank_name": "CRYPTO BANK",
                    "bank_city": "NEW YORK",
                    "bank_postal_code": "1001",
                    "bank_country": "United States",
                    "bank_address": "1 MONEY STREET"
                }
            },
            {
                "source_bank_account": {
                    "account_name": "John Doe",
                    "iban": "DE31100400480532013000",
                    "bank_city": "Austria"
                },
                "virtual_bank_account": {
                    "account_name": "CIRCLE INTERNET FINANCIAL INC",
                    "account_number": "123801383365",
                    "aba_routing_number": "999999999",
                    "swift_code": "CRYPTO99",
                    "bank_name": "CRYPTO BANK",
                    "bank_city": "NEW YORK",
                    "bank_postal_code": "1001",
                    "bank_country": "United States",
                    "bank_address": "1 MONEY STREET"
                }
            },
            {
                "source_bank_account": {
                    "account_name": "John Doe",
                    "account_number": "3090117478042082",
                    "swift_code": "CMBCHKHH",
                    "bank_name": "CHINA MERCHANTS BANK",
                    "bank_city": "Hongkong"
                },
                "virtual_bank_account": {
                    "account_name": "CIRCLE INTERNET FINANCIAL INC",
                    "account_number": "123910895851",
                    "aba_routing_number": "999999999",
                    "swift_code": "CRYPTO99",
                    "bank_name": "CRYPTO BANK",
                    "bank_city": "NEW YORK",
                    "bank_postal_code": "1001",
                    "bank_country": "United States",
                    "bank_address": "1 MONEY STREET"
                }
            }
        ]
    }
}

Example (`USD-SWIFT` - Without a bound account）¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/USD/deposit/SWIFT"

Response Data (400)¶

{
  "code": "PA052",
  "message": "This account currently does not have a valid bound bank account."
}

User flow

When you get this error message, we recommend to guide customer to complete adding the account process on Widget.

Example (`VND-PAYME`)¶

Request Data¶

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/VND/deposit/"

Response Data¶

{
    "code": "PA050",
    "message": "This currency only supports ATM card deposit method on Cabital."
}

VND deposit flow

It can only be done on Cabital platform, therefore we recommend to guide customers to deposit VND on Widget.