PayoutsBank accounts

Create a CA Bank Account

<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](/api-reference/recipients/recipient-object) and authenticated using SCA. Payouts to Bank Accounts created after May 1, 2026, will fail with the `ResultCode` [121018](/errors/codes/121018). To resolve this, register the external account using [POST Create a Recipient](/api-reference/recipients/create-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](/api-reference/recipients/view-recipient) endpoint using the same `BankAccountId`. Read more about [legacy bank account migration](/guides/payouts#migration-of-legacy-bank-accounts). </Note> Create a CA Bank Account

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

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

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

Request

This endpoint expects an object.
OwnerAddressobjectRequired

The address of the platform operator’s headquarters. This parameter must be provided for the platform’s payouts to be processed.

AccountNumberstringRequired

Format: Digits only

The unique number of the bank account (between 7 to 35 digits).

InstitutionNumberstringRequired

Length: 3 digits

The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.

BranchCodestringRequired

Length: 5 digits

The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.

BankNamestringRequired

Max. length: 50 characters (letters and digits only)

The name of the Canadian bank for CA-type bank accounts.

OwnerNamestringRequired

Max. length: 255 characters

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

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success
OwnerAddressobject
The postal address.
AccountNumberstring

Format: Digits only

The unique number of the bank account (between 7 to 35 digits).

InstitutionNumberstring

Length: 3 digits

The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.

BranchCodestring

Length: 5 digits

The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.

BankNamestring

Max. length: 50 characters (letters and digits only)

The name of the Canadian bank for CA-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.

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.

Errors

400
Bad Request Error