Retrieve gateway accounts

Retrieves a list of gateway accounts.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

fields
string

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

Responses
200

List of gateway accounts retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

Payment gateway name.

method
required
string (PaymentMethod)

Payment method.

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

Accepted currencies. An array of ISO 4217 currency codes.

required
object

A1Gateway credentials object.

accountId
required
string

A1Gateway account ID.

password
required
string <password>

A1Gateway password.

id
string <= 50 characters

ID of the payment gateway account.

acquirerName
string
Default: "Other"

Acquirer name.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 169 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

Status of the gateway account.

Enum: "active" "inactive" "pending" "closed"
merchantCategoryCode
string^[0-9]{4}$
Default: "0000"

Merchant category code of the payment gateway account.

dccMarkup
integer [ -10000 .. 10000 ]

Dynamic currency conversion markup in basis points.

dccForceCurrency
string

Forces Dynamic Currency Conversion (DCC) to the specified currency on each sale. To disable forced DCC, leave this field empty.

descriptor
string

Gateway account descriptor value.

cityField
string

Gateway account city field. This value is also known as a line 2 descriptor.

excludedDccQuoteCurrencies
Array of strings

Excluded Dynamic Currency Conversion (DCC) quote currencies.

monthlyLimit
number <double> >= 0

Monthly limit on the amount money that the gateway account can process.

approvalWindowTtl
integer [ 300 .. 16777215 ]
Default: 3600

Allotted time, in seconds, in which an offsite transaction must be approved before it is automatically abandoned.

reconciliationWindowEnabled
boolean
Default: false

Specifies that if a transaction is not reconciled within the reconciliationWindowTtl time, the transaction is marked as abandoned.

reconciliationWindowTtl
integer [ 300 .. 16777215 ]

Allotted time, in seconds, in which a reconciliation must occur before it is automatically abandoned.

threeDSecure
boolean
Default: false

Specifies whether a gateway account allows 3D Secure.

dynamicDescriptor
boolean
Default: false

Specifies whether a gateway allows dynamic descriptors.

object (Digital Wallets)

Configure which digital wallets are enabled.

object

Apple Pay digital wallet configuration. If not using Apple Pay, do not use this field.

object

Google Pay™ digital wallet configuration. If not using Google Pay™, do not use this field.

isDown
boolean

Specifies whether a gateway is in a downtime period.

additionalFilters
string

Additional filters used to determine whether the gateway account can be selected to process a transaction.

For example, the filter may place a maximum amount value on transaction. If a transaction exceeds this value, the gateway account is not used.

For more information see, Using filters.

timeout
integer or null [ 10 .. 120 ]

Gateway account request timeout, in seconds.

token
string

Gateway account token.

sticky
boolean
Default: true

Specifies whether all future payments by the customer's payment instrument are processed by this gateway account.

For more information, see Gateway routing.

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 and currency of the request. This is used when a gateway account is configured for Strong Customer Authentication (SCA).

authorize-and-void

Creates an authorize transaction in the amount and currency of the request, followed by a void, if the authorize is approved. This is used when a gateway account is configured for Strong Customer Authentication (SCA).

sca

Uses Strong Customer Authentication (SCA) without an authorize transaction. SCA includes 3DS, and specific wallet behavior, such as setting up a billing agreement with PayPal.

do-nothing

Does nothing except return an approved setup transaction. This is the default behavior.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

organizationId
string <= 50 characters
Deprecated

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of Self (object) or OnBoardingUrlLink (object) or DynamicIpnLink (object) or StaticIpnLink (object) non-empty

Related links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
object (A1Gateway3dsServers)

A1Gateway 3DS servers.

name
required
string

Merchant plug-in name.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

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