Retrieve a list of gateway accounts.
limit | integer [ 0 .. 1000 ] The collection items limit. |
offset | integer >= 0 The collection items offset. |
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. |
q | string The partial search of the text fields. |
fields | string Limit the returned fields to the list specified, separated by comma. Note that id is always returned. |
A list of Gateway Accounts was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||
required | object A1Gateway credentials object. | ||||||||||
| |||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||
status | string The gateway account's status. | ||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||
| |||||||||||
isDown | boolean True if gateway is currently in downtime period. | ||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||
token | string Gateway Account token. | ||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||
organizationId | string <= 50 characters Deprecated The resource ID. Defaults to UUID v4. | ||||||||||
Array of SelfLink (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty The links related to resource. | |||||||||||
Array (non-empty) Any of:
| |||||||||||
object (A1Gateway3dsServers) A1Gateway 3DS Servers. | |||||||||||
|
Unauthorized access, invalid credentials were used.
Access forbidden.
$gatewayAccounts = $client->$gatewayAccounts()->search([ 'filter' => 'currency:USD', ]);
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "status": "active",
- "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "isDown": true,
- "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w",
- "sticky": true,
- "setupInstruction": "authorize",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
]
Create a Gateway Account.
Gateway Account resource.
Gateway Account was created.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
status | string The gateway account's status. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
isDown | boolean True if gateway is currently in downtime period. | ||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
token | string Gateway Account token. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
organizationId | string <= 50 characters Deprecated The resource ID. Defaults to UUID v4. | ||||||||||||||
Array of SelfLink (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty The links related to resource. | |||||||||||||||
Array (non-empty) Any of:
| |||||||||||||||
object (A1Gateway3dsServers) A1Gateway 3DS Servers. | |||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "sticky": true,
- "setupInstruction": "authorize",
- "credentials": {
- "accountId": "string",
- "password": "pa$$word"
}, - "threeDSecureServer": {
- "name": "Other"
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "status": "active",
- "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "isDown": true,
- "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w",
- "sticky": true,
- "setupInstruction": "authorize",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "credentials": {
- "accountId": "string",
- "password": "pa$$word"
}, - "threeDSecureServer": {
- "name": "Other"
}
}
Retrieve a Gateway Account with specified identifier string.
Gateway Account was retrieved successfully.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
status | string The gateway account's status. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
isDown | boolean True if gateway is currently in downtime period. | ||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
token | string Gateway Account token. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
organizationId | string <= 50 characters Deprecated The resource ID. Defaults to UUID v4. | ||||||||||||||
Array of SelfLink (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty The links related to resource. | |||||||||||||||
Array (non-empty) Any of:
| |||||||||||||||
object (A1Gateway3dsServers) A1Gateway 3DS Servers. | |||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
$gatewayAccount = $client->gatewayAccounts()->load('gatewayAccountId');
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "status": "active",
- "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "isDown": true,
- "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w",
- "sticky": true,
- "setupInstruction": "authorize",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "credentials": {
- "accountId": "string",
- "password": "pa$$word"
}, - "threeDSecureServer": {
- "name": "Other"
}
}
Create or update a GatewayAccount with predefined identifier string.
Gateway Account resource.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
threeDSecureServer | object (A1Gateway3dsServers) Recursive A1Gateway 3DS Servers. |
Gateway Account was updated.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
status | string The gateway account's status. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
isDown | boolean True if gateway is currently in downtime period. | ||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
token | string Gateway Account token. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
organizationId | string <= 50 characters Deprecated The resource ID. Defaults to UUID v4. | ||||||||||||||
Array of SelfLink (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty The links related to resource. | |||||||||||||||
Array (non-empty) Any of:
| |||||||||||||||
object (A1Gateway3dsServers) A1Gateway 3DS Servers. | |||||||||||||||
Gateway Account was created.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
status | string The gateway account's status. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
isDown | boolean True if gateway is currently in downtime period. | ||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
token | string Gateway Account token. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||
organizationId | string <= 50 characters Deprecated The resource ID. Defaults to UUID v4. | ||||||||||||||
Array of SelfLink (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty The links related to resource. | |||||||||||||||
Array (non-empty) Any of:
| |||||||||||||||
threeDSecureServer | object (A1Gateway3dsServers) Recursive A1Gateway 3DS Servers. |
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "sticky": true,
- "setupInstruction": "authorize",
- "credentials": {
- "accountId": "string",
- "password": "pa$$word"
}, - "threeDSecureServer": {
- "name": "Other"
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayName": "A1Gateway",
- "acquirerName": "Other",
- "method": "payment-card",
- "acceptedCurrencies": [
- "string"
], - "paymentCardSchemes": [
- "Visa"
], - "status": "active",
- "merchantCategoryCode": "0000",
- "dccMarkup": -10000,
- "dccForceCurrency": "string",
- "descriptor": "string",
- "cityField": "string",
- "excludedDccQuoteCurrencies": [
- "string"
], - "monthlyLimit": 0,
- "approvalWindowTtl": 3600,
- "reconciliationWindowEnabled": false,
- "reconciliationWindowTtl": 300,
- "threeDSecure": false,
- "dynamicDescriptor": false,
- "digitalWallets": {
- "applePay": {
- "isEnabled": false,
- "displayName": "Test Merchant",
- "country": "US"
}, - "googlePay": {
- "isEnabled": false,
- "merchantName": "Test Merchant",
- "merchantOrigin": "www.example.com",
- "country": "US"
}
}, - "isDown": true,
- "additionalFilters": "amount:1..100;bin:411111,444433",
- "timeout": 10,
- "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w",
- "sticky": true,
- "setupInstruction": "authorize",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "credentials": {
- "accountId": "string",
- "password": "pa$$word"
}, - "threeDSecureServer": {
- "name": "Other"
}
}
Update a GatewayAccount with predefined identifier string.
Gateway Account resource.
gatewayName required | string (GatewayName) The payment gateway name. | ||||||||||||||
method required | string (PaymentMethod) The payment method. | ||||||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | ||||||||||||||
required | object A1Gateway credentials object. | ||||||||||||||
acquirerName | string Default: "Other" The acquirer name. | ||||||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | ||||||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | ||||||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | ||||||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | ||||||||||||||
descriptor | string The gateway account's descriptor. | ||||||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | ||||||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | ||||||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | ||||||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | ||||||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | ||||||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | ||||||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | ||||||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | ||||||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | |||||||||||||||
| |||||||||||||||
additionalFilters | string The additional filters are used to determine whether the gateway account can be selected for the transaction to be processed. For example, the filter may put a maximum amount value. If the transaction is above that amount, this gateway account wouldn't be used. This follows our standard filter format. | ||||||||||||||
timeout | integer or null [ 10 .. 120 ] Gateway Account request timeout in seconds. | ||||||||||||||
sticky | boolean Default: true Customer's payment instrument will "stick" to the gateway account for future transactions when enabled. | ||||||||||||||
setupInstruction | string Default: "do-nothing" Creates zero, one, or more child transactions such as
| ||||||||||||||
threeDSecureServer | object (A1Gateway3dsServers) Recursive A1Gateway 3DS Servers. |
Gateway Account was updated.
gatewayName required | string (GatewayName) The payment gateway name. | |||||||||||
method required | string (PaymentMethod) The payment method. | |||||||||||
acceptedCurrencies required | Array of strings Accepted currencies (array of the currency three letter codes). | |||||||||||
required | object A1Gateway credentials object. | |||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||
acquirerName | string Default: "Other" The acquirer name. | |||||||||||
paymentCardSchemes | Array of strings (PaymentCardBrand) Accepted payment card brands. | |||||||||||
status | string The gateway account's status. | |||||||||||
merchantCategoryCode | string^[0-9]{4}$ Default: "0000" The gateway account's merchant category code. | |||||||||||
dccMarkup | integer [ -10000 .. 10000 ] Dynamic currency conversion markup in basis points. | |||||||||||
dccForceCurrency | string Force dynamic currency conversion to the specified currency on each sale. Leave it empty to disable force DCC. | |||||||||||
descriptor | string The gateway account's descriptor. | |||||||||||
cityField | string The gateway account's city field (also known as line 2 descriptor). | |||||||||||
excludedDccQuoteCurrencies | Array of strings Excluded Dynamic Currency Conversion Quote Currencies. | |||||||||||
monthlyLimit | number <double> >= 0 Monthly Limit. | |||||||||||
approvalWindowTtl | integer [ 300 .. 16777215 ] Default: 3600 The time window (in seconds) allotted for approving an offsite transaction before it is automatically | |||||||||||
reconciliationWindowEnabled | boolean Default: false If a transaction is not reconciled within the | |||||||||||
reconciliationWindowTtl | integer [ 300 .. 16777215 ] The time window (in seconds) allotted for a reconciliation to occur. If it is not reconciled in that time, then the transaction is marked as | |||||||||||
threeDSecure | boolean Default: false True, if Gateway Account allows 3DSecure. | |||||||||||
dynamicDescriptor | boolean Default: false True, if Gateway Account allows dynamic descriptor. | |||||||||||
object (Digital Wallets) Configure which digital wallets are enabled. | ||||||||||||
|