POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
bankaccounts
/
us
{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "OwnerName": "John Doe",
    "Tag": "custom meta",
}
  

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "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
}

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.

​
Body parameters

​
OwnerAddress
object
required

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

​
AccountNumber
string
required

Format: Digits only

The unique set of digits of the bank account.

​
ABA
string
required

Length: 9 characters

The American Banking Association (ABA) routing number for US-type bank accounts.

​
DepositAccountType
string

Allowed values: CHECKING, SAVINGS

The deposit type for US-type bank accounts.

​
OwnerName
string
required

Max. length: 255 characters

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

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

​
Responses

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "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
}

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "OwnerName": "John Doe",
    "Tag": "custom meta",
}