Deactivate a 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

UserId · string · required

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

BankAccountId · string · required

The unique identifier of the bank account.

Body parameters

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.

Responses

200 - IBAN-type Bank Account example

OwnerAddress · object

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

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The 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.

IBAN · string

Max. length: 34 characters

The IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which:

• CC represents the country code (ISO 3166-1 alpha 2)
• DD represents two check digits used by banking systems to avoid simple errors
• BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.
  Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.

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)

UserId · string

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

OwnerName · string

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Type · string

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 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 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).

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.

200 - IBAN-type Bank Account example

{
    "OwnerAddress":{
        "AddressLine1":"The Oasis",
        "AddressLine2":"Rue des plantes",
        "City":"Paris",
        "Region":"Ile de France",
        "PostalCode":"75010",
        "Country":"FR"
    },
    "IBAN":"FR7630004000031234567890143",
    "BIC":"CRLYFRPP",
    "UserId":"142036728",
    "OwnerName":"John Doe",
    "Type":"IBAN",
    "Id":"142036878",
    "Tag":"Custom meta",
    "CreationDate":1654073079,
    "Active":false
}  

REST

{
    "Active":false
}