Powered by Redocly

Bank accounts

This section provides endpoints to manage and retrieve user bank accounts used for fiat withdrawals.

Payment methods requirements
🇺🇸 ACH (US Domestic USD Payments): holder details + account_number + routing_number + account_type
🇪🇺 SEPA (EUR inside SEPA): holder details + IBAN + bank_country (SEPA) + SWIFT/BIC
🌍 SWIFT (International wire): holder details + IBAN + SWIFT/BIC + bank details (name/address/country); intermediary bank optional for some USD wires
🇨🇦 EFT (Canada CAD): holder details + institution_number + transit_number + account_number + bank_country=CA
🌐 WIRE_TRANSFER: same requirements as SWIFT (wire runs over SWIFT network)

Create Bank Account

Creates a new bank account.

Important: Required fields depend on payment_method.

Common required fields (for all methods):

  • label
  • holder_name
  • holder_street, holder_city, holder_zipcode, holder_country
  • currency_id
  • payment_method
  • method_data

🇺🇸 ACH (US Domestic USD)
Required in method_data:

  • account_number
  • routing_number (ABA, 9 digits)
  • account_type (CHECKING / SAVINGS)
    Notes: Bank address fields are not required for ACH.

🇪🇺 SEPA (EUR inside SEPA)
Required in method_data:

  • iban
  • swift_code (BIC)
    Required at root:
  • bank_country (SEPA country)
    Notes: bank_name/address recommended but not always mandatory.

🌍 SWIFT (International transfers)
Required in method_data:

  • swift_code (BIC)
  • iban (if available) OR account_number (depending on destination)
    Required at root (bank details):
  • bank_name, bank_street, bank_city, bank_zipcode, bank_country
    Optional in method_data (often needed for USD wires):
  • intermediary_bank_name, intermediary_bank_swift, intermediary_bank_address
  • routing_number (only if required by destination)

🇨🇦 EFT (Canada CAD)
Required in method_data:

  • institution_number (3 digits)
  • transit_number (5 digits)
  • account_number
    Required at root:
  • bank_country must be CAN

🌐 WIRE_TRANSFER
Same requirements as SWIFT (wire uses the SWIFT network).

Request
Request Body schema: application/json
required
label
required
string
holder_name
required
string
holder_street
required
string
holder_city
required
string
holder_zipcode
required
string
holder_country
required
string

ISO 3166-1 alpha-3 country code

bank_name
string or null
bank_street
string or null
bank_city
string or null
bank_state
string or null
bank_zipcode
string or null
bank_country
string or null

ISO 3166-1 alpha-3 country code

currency_id
required
string
payment_method
required
string
Enum: "ACH" "SEPA" "SWIFT" "EFT" "WIRE_TRANSFER"
required
object

Payment method specific bank details.

Responses
201

Bank account created successfully

post/bank-accounts
Request samples
application/json
{
  • "label": "US Checking (ACH)",
  • "holder_name": "Crymbo Crymbo",
  • "holder_street": "12 Rothschild Blvd",
  • "holder_city": "Tel Aviv",
  • "holder_zipcode": "6688101",
  • "holder_country": "ISR",
  • "currency_id": "bkE0RmNjbEhCUmc9",
  • "payment_method": "ACH",
  • "method_data": {
    }
}
Response samples
application/json
{
  • "data": {
    },
  • "message": "Bank account created successfully"
}

List Bank Accounts

Returns a list of bank accounts for the authenticated user.

Notes:

  • method_data fields vary by payment_method (ACH/SEPA/SWIFT/EFT/WIRE_TRANSFER).
  • Some responses may include nested User and Currency objects.
Responses
200

Bank accounts retrieved successfully

get/bank-accounts
Response samples
application/json
{
  • "totalItems": 3,
  • "result": [
    ]
}