Skip to main content
POST
/
bank-account
/
add
Add customer's bank account
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/bank-account/add \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form customerId=6ac34182-aa2e-4290-ab1b-302a09f451d1 \
  --form currency=USD \
  --form 'bankName=Chase Bank' \
  --form accountNo=1234567890 \
  --form swift=CHASUS33 \
  --form bankCountry=USA \
  --form 'bankAddress=270 Park Ave, New York, NY 10017' \
  --form aba=021000021 \
  --form iban=GB33BUKB20201555555555 \
  --form 'beneficiaryName=John Doe' \
  --form 'beneficiaryAddress=1 Infinite Loop, Cupertino, CA 95014' \
  --form 'interBankName=Citibank N.A.' \
  --form interBankBic=CITIUS33 \
  --form interBankAccountNo=9876543210 \
  --form institutionNumber=001 \
  --form transit=00011 \
  --form 'label=Main USD settlement account' \
  --form statementFile='@example-file'
{
  "status": "SUCCESS",
  "data": {
    "id": "c3c4de46-64ca-4d88-a16e-30b418726520"
  }
}

Authorizations

X-API-Key
string
header
required

Body

multipart/form-data
customerId
string
required

Customer ID

Example:

"6ac34182-aa2e-4290-ab1b-302a09f451d1"

currency
string
required

Currency

Example:

"USD"

bankName
string
required

Bank name

Example:

"Chase Bank"

accountNo
string

Account number

Example:

"1234567890"

swift
string

SWIFT code

Example:

"CHASUS33"

bankCountry
string

Bank country code

Example:

"USA"

bankAddress
string

Bank address

Example:

"270 Park Ave, New York, NY 10017"

aba
string

ABA routing number

Example:

"021000021"

iban
string

IBAN

Example:

"GB33BUKB20201555555555"

beneficiaryName
string

Beneficiary name

Example:

"John Doe"

beneficiaryAddress
string

Beneficiary address

Example:

"1 Infinite Loop, Cupertino, CA 95014"

interBankName
string

Intermediary bank name

Example:

"Citibank N.A."

interBankBic
string

Intermediary bank BIC

Example:

"CITIUS33"

interBankAccountNo
string

Intermediary bank account number

Example:

"9876543210"

institutionNumber
string

Institution number

Example:

"001"

transit
string

Transit number

Example:

"00011"

label
string

Label

Example:

"Main USD settlement account"

statementFile
file

Bank statement file

Response

Create bank account successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data