Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a GB Bank Account
Path parameters
The unique identifier of the User (natural or legal) who owns the bank account.
Body parameters
Information about the address of residence of the bank account owner.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country
is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
The country of the address.
Length: 8 digits
The unique set of digits of the bank account.
The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts.
Max. length: 255 characters
The full name of the owner of the bank account. (Format: FirstName LastName)
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
Information about the address of residence of the bank account owner.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country
is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Length: 8 digits
The unique set of digits of the bank account.
The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts.
The unique identifier of the User (natural or legal) who owns the bank account.
Max. length: 255 characters
The full name of the owner of the bank account. (Format: FirstName LastName)
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 IBANUS
– For accounts registered in the United StatesCA
– For accounts registered in CanadaGB
– For accounts registered in the United KingdomOTHER
– For accounts registered in countries that do not use IBAN (and are not US, CA, GB)
The unique identifier of the object.
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).
The date and time at which the object was created.
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.
{
"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"
}
}
{
"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}'."
}
}
{
"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}'."
}
}
{
"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"
}
}
{
"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"
}
}
Was this page helpful?