Caution – Replaced by Recipients featureThe 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 – Only for countries that don’t use IBANOnly 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 – Additional information may be requiredOTHER-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
BICfield. In theIBANfield, combine the 6-digit Bank State Branch (BSB) number and the account number.
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 35, min. length 5; alphanumeric characters only.The unique number of the bank account.
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)
- 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)
The country in which the bank account is registered.
Max. length: 255 charactersThe full name of the owner of the bank account. (Format: FirstName LastName)
Max. length: 255 charactersCustom 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).
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).
Responses
200
200
Information about the address of residence of the bank account owner.
Max. length 35, min. length 5; alphanumeric characters only.The unique number of the bank account.
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)
- 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)
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country in which the bank account is registered.
The unique identifier of the User (natural or legal) who owns the bank account.
Max. length: 255 charactersThe full name of the owner of the bank account. (Format: FirstName LastName)
Returned values:
The values are:
IBAN, US, CA, GB, OTHERThe type of the bank account, indicating the country where the real-life account is registeredThe 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)
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom 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).
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.