This page describes the parameters available in the bank account object.
The bank account object contains the data about the end-user's bank account used for receiving FIAT currency from the Sell trades that the end-user completes.
Key | Type | Description |
---|---|---|
id | Integer | Identifier for the bank account |
account | Object | Object with additional information about the bank account. |
→name | String | Optional name for the trader to identify the account. |
→bic | String | For sepa and international its the SWIFT / BIC number and for danish accounts its the REG number. |
→number | String | For sepa and international it's the IBAN (International Bank Account Number). For danish accounts, it's the BBAN (Basic Bank Account Number). |
→currency | String | Currency of the bank account |
→type | bank account type | Type of the bank account. |
→ ffc | String | For further credit - only applicable for USD bank accounts and if required by trader's bank. If the end-user can get the data, it's highly recommended to provide it for a better chance of a successful bank transfer. |
bank | Object | Object with additional information about the bank. |
→name | String | Name of the bank account holder. |
→address | Object | Object with information about the address of the bank. |
→city | String | City where the bank is located. |
→street | String | Street where the bank is located. |
→zipcode | String | Zip code of the city where the bank is located. |
→country | String | ISO 3166-1 alpha-2 country code. Country of the bank. |
→state | String | (Required for country US). State where the bank is located. |
holder | Object | Object with additional information about the bank account holder. |
→name | String | Name of the bank account holder. |
→address | Object | Object with information about the address of the account holder. |
→city | String | City where the the bank account holder is registered. |
→street | String | Street address. |
→zipcode | String | Zip/Postal code. |
→country | String | ISO 3166-1 alpha-2 country code |
→state | String | State. (Required for country US) |
traderId | Integer | ID of the trader behind the bank account. |
updateTime | ISO 8601 time | The time when the bank account was last updated. Not present if no update. |
createTime | ISO 8601 time | Timestamp for when this bank account was first created. |
Bank account types
The bank accounts have three different types depending on the account currency (account.currency
) and the bank country (bank.address.country
).
When creating a new bank account, you don't explicitly specify the type; instead Coinify decides the type for you, based on the requirements in the following table:
Type | Description | Requirements |
---|---|---|
danish | Danish national bank account | Country must be DK and currency DKK . |
sepa | SEPA bank account | Country must be in our list of SEPA countries, and currency must be EUR . |
international | International bank account | Everything else. |
Here's an example of the bank account object:
{
"id": 49404,
"account": {
"name": "My EUR bank account",
"bic": "1001005",
"number": "HR1210010051863000160",
"currency": "EUR",
"type": "sepa"
},
"bank": {
"name": null,
"address": {
"city": null,
"street": null,
"zipcode": null,
"country": "HR",
"state": "HR"
}
},
"holder": {
"name": "John Though",
"address": {
"city": "Exampleville",
"street": "123 Example Street",
"zipcode": "12345",
"country": "HR",
"state": "HR"
}
},
"trader_id": "13450",
"create_time": "2024-11-05T17:26:59.122Z"
}