bankAccounts

Create a US Bank Account

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **Caution - Payouts refused to Bank Accounts created after April 30, 2026**

Bank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the Recipient endpoints and authenticated using SCA.

Payouts to Bank Accounts created after May 1, 2026, will fail with the ResultCode 121018. To resolve this, register the external account using POST Create a Recipient and retry the payout. </Warning>

<Note icon="fa-regular fa-circle-info"> **Note – Replaced by Recipients feature**

The Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.

Legacy active Bank Accounts (Active is true) have been migrated to the new feature and their data is retrievable via the GET View a Recipient endpoint using the same BankAccountId. Read more about legacy bank account migration. </Note>

Create a US Bank Account

post/v2.01/{ClientId}/users/{UserId}/bankaccounts/us

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/bankaccounts/us
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

UserIdstring required

The unique identifier of the User (natural or legal) who owns the bank account.

Request body

AccountNumberstring required

Format: Digits only

The unique set of digits of the bank account.

ABAstring required

Length: 9 characters

The American Banking Association (ABA) routing number for US-type bank accounts.

DepositAccountTypestring

Allowed values: CHECKING, SAVINGS

The deposit type for US-type bank accounts.

OwnerNamestring required

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Response

Success

AccountNumberstring

Format: Digits only

The unique set of digits of the bank account.

ABAstring

Length: 9 characters

The American Banking Association (ABA) routing number for US-type bank accounts.

DepositAccountTypestring

Returned values: CHECKING, SAVINGS

The deposit type for US-type bank accounts.

UserIdstring

The unique identifier of the User (natural or legal) who owns the bank account.

OwnerNamestring

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Typestring

Returned values: IBAN, US, CA, GB, OTHER

The type of the bank account, indicating the country where the real-life account is registered The values are:

  • IBAN – For accounts registered in countries that use IBAN
  • US – For accounts registered in the United States
  • CA – For accounts registered in Canada
  • GB – For accounts registered in the United Kingdom
  • OTHER – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)
Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

Activeboolean

Whether or not the Bank Account is active. Mangopay automatically sets this parameter to false if the bank account is closed or does not exist anymore.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_us_bank_account removed and replaced with bankAccounts_create_us_bank_account