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
View a Bank Account
Path parameters
The unique identifier of the bank account.
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: Up to 34 characters
The 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.
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.
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.
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.
Was this page helpful?