Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Funding
Accounts

Create a Bank Relationship for an Account

If successful, retrieves Bank Relationships for an account

post/v1/accounts/{account_id}/recipient_banks

Path parameters

account_idstring uuid required

Account identifier.

Request body

account_numberstring required
bank_codestring required

9-Digit ABA RTN (Routing Number) or BIC

bank_code_type'ABA' | 'BIC' required

ABA (Domestic) or BIC (International)

citystring

Only for international banks, ie if bank_code_type = BIC

countrystring

Only for international banks, ie if bank_code_type = BIC

namestring required

Name of recipient bank

postal_codestring

Only for international banks, ie if bank_code_type = BIC. Minimum of 3 characters

state_provincestring

Only for international banks, ie if bank_code_type = BIC

street_addressstring

Only for international banks, ie if bank_code_type = BIC

Response

The created Bank relationship

account_idstring uuid
account_numberstring required
bank_codestring required

9-Digit ABA RTN (Routing Number) or BIC

bank_code_type'ABA' | 'BIC' required

ABA (Domestic) or BIC (International)

citystring

Only for international banks

countrystring

Only for international banks

created_atstring date-time required

Format: 2020-01-01T01:01:01Z

idstring uuid required
namestring required

Name of recipient bank

postal_codestring

Only for international banks

state_provincestring

Only for international banks

status'QUEUED' | 'SENT_TO_CLEARING' | 'APPROVED' | 'REJECTED' | 'CANCELED'

QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELED

street_addressstring

Only for international banks

updated_atstring date-time required

Format: 2020-01-01T01:01:01Z

Example response

{
  "created_at": "2021-03-16T18:38:01.942282Z",
  "id": "61e69015-8549-4bfd-b9c3-01e75843f47d",
  "updated_at": "2021-03-16T18:38:01.942282Z"
}