Sphere Paysphere

Bank Account

Learn how to add and manage bank accounts for your customers, enabling seamless transfers across different countries and currencies.

Adding a bank account for your customer requires specific details that vary by country and currency. In this guide, we’ll break down exactly what's required to set up bank accounts for various regions clearly and easily.

Common information required for all bank accounts includes:

  • Bank Name
  • Account Holder Name
  • Account Holder Address
POST https://api.spherepay.co/v2/customers/:customer_id/bank-accounts/

Below, you'll find specific details required under the accountDetails field, organized by country.


United States Bank Account

To add a bank account for a customer in the United States, you'll need:

  • Routing Number
  • Account Number
  • Account Type

For full API details, refer to the Sphere API Reference.

Account Details

{
    "accountDetails": {
        "accountNumber": "1234567890",
        "routingNumber": "123456789",
        "accountType": "savings"
    }
}

European Union Bank Account

To add a bank account for a customer in the European Union, you'll need:

  • The IBAN number of the bank account
  • The BIC/SWIFT code of the bank
  • The country code of the bank account

For full API details, refer to the Sphere API Reference.

Account Details

{
    "accountDetails": {
        "iban": "1234567890",
        "bic": "123456789",
        "country": "DE"
    }
}

Mexico Bank Account

To add a bank account for a customer in Mexico, you'll need:

  • The CLABE number of the bank account

For full API details, refer to the Sphere API Reference.

Account Details

{
    "accountDetails": {
        "mxnClabeNumber": "1234567890"
    }
}

Brazil Bank Account

To add a bank account for a customer in Brazil, you'll need:

  • The unique Pix Key of the bank account
  • The Tax ID of the customer

For full API details, refer to the Sphere API Reference.

Account Details

{
    "accountDetails": {
        "pixKey": "1234567890",
        "taxId": "1234567890"
    }
}

Last updated on

On this page