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:

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.

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

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.

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true
}

View a Bank Account

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/BankAccountId

The bank account ID of a user

  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../users/:UserId/bankaccounts/:BankAccountId HTTP/1.1
require_once("mangopay.php");

try {

$UserId = 8494514;
$BankAccountId = 8571203;

$BankAccount = $Api->Users->GetBankAccount($UserId, $BankAccountId);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
GET .../users//bankaccounts/ HTTP/1.1

List Bank Accounts for a User

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/

Get parameters

Page
int

int

optional

The page number of results you wish to return

Per_Page
int

int

optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :

optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../users/:UserId/bankaccounts/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../users//bankaccounts/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}

The IBAN BankAccount object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

bool:

true, false

Whether the bank account is active or not

IBAN
string

string:

Maximum length is 255 characters

The IBAN of the bank account

BIC
string

string:

Maximum length is 255 characters

The BIC of the bank account

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true,
"IBAN": "FR3020041010124530725S03383",
"BIC": "CRLYFRPP"
}

Create an IBAN BankAccount

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/iban/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

OwnerAddress
Address

Address:

View Sub-parameters

required

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

OwnerAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

OwnerAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

required

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

required

The name of the owner of the bank account

IBAN
string

string:

Maximum length is 255 characters

required

The IBAN of the bank account

BIC
string

string:

Maximum length is 255 characters

optional

The BIC of the bank account

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/bankaccounts/iban/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"IBAN": "FR3020041010124530725S03383",
"BIC": "CRLYFRPP"
}
POST .../users//bankaccounts/iban/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"OwnerAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"OwnerName": "",
"IBAN": "",
"BIC": ""
}

The US BankAccount object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

bool:

true, false

Whether the bank account is active or not

AccountNumber
string

string:

Maximum length is 255 characters

The account number of the bank account. US account numbers must be digits only.

ABA
string

string:

Maximum length is 255 characters

The ABA of the bank account. Must be numbers only, and 9 digits long

DepositAccountType
DepositAccountType

DepositAccountType:

CHECKING, SAVINGS

The type of account

The type of account

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true,
"AccountNumber": "11696419",
"ABA": "071000288",
"DepositAccountType": "CHECKING"
}

Create a US Bank Account

In the case of USD PayOut, the author (AuthorId) of the PayOut should have their address (Address for Natural Users or HeaquartersAddress for Legal Users) completed in their User object.

In the case of USD PayOut, you must be using the API v2.01 (and therefore providing a detailed address), otherwise your PayOuts will be refused

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/us/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

OwnerAddress
Address

Address:

View Sub-parameters

required

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

OwnerAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

OwnerAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

required

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

required

The name of the owner of the bank account

AccountNumber
string

string:

Maximum length is 255 characters

required

The account number of the bank account. US account numbers must be digits only.

ABA
string

string:

Maximum length is 255 characters

required

The ABA of the bank account. Must be numbers only, and 9 digits long

DepositAccountType
DepositAccountType

DepositAccountType:

CHECKING, SAVINGS

The type of account

optional

The type of account

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/bankaccounts/us/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"AccountNumber": "11696419",
"ABA": "071000288",
"DepositAccountType": "CHECKING"
}
POST .../users//bankaccounts/us/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"OwnerAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"OwnerName": "",
"AccountNumber": "",
"ABA": "",
"DepositAccountType": ""
}

The CA BankAccount object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

bool:

true, false

Whether the bank account is active or not

InstitutionNumber
string

string:

Maximum length is 255 characters

The institution number of the bank account. Must be numbers only, and 3 or 4 digits long

AccountNumber
string

string:

Maximum length is 255 characters

The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.

BranchCode
string

string:

Maximum length is 255 characters

The branch code of the bank where the bank account. Must be numbers only, and 5 digits long

BankName
string

string:

Maximum length is 255 characters

The name of the bank where the account is held. Must be letters or numbers only and maximum 50 characters long.

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true,
"InstitutionNumber": "614",
"AccountNumber": "11696419",
"BranchCode": "00152",
"BankName": "The Big Bank"
}

Create a CA BankAccount

In the case of CAD PayOut, the author (AuthorId) of the PayOut should have their address (Address for Natural Users or HeaquartersAddress for Legal Users) completed in their User object.

