Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
bankAccounts

Create an OTHER 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 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>

<Note icon="fa-regular fa-circle-info"> **Note – Only for countries that don’t use IBAN**

Only use the OTHER type if the account is registered in a country that doesn’t use IBAN and isn’t GB, US, or CA (for which you should use the dedicated type).
</Note>

<Note icon="fa-regular fa-circle-info"> **Note – Additional information may be required**

OTHER-type bank accounts may require additional information depending on the country. Additional precisions per country (if applicable), are given below.

For accounts registered in: 

  • Australia – Provide the BIC in the BIC field. In the IBAN field, combine the 6-digit Bank State Branch (BSB) number and the account number. </Note>

Create an OTHER Bank Account

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

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.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request body

AccountNumberstring required

Max. length 35, min. length 5; alphanumeric characters only.

The unique number of the bank account.

BICstring required

The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.

The BIC can have one of the two following formats:

  • BIC8 – 8-character BIC (AAAABBCC)
  • BIC11 – 11-character BIC (AAAABBCCDDD)

In which:

  • AAAA represents the bank code: 4 characters defining the bank
  • BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)
  • CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country
  • DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)
Countrystring required

The country in which the bank account is registered.

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.

Response

Success

AccountNumberstring

Max. length 35, min. length 5; alphanumeric characters only.

The unique number of the bank account.

BICstring

The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.

The BIC can have one of the two following formats:

  • BIC8 – 8-character BIC (AAAABBCC)
  • BIC11 – 11-character BIC (AAAABBCCDDD)

In which:

  • AAAA represents the bank code: 4 characters defining the bank
  • BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)
  • CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country
  • DDD represents the branch code: 3 characters used to define the branch of the bank (sometimes replaced with XXX)
Countrystring

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country in which the bank account is registered.

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.