Create a CA Bank Account
Caution – Replaced by Recipients feature
The 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
The unique identifier of the User (natural or legal) who owns the bank account.
Body parameters
Information about the address of residence of the bank account owner.
Format: Digits only
The unique number of the bank account (between 7 to 35 digits).
Length: 3 digits
The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
Length: 5 digits
The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
Max. length: 50 characters (letters and digits only)
The name of the Canadian bank for CA-type bank accounts.
Max. length: 255 characters
The full name of the owner of the bank account. (Format: FirstName LastName)
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).
Responses
200
200
Information about the address of residence of the bank account owner.
Format: Digits only
The unique number of the bank account (between 7 to 35 digits).
Length: 3 digits
The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
Length: 5 digits
The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
Max. length: 50 characters (letters and digits only)
The name of the Canadian bank for CA-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)
Max length: 128 characters (see data formats for details)
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.
400 - Missing parameters
400 - Missing parameters
Create a CA Bank Account
Caution – Replaced by Recipients feature
The 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
The unique identifier of the User (natural or legal) who owns the bank account.
Body parameters
Information about the address of residence of the bank account owner.
Format: Digits only
The unique number of the bank account (between 7 to 35 digits).
Length: 3 digits
The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
Length: 5 digits
The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
Max. length: 50 characters (letters and digits only)
The name of the Canadian bank for CA-type bank accounts.
Max. length: 255 characters
The full name of the owner of the bank account. (Format: FirstName LastName)
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).
Responses
200
200
Information about the address of residence of the bank account owner.
Format: Digits only
The unique number of the bank account (between 7 to 35 digits).
Length: 3 digits
The 3-digit number assigned to Canadian financial institutions, for CA-type bank accounts.
Length: 5 digits
The 5-digit number assigned to branches of Canadian financial institutions, for CA-type bank accounts.
Max. length: 50 characters (letters and digits only)
The name of the Canadian bank for CA-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)
Max length: 128 characters (see data formats for details)
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.
400 - Missing parameters
400 - Missing parameters