Create a GB Bank Account

Caution – 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.

Path parameters

UserId · string · required

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

Body parameters

OwnerAddress · object · required

Information about the address of residence of the bank account owner.

Show properties

AddressLine1 · string · required

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string · required

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string · required

The country of the address.

AccountNumber · string · required

Length: 8 digits

The unique set of digits of the bank account.

SortCode · string · required

The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts.

OwnerName · string · required

Max. length: 255 characters

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

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).

Responses

200

OwnerAddress · object

Information about the address of residence of the bank account owner.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

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

The country of the address.

AccountNumber · string

Length: 8 digits

The unique set of digits of the bank account.

SortCode · string

The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts.

UserId · string

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

OwnerName · string

Max. length: 255 characters

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

Type · string

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)

Id · string

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

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).

CreationDate · Unix timestamp

The date and time at which the object was created.

Active · boolean

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.

400 - Blocked bank account

{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"9d4feea4-353f-416d-b8d6-8053471785ea#1677146902",
    "Date":1677146903,
    "errors":{
        "GB":"The GB account is blocked by Fraud Policy"
    }
}  

400 - AccountNumber format not accepted

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "6977ee65-e865-4fdb-8a4b-835f47fff41f",
    "Date": 1698756883.0,
    "errors": {
        "AccountNumber": "The field AccountNumber must match the regular expression '\\d{8}'."
    }
}  

400 - SortCode format not accepted

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "9b1dd701-a274-4be8-aabf-872a1557c9e9",
    "Date": 1698756987.0,
    "errors": {
        "SortCode": "The field SortCode must match the regular expression '\\d{6}'."
    }
}  

400 - SortCode invalid

{
    "Message": "One or several required parameters are missing or incorrect",
    "Type": "bankaccount_error",
    "Id": "c2cea07c-4403-4f5d-b80e-806c1cc60112",
    "Date": 1698757035.0,
    "errors": {
        "SortCode": "SortCode is invalid"
    }
}  

400 - AccountNumber and SortCode combination not valid

{
    "Message": "One or several required parameters are missing or incorrect",
    "Type": "bankaccount_error",
    "Id": "55ed90cb-cbc5-438b-ba5d-3207ef27d341",
    "Date": 1698757180.0,
    "errors": {
        "AccountNumber": "AccountNumber is invalid or is not applicable for this SortCode"
    }
}  

200

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des Plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "SortCode":"010039",
    "UserId":"142036728",
    "OwnerName":"Joe Blogs",
    "Type":"GB",
    "Id":"150297947",
    "Tag":null,
    "CreationDate":1661866223,
    "Active":true
}  

REST

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des Plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "SortCode":"010039",
    "OwnerName":"Joe Blogs",
    "Tag":"Created using the Mangopay API Collection Postman"
}