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.
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). |
BankAccount resource.
customerId required | string <= 50 characters The Customer's ID. |
token required | string BankAccountToken ID. |
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
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. |
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 |
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 |
{- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "token": "string",
- "customFields": {
- "foo": "bar"
}
}
{- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
], - "original": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ]
}
}
}
]
}
}
]
}
Retrieve a list of Bank Accounts.
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 |
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). |
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. |
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 |
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 |
$bankAccounts = $client->bankAccounts()->search([ 'filter' => 'customerId:testId', ]);
[- {
- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "emails": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ],
- "original": null
}
}
]
}
}
]
}
]
Retrieve a Bank Account with specified identifier string.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
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). |
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. |
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 |
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 |
$bankAccount = $client->bankAccounts()->load('bankAccountId');
{- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
], - "original": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ]
}
}
}
]
}
}
]
}
Update bank account's values except for the account number and routing. number.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
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). |
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 |
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. |
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 |
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 |
{- "bankName": "string",
- "accountType": "checking",
- "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
]
}, - "customFields": {
- "foo": "bar"
}
}
{- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
], - "original": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ]
}
}
}
]
}
}
]
}
Create or update a BankAccount with predefined identifier string.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
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). |
BankAccount resource.
customerId required | string <= 50 characters The Customer's ID. |
token required | string BankAccountToken ID. |
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
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. |
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 |
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 |
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. |
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 |
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 |
{- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "token": "string",
- "customFields": {
- "foo": "bar"
}
}
{- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
], - "original": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ]
}
}
}
]
}
}
]
}
Deactivate a Bank Account.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
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). |
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. |
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 |
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 |
$bankAccount = $client->bankAccounts()->deactivate('bankAccountId');
{- "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": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "fingerprint": "string",
- "last4": "string",
- "status": "active",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- null
], - "original": {
- "medium": null,
- "source": null,
- "campaign": null,
- "term": null,
- "content": null,
- "affiliate": null,
- "subAffiliate": null,
- "salesAgent": null,
- "clickId": null,
- "path": null,
- "referrer": null,
- "createdTime": null,
- "_links": [ ]
}
}
}
]
}
}
]
}