Gateway Accounts

Gateway accounts connect payment request to third party networks and platforms.

Retrieve a list of gateway accounts

Retrieve a list of gateway accounts.

SecuritySecretApiKey or JWT
Request
query Parameters
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.

Responses
200

A list of Gateway Accounts was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

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:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/gateway-accounts
Request samples
$gatewayAccounts = $client->$gatewayAccounts()->search([
    'filter' => 'currency:USD',
]);
Response samples
application/json
[
  • {
    }
]

Create a Gateway Account

Create a Gateway Account.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

threeDSecureServer
object (A1Gateway3dsServers) Recursive

A1Gateway 3DS Servers.

Responses
201

Gateway Account was created.

Response Schema: application/json
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

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:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/gateway-accounts
Request samples
application/json
{
  • "gatewayName": "A1Gateway",
  • "acquirerName": "Other",
  • "method": "payment-card",
  • "acceptedCurrencies": [
    ],
  • "paymentCardSchemes": [
    ],
  • "merchantCategoryCode": "0000",
  • "dccMarkup": -10000,
  • "dccForceCurrency": "string",
  • "descriptor": "string",
  • "cityField": "string",
  • "excludedDccQuoteCurrencies": [
    ],
  • "monthlyLimit": 0,
  • "approvalWindowTtl": 3600,
  • "reconciliationWindowEnabled": false,
  • "reconciliationWindowTtl": 300,
  • "threeDSecure": false,
  • "dynamicDescriptor": false,
  • "digitalWallets": {
    },
  • "additionalFilters": "amount:1..100;bin:411111,444433",
  • "timeout": 10,
  • "sticky": true,
  • "setupInstruction": "authorize",
  • "credentials": {
    },
  • "threeDSecureServer": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayName": "A1Gateway",
  • "acquirerName": "Other",
  • "method": "payment-card",
  • "acceptedCurrencies": [
    ],
  • "paymentCardSchemes": [
    ],
  • "status": "active",
  • "merchantCategoryCode": "0000",
  • "dccMarkup": -10000,
  • "dccForceCurrency": "string",
  • "descriptor": "string",
  • "cityField": "string",
  • "excludedDccQuoteCurrencies": [
    ],
  • "monthlyLimit": 0,
  • "approvalWindowTtl": 3600,
  • "reconciliationWindowEnabled": false,
  • "reconciliationWindowTtl": 300,
  • "threeDSecure": false,
  • "dynamicDescriptor": false,
  • "digitalWallets": {
    },
  • "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": [
    ],
  • "credentials": {
    },
  • "threeDSecureServer": {
    }
}

Retrieve a Gateway Account

Retrieve a Gateway Account with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Gateway Account was retrieved successfully.

Response Schema: application/json
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

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:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/gateway-accounts/{id}
Request samples
$gatewayAccount = $client->gatewayAccounts()->load('gatewayAccountId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayName": "A1Gateway",
  • "acquirerName": "Other",
  • "method": "payment-card",
  • "acceptedCurrencies": [
    ],
  • "paymentCardSchemes": [
    ],
  • "status": "active",
  • "merchantCategoryCode": "0000",
  • "dccMarkup": -10000,
  • "dccForceCurrency": "string",
  • "descriptor": "string",
  • "cityField": "string",
  • "excludedDccQuoteCurrencies": [
    ],
  • "monthlyLimit": 0,
  • "approvalWindowTtl": 3600,
  • "reconciliationWindowEnabled": false,
  • "reconciliationWindowTtl": 300,
  • "threeDSecure": false,
  • "dynamicDescriptor": false,
  • "digitalWallets": {
    },
  • "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": [
    ],
  • "credentials": {
    },
  • "threeDSecureServer": {
    }
}

Create or update a Gateway Account with predefined ID

Create or update a GatewayAccount with predefined identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

threeDSecureServer
object (A1Gateway3dsServers) Recursive

A1Gateway 3DS Servers.

Responses
200

Gateway Account was updated.

Response Schema: application/json
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

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:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

201

Gateway Account was created.

Response Schema: application/json
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

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:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

threeDSecureServer
object (A1Gateway3dsServers) Recursive

A1Gateway 3DS Servers.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

put/gateway-accounts/{id}
Request samples
application/json
{
  • "gatewayName": "A1Gateway",
  • "acquirerName": "Other",
  • "method": "payment-card",
  • "acceptedCurrencies": [
    ],
  • "paymentCardSchemes": [
    ],
  • "merchantCategoryCode": "0000",
  • "dccMarkup": -10000,
  • "dccForceCurrency": "string",
  • "descriptor": "string",
  • "cityField": "string",
  • "excludedDccQuoteCurrencies": [
    ],
  • "monthlyLimit": 0,
  • "approvalWindowTtl": 3600,
  • "reconciliationWindowEnabled": false,
  • "reconciliationWindowTtl": 300,
  • "threeDSecure": false,
  • "dynamicDescriptor": false,
  • "digitalWallets": {
    },
  • "additionalFilters": "amount:1..100;bin:411111,444433",
  • "timeout": 10,
  • "sticky": true,
  • "setupInstruction": "authorize",
  • "credentials": {
    },
  • "threeDSecureServer": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "gatewayName": "A1Gateway",
  • "acquirerName": "Other",
  • "method": "payment-card",
  • "acceptedCurrencies": [
    ],
  • "paymentCardSchemes": [
    ],
  • "status": "active",
  • "merchantCategoryCode": "0000",
  • "dccMarkup": -10000,
  • "dccForceCurrency": "string",
  • "descriptor": "string",
  • "cityField": "string",
  • "excludedDccQuoteCurrencies": [
    ],
  • "monthlyLimit": 0,
  • "approvalWindowTtl": 3600,
  • "reconciliationWindowEnabled": false,
  • "reconciliationWindowTtl": 300,
  • "threeDSecure": false,
  • "dynamicDescriptor": false,
  • "digitalWallets": {
    },
  • "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": [
    ],
  • "credentials": {
    },
  • "threeDSecureServer": {
    }
}

Update a Gateway Account with predefined ID

Update a GatewayAccount with predefined identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

object

The Google Pay™ digital wallet configuration. Skip if not using Google Pay™.

isEnabled
required
boolean
Default: false

Set true if Google Pay is enabled.

merchantName
string

The merchant name in Google Pay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.

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 authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it will be used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it will be used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

threeDSecureServer
object (A1Gateway3dsServers) Recursive

A1Gateway 3DS Servers.

Responses
200

Gateway Account was updated.

Response Schema: application/json
gatewayName
required
string (GatewayName)

The payment gateway name.

method
required
string (PaymentMethod)

The payment method.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
acceptedCurrencies
required
Array of strings

Accepted currencies (array of the currency three letter codes).

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 163 more
paymentCardSchemes
Array of strings (PaymentCardBrand)

Accepted payment card brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
status
string

The gateway account's status.

Enum: "active" "inactive" "pending" "closed"
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 abandoned.

reconciliationWindowEnabled
boolean
Default: false

If a transaction is not reconciled within the reconciliationWindowTtl time, then the transaction is marked as abandoned.

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

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.

object

The Apple Pay digital wallet configuration. Skip if not using Apple Pay.

isEnabled
required
boolean
Default: false

Set true if Apple Pay is enabled.

displayName
string

A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.

country
string (DigitalWalletCountry) ^[A-Z]{2}$

The ISO 3166 alpha-2 country code.