The bankAccount object is a condensed way to interact with your customer's bank account information. This endpoint allows you to perform various operations related to bank accounts on your platform.

This feature is only available to merchants that have completed KYB and agreed to our terms of service and privacy policy. These compliance flows are also available in our Dashboard >> Settings >> Payouts. It is currently only available for entities with US bank accounts, with additional regional support coming soon.

It is important that you abide by the various jurisdictional regulations regarding sensitive data. Sphere does not store this data on our servers and all data is encrypted. In our interactions with licensed partners, we employ secure transfer protocols subject to GLBA, BSA/AML, FTC, and state laws.

How it works

The bank account object

Let's take a look at a full example bankAccount object:

{
  "id": "bankAccount_1b1d13e464164224b6fb72b9ae4c499a",
  "bankName": "SPHERE TEST BANK",
  "accountHolderName": "John Doe",
  "meta": {
    "uuid": "<your_uuid>", // optional
  },
  "currency": "usd",
  "last4": "1234",
  "routingNumber": "110000000",
  "accountNumber": "123456789",
  "accountName": "Adv Safe Banking",
  "updated": "2021-01-01T00:00:00.000Z",
  "created": "2021-01-01T00:00:00.000Z"
}

Attributes

id: string Unique identifier for the object. Auto-generated by Sphere upon creation.

bankName: string Name of the bank account associated with the routing number. (e.g. BOFA).

email: string Unique email address associated with the bank account registered.

meta: object Set of key-value pairs (JSON) that you can attach to a bank account object which can be useful for storing additional information about the object.

currency: string Base currency that the bank account operates in (default usd).

accountHolderName: string The name of the person that owns the bank account.

last4: string The last four digits of the bank account number.

routingNumber: string The routing number for the bank account.

accountNumber: string The account number for the bank account.

accountName: string The name of the account associated with the bank account object.

created: string datetime for when the bank account object was created.

updated: string datetime for when the bank account object was updated.