v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

bankAccounts

Create a GB 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>

Create a GB Bank Account

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

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

Length: 8 digits

The unique set of digits of the bank account.

SortCodestring required

The 6-digit sort code, assigned to UK financial institutions, for GB-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.

Response

Success

AccountNumberstring

Length: 8 digits

The unique set of digits of the bank account.

SortCodestring

The 6-digit sort code, assigned to UK financial institutions, for GB-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.