/
Close a gateway account

Close a gateway account

Request

Closes a gateway account with a specified ID. This process is also known as archiving.

When a gateway account is closed, the gateway cannot process transactions and the status attribute is set to closed.

Important: Closing a gateway account cannot be undone. Do so with caution.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}/close' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Gateway account closed.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the payment gateway account.

Example:"gw_acc_0YVCXMF26DDNKAERE5NW727S34"
gatewayNamestring or null(GatewayName)required

Payment gateway name.

Enum:"A1Gateway""ACI""Adyen""Aera""Aircash""Airpay""Airwallex""AsiaPay""AmazonPay""AmexVPC"
Discriminator
acquirerNamestring or null(AcquirerName)

Acquirer name.

Default:"Other"
Enum:"Adyen""ACI""Aera""Alipay""AIB""Aircash""Airpay""AmazonPay""ApcoPay""AsiaPaymentGateway"
methodstring(PaymentMethod)required

Payment method.

Enum:"payment-card""ach""cash""check""paypal""AdvCash""Aera""Affirm""Afterpay""Aircash"
acceptedCurrenciesArray of stringsrequired

Accepted currencies. This is an array of ISO 4217 currency codes.

paymentCardSchemesArray of strings

Accepted payment card brands.

statusstringread-only

Status of the gateway account.

Enum:"active""inactive""pending""closed"
merchantCategoryCodestring^[0-9]{4}$

Merchant category code of the payment gateway account.

Default:"0000"
dccMarkupinteger or null, [ -10000 .. 10000 ]

Dynamic currency conversion markup in basis points. This value cannot be 0 if the dccForceCurrency field is empty.

dccForceCurrencystring or null

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

dccForceConfirmationboolean

Specifies whether a confirmation step is required when dccForceCurrency is set.

Default:false
dccForceRoundingboolean

Specifies that DCC quote amounts must be rounded half up to the nearest whole number.

Default:false
descriptorstring or null

Gateway account descriptor value.

cityFieldstring or null

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

excludedDccQuoteCurrenciesArray of strings

Excluded Dynamic Currency Conversion (DCC) quote currencies.

monthlyLimitnumber or null, (double), >= 0

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

approvalWindowTtlinteger, [ 300 .. 16777215 ]

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

Default:3600
reconciliationWindowEnabledboolean

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

Default:false
reconciliationWindowTtlinteger or null, [ 300 .. 16777215 ]

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

threeDSecureboolean

Specifies if a gateway account allows 3D Secure.

Default:false
dynamicDescriptorboolean

Specifies if a gateway allows dynamic descriptors.

Default:false
digitalWalletsobject(Digital Wallets)

Configure which digital wallets are enabled.

isDownbooleanread-only

Specifies if a gateway is in a downtime period.

additionalFiltersstring or null

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.

Example:"amount:1..100;bin:411111,444433"
timeoutinteger or null, [ 10 .. 120 ]

Gateway account request timeout, in seconds.

tokenstring or nullread-only

Gateway account token.

Example:"TwiX3f92k4AiBE27BzTbQ38hHjicBz_w"
stickyboolean

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

For more information, see Gateway routing.

Default:true
setupInstructionstring

Creates zero, one, or more child transactions such as authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.

Default:"do-nothing"
Enum ValueDescription
authorize

Creates an authorize transaction in the amount and currency of the request.

authorize-and-void

Creates an authorize transaction followed by a void, if the authorize is approved. If the request amount is $0, then a $1 authorize is created. Otherwise the request amount is used.

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.

readyToPayoutInstructionstring

Defines the mode of gateway payout behaviour for the Ready to payout operation.

Default:"none"
Enum ValueDescription
all

Payout any amount from this gateway.

covered-payout

Payout from this gateway if it previously processed a payment for the same, or a greater, amount.

approved-payment

Payout any amount from this gateway if it processed an earlier payment. The customer must have a previously approved transaction, in the same currency, on this gateway.

none

Do not allow any payouts with this gateway. This is the default value, merchants must opt into payouts.

transactionEmailAliasTemplatestring or null

Email address template used in place of a customer's real email address when sending transaction data to a processor. Use {{customerId}} as a placeholder for the customer's ID. When empty, the customer's real email address is used.

Example:"{{customerId}}@receipts.example.com"
customFieldsobject(ResourceCustomFields)

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

Default:{}
Example:
{
  "foo": "bar"
}
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

credentialsobjectrequired

A1Gateway credentials object.

organizationIdstring, <= 50 characters(OrganizationId)read-onlydeprecated

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

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
Response
{
  "id": "gw_acc_0YVCXMF26DDNKAERE5NW727S34",
  "gatewayName": "A1Gateway",
  "acquirerName": "Other",
  "method": "payment-card",
  "acceptedCurrencies": [
    "string"
  ],
  "paymentCardSchemes": [
    "Visa"
  ],
  "status": "active",
  "merchantCategoryCode": "0000",
  "dccMarkup": -10000,
  "dccForceCurrency": "string",
  "dccForceConfirmation": false,
  "dccForceRounding": false,
  "descriptor": "string",
  "cityField": "string",
  "excludedDccQuoteCurrencies": [
    "string"
  ],
  "monthlyLimit": 0,
  "approvalWindowTtl": 3600,
  "reconciliationWindowEnabled": false,
  "reconciliationWindowTtl": 300,
  "threeDSecure": false,
  "dynamicDescriptor": false,
  "digitalWallets": {
    "applePay": { … },
    "googlePay": { … }
  },
  "isDown": true,
  "additionalFilters": "amount:1..100;bin:411111,444433",
  "timeout": 10,
  "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w",
  "sticky": true,
  "setupInstruction": "authorize",
  "readyToPayoutInstruction": "all",
  "transactionEmailAliasTemplate": "{{customerId}}@receipts.example.com",
  "customFields": {
    "foo": "bar"
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "_links": [
    { … }
  ],
  "credentials": {
    "accountId": "string"
  }
}