Skip to main content
POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
bankaccounts
/
ca
{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "InstitutionNumber":"614",
    "BranchCode":"00152",
    "BankName":"The Bank",
    "OwnerName":"Joe Blogs",
    "Tag":"custom meta",
}  

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "InstitutionNumber":"614",
    "BranchCode":"00152",
    "BankName":"The Bank",
    "UserId":"142036728",
    "OwnerName":"Joe Blogs",
    "Type":"CA",
    "Id":"150295080",
    "Tag":null,
    "CreationDate":1661865058,
    "Active":true
}
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.

​
Path parameters

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

​
Body parameters

​
OwnerAddress
object
required
Information about the address of residence of the bank account owner.
​
AccountNumber
string
required
Format: Digits onlyThe unique number of the bank account (between 7 to 35 digits).
​
InstitutionNumber
string
required
Length: 3 digitsThe 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
​
BranchCode
string
required
Length: 5 digitsThe 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
​
BankName
string
required
Max. length: 50 characters (letters and digits only)The name of the Canadian bank for CA-type bank accounts.
​
OwnerName
string
required
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).

​
Responses

​
OwnerAddress
object
Information about the address of residence of the bank account owner.
​
AccountNumber
string
Format: Digits onlyThe unique number of the bank account (between 7 to 35 digits).
​
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.
​
UserId
string
The unique identifier of the User (natural or legal) who owns the bank account.
​
OwnerName
string
Max. length: 255 charactersThe full name of the owner of the bank account. (Format: FirstName LastName)
​
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
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
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).
​
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.
{
    "Message":"One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type":"param_error",
    "Id":"4ee7cdf4-602a-4d6f-8859-4e7548022abf#1661865189",
    "Date":1661865190.0,
    "errors":{
        "InstitutionNumber":"The InstitutionNumber field is required.",
        "BranchCode":"The BranchCode field is required.",
        "BankName":"The BankName field is required."
    }
}  

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "InstitutionNumber":"614",
    "BranchCode":"00152",
    "BankName":"The Bank",
    "UserId":"142036728",
    "OwnerName":"Joe Blogs",
    "Type":"CA",
    "Id":"150295080",
    "Tag":null,
    "CreationDate":1661865058,
    "Active":true
}  

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75001",
        "Country":"FR"
    },
    "AccountNumber":"11696419",
    "InstitutionNumber":"614",
    "BranchCode":"00152",
    "BankName":"The Bank",
    "OwnerName":"Joe Blogs",
    "Tag":"custom meta",
}