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.

Request
Security:
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.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of Gateway Accounts was retrieved successfully.

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.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" "Ipay Options" … 155 more
method
required
string (PaymentMethod)

The payment method.

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

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

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.

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. Leave blank if using FramePay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name. Leave blank if using FramePay.

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.

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

Responses
201

Gateway Account was created.

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.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Gateway Account was retrieved successfully.

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.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" "Ipay Options" … 155 more
method
required
string (PaymentMethod)

The payment method.

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

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

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.

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. Leave blank if using FramePay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name. Leave blank if using FramePay.

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.

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

Responses
200

Gateway Account was updated.

201

Gateway Account was created.

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.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string (GatewayName)

The payment gateway name.

acquirerName
string
Default: "Other"

The acquirer name.

Enum: "Adyen" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" "Ipay Options" … 155 more
method
required
string (PaymentMethod)

The payment method.

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

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

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.

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. Leave blank if using FramePay.

merchantOrigin
string

The merchant origin in Google Pay. The fully qualified domain name. Leave blank if using FramePay.

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.

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

object (A1Gateway3dsServers)

A1Gateway 3DS Servers.

name
required
string

The Merchant plug-in Name.

Responses
200

Gateway Account was updated.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/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": {
    }
}

Delete a Gateway Account

Delete a Gateway Account with predefined identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Gateway Account was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

delete/gateway-accounts/{id}
Request samples
try {
    $client->gatewayAccounts()->delete('gatewayAccountId');
} catch (ServerException $e) {
    echo $e->getMessage();
}
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Close a Gateway Account

Close a gateway account with specified identifier string. Also known as archiving. Closing a Gateway Account cannot be undone, so use with caution. It will no longer be able to process transactions. The "status" attribute will be set to "closed".

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
201

Closed successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/gateway-accounts/{id}/close
Request samples
const gatewayAccount = await api.gatewayAccounts.close({id: 'foobar-001'});
console.log(gatewayAccount.fields.status);
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": {
    }
}

Disable a Gateway Account

Disable a gateway account with specified identifier string. Disabled gateway accounts have their "status" attribute set to "inactive" and cannot process transactions.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
201

Disabled successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Gateway account is pending activation and cannot be disabled.

post/gateway-accounts/{id}/disable
Request samples
const gatewayAccount = await api.gatewayAccounts.disable({id: 'foobar-001'});
console.log(gatewayAccount.fields.status);
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 list of gateway account downtime schedules

Retrieve a list of gateway account downtime schedules.

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

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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.

sort
Array of strings

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

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of Gateway Account downtime schedules was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/gateway-accounts/{id}/downtime-schedules
Request samples
// all parameters are optional except for the `id`
const firstCollection = await api.gatewayAccounts.getAllDowntimeSchedules({id: 'my-gateway'});

// alternatively you can specify one or more of them
const params = {id: 'my-gateway', limit: 20, offset: 100};
const secondCollection = await api.gatewayAccounts.getAllDowntimeSchedules(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(gatewayAccount => console.log(gatewayAccount.fields.reason));
Response samples
application/json
[
  • {
    }
]

Create a Gateway Account downtime schedule.

Create a Gateway Account downtime schedule.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Gateway Account downtime schedule resource.

startTime
required
string <date-time>

The gateway account scheduled downtime start time.

endTime
required
string <date-time>

The gateway account scheduled downtime end time.

Responses
201

Gateway Account downtime schedule was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

Conflict.

422

Invalid data was sent.

post/gateway-accounts/{id}/downtime-schedules
Request samples
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "pending",
  • "reason": "scheduled-maintenance",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a Gateway Downtime schedule

Retrieve a Gateway Downtime schedule with specified identifier string.

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

The resource identifier string.

downtimeId
required
string

The Gateway Account downtime schedule ID.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

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

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Gateway Downtime schedule was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/gateway-accounts/{id}/downtime-schedules/{downtimeId}
Request samples
const downtimeSchedule = await api.gatewayAccounts.getDowntimeSchedule({id: 'foobar-001', downtimeScheduleId: 'foobar-202'});
console.log(downtimeSchedule.fields.reason);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "pending",
  • "reason": "scheduled-maintenance",
  • "startTime": "2019-08-24T14:15:22Z",
    </