In the case of CAD PayOut, you must be using the API v2.01 (and therefore providing a detailed address), otherwise your PayOuts will be refused

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/ca/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

OwnerAddress
Address

Address:

View Sub-parameters

required

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

OwnerAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

OwnerAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

required

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

required

The name of the owner of the bank account

BranchCode
string

string:

Maximum length is 255 characters

required

The branch code of the bank where the bank account. Must be numbers only, and 5 digits long

InstitutionNumber
string

string:

Maximum length is 255 characters

required

The institution number of the bank account. Must be numbers only, and 3 or 4 digits long

AccountNumber
string

string:

Maximum length is 255 characters

required

The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.

BankName
string

string:

Maximum length is 255 characters

required

The name of the bank where the account is held. Must be letters or numbers only and maximum 50 characters long.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/bankaccounts/ca/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"BranchCode": "00152",
"InstitutionNumber": "614",
"AccountNumber": "11696419",
"BankName": "The Big Bank"
}
POST .../users//bankaccounts/ca/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"OwnerAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"OwnerName": "",
"BranchCode": "",
"InstitutionNumber": "",
"AccountNumber": "",
"BankName": ""
}

The GB BankAccount object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

bool:

true, false

Whether the bank account is active or not

SortCode
string

string:

Maximum length is 255 characters

The sort code of the bank account. Must be numbers only, and 6 digits long

AccountNumber
string

string:

Maximum length is 255 characters

The account number of the bank account. Must be numbers only. GB account numbers must be 8 digits long.

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true,
"SortCode": "010039",
"AccountNumber": "11696419"
}

Create a GB BankAccount

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/gb/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

OwnerAddress
Address

Address:

View Sub-parameters

required

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

OwnerAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

OwnerAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

required

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

required

The name of the owner of the bank account

SortCode
string

string:

Maximum length is 255 characters

required

The sort code of the bank account. Must be numbers only, and 6 digits long

AccountNumber
string

string:

Maximum length is 255 characters

required

The account number of the bank account. Must be numbers only. GB account numbers must be 8 digits long.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/bankaccounts/gb/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"SortCode": "00152",
"AccountNumber": "11696419"
}
POST .../users//bankaccounts/gb/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"OwnerAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"OwnerName": "",
"SortCode": "",
"AccountNumber": ""
}

The OTHER BankAccount object

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Type
BankAccountType

BankAccountType:

IBAN, GB, US, CA, OTHER

The type of BankAccount

The type of bank account

OwnerAddress
Address

Address:

View Sub-parameters

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

The city of the address

OwnerAddress.Region
string

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

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

string:

Maximum length is 255 characters

The name of the owner of the bank account

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Active
bool

bool:

true, false

Whether the bank account is active or not

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Type": "IBAN",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"UserId": "8494514",
"Active": true
}

Create an OTHER Bank Account

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/other

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

OwnerAddress
Address

Address:

View Sub-parameters

required

The address of the owner of the bank account

OwnerAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

OwnerAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

OwnerAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

OwnerAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

OwnerAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

OwnerAddress.Country
CountryIso

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

required

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

required

The name of the owner of the bank account

Country
string

string:

Maximum length is 255 characters

required

The Country of the Address

BIC
string

string:

Maximum length is 255 characters

required

The BIC of the bank account

AccountNumber
string

string:

Maximum length is 255 characters

required

The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/bankaccounts/other HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"OwnerAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"OwnerName": "Joe Blogs",
"Country": "FR",
"BIC": "CRLYFRPP",
"AccountNumber": "11696419"
}
POST .../users//bankaccounts/other HTTP/1.1
Body Parameters :
{
"Tag": "",
"OwnerAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"OwnerName": "",
"Country": "",
"BIC": "",
"AccountNumber": ""
}

Deactivate a Bank Account

Note that once deactivated, a bank account can't be reactivated afterwards

PUT .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/bankaccounts/BankAccountId

The bank account ID of a user

/

Parameters

Active
bool

bool:

true, false

optional

Whether the bank account is active or not

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
PUT .../users/:UserId/bankaccounts/:BankAccountId/ HTTP/1.1
Body Parameters :
{
"Active": false
}
PUT .../users//bankaccounts// HTTP/1.1
Body Parameters :
{
"Active": ""
}