Skip to main content
POST
/
off-ramp
/
bank-accounts
Add Bank Account
curl --request POST \
  --url https://api.coinvoyage.io/v3/off-ramp/bank-accounts \
  --header 'Authorization: <api-key>' \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_owner_name": "<string>",
  "address": {
    "street_line_1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "street_line_2": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "bank_name": "<string>",
  "account_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "account": {
    "account_number": "<string>",
    "routing_number": "<string>",
    "sort_code": "<string>"
  },
  "iban": {
    "account_number": "<string>",
    "country": "<string>",
    "bic": "<string>"
  },
  "swift": {
    "account": {
      "account_number": "<string>",
      "country": "<string>",
      "bic": "<string>"
    },
    "address": {
      "street_line_1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "street_line_2": "<string>",
      "state": "<string>",
      "postal_code": "<string>"
    },
    "purpose_of_funds": [
      "<string>"
    ],
    "short_business_description": "<string>"
  },
  "clabe": {
    "account_number": "<string>"
  },
  "pix": {
    "document_number": "<string>",
    "pix_key": "<string>",
    "br_code": "<string>"
  }
}
'
{
  "id": "<string>",
  "account_details": {
    "account_number": "<string>",
    "bank_name": "<string>",
    "routing_number": "<string>",
    "sort_code": "<string>",
    "checking_or_savings": "<string>",
    "bic": "<string>",
    "pix_key": "<string>"
  },
  "active": true,
  "account_name": "<string>",
  "bank_name": "<string>",
  "beneficiary_address_valid": true,
  "deactivation_reason": "<string>",
  "deactivation_details": "<string>"
}

Authorizations

​
Authorization
string
header
required

HMAC-SHA256 signature. See the Authorization-Signature header parameter on signed operations.

Headers

​
Authorization-Signature
string
required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Body

application/json
​
account_owner_name
string
required
​
address
object
required
​
bank_name
string
required
​
currency
enum<string>
required

Currency used by the external bank account

Available options:
usd,
eur,
mxn,
brl,
gbp
​
account_type
enum<string>
required

Bank account rail: us (ACH), iban, swift, clabe, pix, or gb (FPS)

Available options:
us,
iban,
swift,
clabe,
pix,
gb
​
account_name
string
​
account_owner_type
enum<string>

Whether the bank account owner is an individual or business

Available options:
individual,
business
​
first_name
string
​
last_name
string
​
business_name
string
​
account
object
​
iban
object
​
swift
object
​
clabe
object
​
pix
object

Response

Bank account created

​
id
string
required
​
account_type
enum<string>
required

Bank account rail: us (ACH), iban, swift, clabe, pix, or gb (FPS)

Available options:
us,
iban,
swift,
clabe,
pix,
gb
​
account_details
object
required
​
currency
enum<string>
required

Currency used by the external bank account

Available options:
usd,
eur,
mxn,
brl,
gbp
​
active
boolean
required
​
account_name
string | null
​
bank_name
string | null
​
account_owner_type
enum<string> | null

Whether the bank account owner is an individual or business

Available options:
individual,
business
​
beneficiary_address_valid
boolean | null
​
deactivation_reason
string | null
​
deactivation_details
string | null