The BankAccount object
Bank Accounts is an item targeted by a PayOut Bank wire request. This is required in order to process a PayOut Bank wire, as it contains all bank accounts. It may also be linked to a user (UserId). The API accepts the following formats:
- BIC & IBAN
- Local UK format
- Local US format
- Local CA format
- Other local formats (unspecified but different from the previous).
Please pay special attention on the fact that even in sandbox mode you will need to put a real life existing valid BIC/IBAN since the Mangopay and banks tests are made on the validity of this one.
Note that if you are doing a PayOut to someone different from the AuthorId, you should not register the BankAccount under the same UserId – you must create a second UserId – please discuss with our support team if you are unsure about this point, as it is important and will cause your PayOuts to be rejected by our compliance team.
Due to anti-money laundering policy, we don’t accept the creation of bank accounts domiciliated in some countries. Please refer to the Restrictions by country documentation for more information.
Parameters
Type
BankAccountType:
IBAN, GB, US, CA, OTHER
The type of BankAccount
The type of bank account
OwnerAddress
Address:
View Sub-parameters
The address of the owner of the bank account
OwnerAddress.AddressLine1
string:
Maximum length is 255 characters
The first line of the address
OwnerAddress.AddressLine2
string:
Maximum length is 255 characters
The second line of the address
OwnerAddress.City
string:
Maximum length is 255 characters
The city of the address
OwnerAddress.Region
string:
Maximum length is 255 characters
The region of the address - this is optional except if the Country
is US, CA or MX
OwnerAddress.PostalCode
string:
Maximum length is 50 characters
The postal code of the address - can be alphanumeric, dashes or spaces
OwnerAddress.Country
CountryIso:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
A valid ISO 3166-1 alpha-2 format
The Country of the Address
OwnerName
string:
Maximum length is 255 characters
The name of the owner of the bank account
Tag
string:
Maximum length is 255 characters
Custom data that you can add to this item
UserId
string:
Maximum length is 255 characters
The object owner's UserId
CreationDate
timestamp
When the item was created
Active
bool:
true, false
Whether the bank account is active or not
These are the base parameters for a Bank Account - for each type (see below) there are various other parameters specific to that type.