​
Description

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.
The Bank Account object represents the actual bank account of the user and is therefore required to:
  • Process a bank wire payout
  • Set up a mandate to process a pay-in by direct debit with a mandate (BACS or SEPA network only)
Different information is required for bank accounts in different countries. This is managed by the Type parameter, which determines the information that needs to be provided via the dedicated endpoint. The values are:
  • IBAN – For accounts registered in countries that use IBAN (including the UK when the payout currency is not GBP)
  • US – For accounts registered in the United States
  • CA – For accounts registered in Canada
  • GB – For accounts registered in the United Kingdom only when the payout currency is GBP (for other payout currencies, use the IBAN type)
  • OTHER – For accounts registered in countries that do not use IBAN (and are not the US, Canada, or the UK)
The country of registration of a bank account is not linked to its currency.
Caution – Creating the wrong type can lead to processing delaysFailure to use the correct type can lead to processing delays. Use the dedicated types for US, CA, and GB. Only use OTHER if the country isn’t one of these and doesn’t use IBAN.
Note – Bank Account creation blocked in restricted countriesDue to anti-money laundering policy, Mangopay doesn’t accept the creation of bank accounts registered in some countries (see the Country restrictions article).

​
Attributes

​
OwnerAddress
object
Information about the address of residence of the bank account owner.
​
OwnerName
string
Max. length: 255 charactersThe full name of the owner of the bank account. (Format: FirstName LastName)
​
Tag
string
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).
​
IBAN
string
Max. length: 34 charactersThe IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which:
  • CC represents the country code (ISO 3166-1 alpha 2)
  • DD represents two check digits used by banking systems to avoid simple errors
  • BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.
    Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.
​
AccountNumber
string
Format: Digits onlyThe account number of the bank account. The format and length depends on the Bank Account Type.
​
BIC
string
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 optional characters defining the branch as a branch of the bank
    Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.
​
ABA
string
Length: 9 charactersThe American Banking Association (ABA) routing number for US-type bank accounts.
​
DepositAccountType
string
Returned values: CHECKING, SAVINGSThe deposit type for US-type bank accounts.
​
InstitutionNumber
string
Length: 3 digitsThe 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
​
BranchCode
string
Length: 5 digitsThe 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
​
BankName
string
Max. length: 50 characters (letters and digits only)The name of the Canadian bank for CA-type bank accounts.
​
SortCode
string
The 6-digit sort code, assigned to UK financial institutions, for GB-type bank accounts.
​
Country
string
The country in which the bank account is registered.
​
UserId
string
The unique identifier of the User (natural or legal) who owns the bank account.
​
Type
string
Returned values: IBAN, US, CA, GB, OTHERThe 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
The unique identifier of the object.
​
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.