List Bank Accounts for a User

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.

NoteThe returned parameters may vary depending on the encountered bank account types.

Query parameters

page

integer

Start value: 1Default value: 1Indicates the index of the page for the pagination.

per_page

integer

Min. value: 1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.

Sort

string

Allowed values: CreationDate:ASC, CreationDate:DESCIndicates the direction in which to sort the list.

Active

boolean

required

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.

Path parameters

UserId

string

required

The unique identifier of the User (natural or legal) who owns the bank account.

Responses

200

Array (Bank Accounts)

array

The list of Bank Accounts objects created by the platform. Returned parameters can vary depending on the bank account Type.

Show properties

Object (Bank Accounts)

object

The Bank Account object created by the platform.

Show properties

OwnerAddress

object

Information about the address of residence of the bank account owner.

Show properties

AddressLine1

string

Max. length: 255 charactersThe first line of the address.

AddressLine2

string

Max. length: 255 charactersThe second line of the address.

City

string

Max. length: 255 charactersThe city of the address.

Region

string

Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode

string

Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.

OwnerName

string

Max. length: 255 charactersThe owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 (read more).If the User owning the attached wallet has UserCategory of OWNER and the KYCLevel of REGULAR, then the OwnerName is set to the FirstName and LastName values for a Natural User or the Name value for a Legal User. In this case, the VirtualAccountPurpose in the API response is USER_OWNED.If the User is not KYC verified and an OWNER, then the OwnerName is set to “MGP PlatformTradingName” in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the VirtualAccountPurpose in the API response is COLLECTION.Caution: Your platform must ensure that you use the OwnerName returned in the API response.

Tag

string

Max. length: 255 charactersCustom data that you can add to this object.

IBAN

string

The IBAN (international bank account number) for the bank account.

AccountNumber

string

Format: Digits onlyThe unique set of digits of the bank account.

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 characters used to define the branch of the bank (sometimes replaced with XXX)

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

Format: Two-letter country code (ISO 3166-1 alpha-2 format)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)

string

Max length: 128 characters (see data formats for details)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.

[
    {
        "OwnerAddress":{
            "AddressLine1":"The Oasis",
            "AddressLine2":"Rue des plantes",
            "City":"Paris",
            "Region":"Ile de Frog",
            "PostalCode":"75010",
            "Country":"FR"
        },
        "IBAN":"FR7630004000031234567890143",
        "BIC":"CRLYFRPP",
        "UserId":"142036728",
        "OwnerName":"John Doe",
        "Type":"IBAN",
        "Id":"142036878",
        "Tag":"Postman create a bank account",
        "CreationDate":1654073079,
        "Active":true
    },
    {
        "OwnerAddress":{
            "AddressLine1":"77 Street",
            "AddressLine2":"Rue des plantes",
            "City":"Paris",
            "Region":"Ile de France",
            "PostalCode":"75009",
            "Country":"FR"
        },
        "AccountNumber":"11696419",
        "ABA":"071000288",
        "DepositAccountType":"CHECKING",
        "UserId":"142036728",
        "OwnerName":"John Doe",
        "Type":"US",
        "Id":"150294885",
        "Tag":null,
        "CreationDate":1661864955,
        "Active":true
    }
]  

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $userId = '146476890';

    $response = $api->Users->GetBankAccounts($userId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r$e);
}
}  

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

List Bank Accounts for a User

Query parameters

Path parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

​Query parameters

​Path parameters

​Responses

Query parameters

Path parameters

Responses