Bank Accounts

Bank Accounts are a type of payment instrument used to collect ACH (echeck) payments, similar to how a payment card would be used to for a credit card payment.

Create a Bank Account

Create a Bank Account.

Authorizations:
SecretApiKeyJWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

BankAccount resource.

One of
customerId
required
string <= 50 characters

The Customer's ID.

token
required
string

BankAccountToken ID.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples

Content type
application/json
Example
BankAccountCreateToken
BankAccountCreateToken
BankAccountCreatePlain
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "ach",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "bankName": "string",
  • "routingNumber": "string",
  • "accountNumberType": "BBAN",
  • "accountType": "checking",
  • "bic": "string",
  • "billingAddress": {
    },
  • "fingerprint": "string",
  • "last4": "string",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Retrieve a list of bank accounts

Retrieve a list of Bank Accounts.

Authorizations:
SecretApiKeyJWT
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

q
string

The partial search of the text fields.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples 

$bankAccounts = $client->bankAccounts()->search([
    'filter' => 'customerId:testId',
]);

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a Bank Account

Retrieve a Bank Account with specified identifier string.

Authorizations:
SecretApiKeyJWT
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples 

$bankAccount = $client->bankAccounts()->load('bankAccountId');

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "ach",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "bankName": "string",
  • "routingNumber": "string",
  • "accountNumberType": "BBAN",
  • "accountType": "checking",
  • "bic": "string",
  • "billingAddress": {
    },
  • "fingerprint": "string",
  • "last4": "string",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Update a bank account's values

Update bank account's values except for the account number and routing. number.

Authorizations:
SecretApiKeyJWT
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Bank Account.

bankName
string

Bank's name.

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

object

The billing address.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples

Content type
application/json
{
  • "bankName": "string",
  • "accountType": "checking",
  • "billingAddress": {
    },
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "ach",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "bankName": "string",
  • "routingNumber": "string",
  • "accountNumberType": "BBAN",
  • "accountType": "checking",
  • "bic": "string",
  • "billingAddress": {
    },
  • "fingerprint": "string",
  • "last4": "string",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Create a Bank Account with predefined ID

Create or update a BankAccount with predefined identifier string.

Authorizations:
SecretApiKeyJWT
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

BankAccount resource.

One of
customerId
required
string <= 50 characters

The Customer's ID.

token
required
string

BankAccountToken ID.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples

Content type
application/json
Example
BankAccountCreateToken
BankAccountCreateToken
BankAccountCreatePlain
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "ach",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "bankName": "string",
  • "routingNumber": "string",
  • "accountNumberType": "BBAN",
  • "accountType": "checking",
  • "bic": "string",
  • "billingAddress": {
    },
  • "fingerprint": "string",
  • "last4": "string",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Deactivate a Bank Account

Deactivate a Bank Account.

Authorizations:
SecretApiKeyJWT
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "ach"

The method of payment instrument.

customerId
string <= 50 characters

The customer's ID.

bankName
string

Bank's name.

routingNumber
string

Bank's routing number.

accountNumberType
string
Default: "BBAN"
Enum: "BBAN" "IBAN"

Bank's account number type. A valid value is basic bank account number (BBAN) or international bank account number (IBAN).

accountType
string
Enum: "checking" "savings" "other"

Bank's account type.

bic
string

Bank Identifier Code.

object

The billing address.

fingerprint
string

A unique value to identify the bank account. It contains alphanumeric values.

last4
string

The last 4 digits of the bank account.

status
string
Enum: "active" "deactivated"

Bank account status.

createdTime
string <date-time>

Bank account created time.

updatedTime
string <date-time>

Bank account updated time.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of SelfLink (object) or CustomerLink (object) non-empty

The links related to resource.

Array of CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Request samples 

$bankAccount = $client->bankAccounts()->deactivate('bankAccountId');

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "ach",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "bankName": "string",
  • "routingNumber": "string",
  • "accountNumberType": "BBAN",
  • "accountType": "checking",
  • "bic": "string",
  • "billingAddress": {
    },
  • "fingerprint": "string",
  • "last4": "string",
  • "status": "active",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": [
    ]
}
Next to PayPal Accounts