Create Bank Account

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonOptional

accountNameRequiredstring

A unique identifier to remember the bank account

bankNameRequiredstring

The name of the bank associated with the account, such as Bank of America.

currencyRequiredstring

The currency code in which the bank account operates. Refer to our Currency Code for the full list.

accountDetailsRequiredobject

The account details contain the details of the bank account, tailored to each different currency. Please refer to our Bank Account Creation for a detailed information on constructing the payment request.

beneficiaryAddressRequiredobject

Path Parameters

customer_idRequiredstring

The customer's id.

curl -X POST "https://api.sandbox.spherepay.co/v2/customers/{{customer_id}}/bank-account" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "accountName": "wise",
    "bankName": "wise",
    "accountHolderName": "John Doe",
    "currency": "usd",
    "accountDetails": {
      "accountNumber": "352777177759389",
      "routingNumber": "084009519",
      "accountType": "savings"
    },
    "beneficiaryAddress": {
      "line1": "423 Hougang ave 6 ",
      "line2": "08-108",
      "city": "Singapore",
      "postalCode": "544399",
      "state": "01",
      "country": "SGP"
    }
  }'

{
  "id": "bankAccount_1c19dcf3caaa447bb209df0e5d599e8d",
  "status": "active",
  "bankName": "Chase",
  "accountHolderName": "John Mock-Doe",
  "accountName": "Savings Account",
  "customer": "customer_68f1c089703945e7bbff6f04bf1c5041",
  "currency": "usd",
  "accountDetails": {
    "accountNumber": "**********6789",
    "routingNumber": "**********6789",
    "accountType": "checking | savings",
    "bic": "**********6789",
    "iban": "**********6789",
    "country": "BRA",
    "pixKey": "**********6789",
    "taxId": "**********6789",
    "clabeNumber": "**********6789",
    "phpChannelSubject": "allbank",
    "phpNetwork": "instapay",
    "inrIfsc": "**********6789",
    "bankId": "**********6789",
    "sortCode": "**********6789",
    "branchCode": "12345"
  }
}

Create Bank Account

Authorization

Request Body

Path Parameters

Response

TypeScript