logo

Create a gateway account

Creates a gateway account.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Gateway Account resource.

gatewayName
required
string or null (GatewayName)

Payment gateway name.

method
required
string (PaymentMethod)

Payment method.

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

Accepted currencies. An array of ISO 4217 currency codes.

required
object

A1Gateway credentials object.

accountId
required
string

ID of the A1Gateway account.

password
required
string <password>

A1Gateway password.

acquirerName
string or null
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
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 if a gateway account allows 3D Secure.

dynamicDescriptor
boolean
Default: false

Specifies if 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.

isEnabled
required
boolean
Default: false

Specifies if Apple Pay is enabled.

displayName
string

String of 64, or fewer, UTF-8 characters containing the canonical name for your store, which is suitable for display. Do not localize this name.

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

ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your Payment Service Provider (PSP) to determine the appropriate country code.

object

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

isEnabled
required
boolean
Default: false

Specifies if Google Pay™ is enabled.

merchantName
string

Merchant name in Google Pay™.

merchantOrigin
string

Merchant origin in Google Pay™. This uses the fully qualified domain name.

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

ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your Payment Service Provider (PSP) to determine the appropriate country code.

additionalFilters
string

Additional filters used to determine if 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.

sticky
boolean
Default: true

Specifies if 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.

object (A1Gateway3dsServers)

A1Gateway 3DS servers.

name
required
string

Merchant plug-in name.

Responses
201

Gateway account created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
gatewayName
required
string or null (GatewayName)

Payment gateway name.

method
required
string (PaymentMethod)

Payment method.

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

Accepted currencies. An array of ISO 4217 currency codes.

required
object

A1Gateway credentials object.

accountId
required
string

ID of the A1Gateway account.

id
string <= 50 characters

ID of the payment gateway account.

acquirerName
string or null
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 if a gateway account allows 3D Secure.

dynamicDescriptor
boolean
Default: false

Specifies if 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.

isEnabled
required
boolean
Default: false

Specifies if Apple Pay is enabled.

displayName
string

String of 64, or fewer, UTF-8 characters containing the canonical name for your store, which is suitable for display. Do not localize this name.

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

ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your Payment Service Provider (PSP) to determine the appropriate country code.

object

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

isEnabled
required
boolean
Default: false

Specifies if Google Pay™ is enabled.

merchantName
string

Merchant name in Google Pay™.

merchantOrigin
string

Merchant origin in Google Pay™. This uses the fully qualified domain name.

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

ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your Payment Service Provider (PSP) to determine the appropriate country code.

isDown
boolean

Specifies if a gateway is in a downtime period.

additionalFilters
string

Additional filters used to determine if 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 if 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 objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "onBoardingUrl" "dynamicIpnUrl" "staticIpnUrl"
object (A1Gateway3dsServers)

A1Gateway 3DS servers.

name
required
string

Merchant plug-in name.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data 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": {
    }
}
➔ Next to Retrieves a gateway account