# Close a gateway account 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 attribute is set to . > Closing a gateway account cannot be undone. Do so with caution. Endpoint: POST /gateway-accounts/{id}/close Version: latest Security: SecretApiKey, JWT ## Path parameters: - `id` (string, required) ID of the resource. ## Response 201 fields (application/json): - `id` (string) ID of the payment gateway account. Example: "gw_acc_0YVCXMF26DDNKAERE5NW727S34" - `gatewayName` (string,null, required) Payment gateway name. Enum: "A1Gateway", "ACI", "Adyen", "Aircash", "Airpay", "Airwallex", "AmazonPay", "AmexVPC", "ApcoPay", "AsiaPaymentGateway", "AstroPayCard", "AuthorizeNet", "Awepay", "Bambora", "BankSEND", "BitPay", "BlueSnap", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "Cashflows", "CASHlib", "Cashterminal", "CashToCode", "CauriPayment", "Cayan", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptonator", "CyberSource", "DataCash", "Dengi", "Dimoco", "Directa24", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "ecoPayzTurkey", "EcorePay", "Elavon", "Euteller", "eMerchantPay", "EMS", "ePay", "EPG", "EPro", "Ezeebill", "eZeeWallet", "ezyEFT", "FasterPay", "Finrax", "Flexepin", "FinTecSystems", "FundSend", "Forte", "gate2way", "GET", "Gigadat", "GlobalOnePay", "GoCardless", "Gooney", "Gpaysafe", "Greenbox", "HiPay", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "iDebit", "Ilixium", "Ingenico", "INOVAPAY", "Inovio", "Intuit", "InstaDebit", "IpayOptions", "JetPay", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "LaCore", "Limepay", "Loonio", "loonie", "LPG", "MaxiCash", "MercadoPago", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MtaPay", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "NGenius", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Pagadito", "Pagsmile", "Panamerican", "ParamountCommerce", "ParamountEft", "ParamountInterac", "PandaGateway", "Pay4Fun", "PayCash", "Paycly", "PayClub", "PayCom", "PayEcards", "Payeezy", "Payflow", "Paynote", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "Paysafe", "Paysafecard", "Paysafecash", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Plugnpay", "PostFinance", "PPRO", "Prosa", "PSiGate", "Rapyd", "Realex", "Realtime", "Redsys", "Rotessa", "RPN", "Safecharge", "SaltarPay", "Sagepay", "SeamlessChex", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "StaticGateway", "STPMexico", "Stripe", "Tabby", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "TrustsPay", "Trustly", "TWINT", "Unlimit", "UPayCard", "USAePay", "VantivLitle", "vegaaH", "VCreditos", "VegaWallet", "Wallet88", "Walpay", "WesternUnion", "Wirecard", "WorldlineAtosFrankfurt", "Worldpay", "XPay", "Zimpler", "Zotapay" - `acquirerName` (string,null) Acquirer name. Enum: "Adyen", "ACI", "Alipay", "AIB", "Aircash", "Airpay", "AmazonPay", "ApcoPay", "AsiaPaymentGateway", "AstroPay Card", "Awepay", "Ipay Options", "B+S", "Bambora", "BitPay", "Bank of America", "Bank of Moscow", "Bank of Rebilly", "Bank One", "BankSEND", "BMO Harris Bank", "Borgun", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "CASHlib", "Cashterminal", "CashToCode", "Catalunya Caixa", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "ChinaUnionPay", "CIM", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptonator", "CyberSource", "Dimoco", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "EcorePay", "Elavon", "EMS", "ePay", "EPG", "Euteller", "Ezeebill", "eZeeWallet", "ezyEFT", "Fifth Third Bank", "Finrax", "First Data Buypass", "First Data Nashville", "First Data North", "First Data Omaha", "FinTecSystems", "Flexepin", "Forte", "FundSend", "gate2way", "Gigadat", "Global East", "Gooney", "Gpaysafe", "Heartland", "HiPay", "HSBC", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "Ilixium", "Ingenico", "INOVAPAY", "Intuit", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "Limepay", "Loonio", "loonie", "LPG", "Masapay", "MaxiCash", "MercadoPago", "Merrick", "Mission Valley Bank", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "NATWEST", "Neosurf", "Netbanking", "Neteller", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "Nuvei", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Other", "Panamerican", "Panda Bank", "Paramount", "ParamountCommerce", "ParamountEft", "ParamountInterac", "Pay4fun", "PayCash", "PayClub", "PayEcards", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "Paynetics", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Peoples Trust Company", "PostFinance", "PPRO", "Privatbank", "Prosa", "PSiGate", "QQPay", "Rapyd", "RBC", "RBS WorldPay", "RealTime", "Rotessa", "Safecharge", "SaltarPay", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "State Bank of Mauritius", "STPMexico", "Stripe", "Tabby", "TBI", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "Trustly", "TrustPay", "TrustsPay", "TSYS", "TWINT", "UPayCard", "Vantiv", "VCreditos", "VegaWallet", "VoicePay", "Wallet88", "WeChat Pay", "Wells Fargo", "Wing Hang Bank", "Wirecard", "WorldPay", "XPay", "Zimpler", "Zotapay" - `method` (string, required) Payment method. Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip" - `acceptedCurrencies` (array, required) Accepted currencies. An array of ISO 4217 currency codes. - `paymentCardSchemes` (array) Accepted payment card brands. Enum: "Visa", "MasterCard", "American Express", "Discover", "Maestro", "Solo", "Electron", "JCB", "Voyager", "Diners Club", "Switch", "Laser", "China UnionPay", "AstroPay Card" - `status` (string) Status of the gateway account. Enum: "active", "inactive", "pending", "closed" - `merchantCategoryCode` (string) Merchant category code of the payment gateway account. - `dccMarkup` (integer,null) Dynamic currency conversion markup in basis points. This value cannot be if the field is empty. - `dccForceCurrency` (string,null) Forces Dynamic Currency Conversion (DCC) to the specified currency on each sale. To disable forced DCC, leave this field empty. - `dccForceRounding` (boolean) Specifies that DCC quote amounts must be rounded half up to the nearest whole number. - `descriptor` (string,null) Gateway account descriptor value. - `cityField` (string,null) Gateway account city field. This value is also known as a line 2 descriptor. - `excludedDccQuoteCurrencies` (array) Excluded Dynamic Currency Conversion (DCC) quote currencies. - `monthlyLimit` (number,null) Monthly limit on the amount money that the gateway account can process. - `approvalWindowTtl` (integer) Allotted time, in seconds, in which an offsite transaction must be approved before it is automatically . - `reconciliationWindowEnabled` (boolean) Specifies that if a transaction is not reconciled within the time, the transaction is marked as . - `reconciliationWindowTtl` (integer,null) Allotted time, in seconds, in which a reconciliation must occur before it is automatically . - `threeDSecure` (boolean) Specifies if a gateway account allows 3D Secure. - `dynamicDescriptor` (boolean) Specifies if a gateway allows dynamic descriptors. - `digitalWallets` (object) Configure which digital wallets are enabled. - `digitalWallets.applePay` (object) Apple Pay digital wallet configuration. If not using Apple Pay, do not use this field. - `digitalWallets.applePay.isEnabled` (boolean, required) Specifies if Apple Pay is enabled. - `digitalWallets.applePay.displayName` (string,null) 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. Example: "Test merchant" - `digitalWallets.applePay.country` (string) ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). Example: "US" - `digitalWallets.googlePay` (object) Google Pay™ digital wallet configuration. If not using Google Pay™, do not use this field. - `digitalWallets.googlePay.isEnabled` (boolean, required) Specifies if Google Pay™ is enabled. - `digitalWallets.googlePay.merchantName` (string,null) Merchant name in Google Pay™. Example: "Test merchant" - `digitalWallets.googlePay.merchantOrigin` (string,null) Merchant origin in Google Pay™. This uses the fully qualified domain name. Example: "www.example.com" - `isDown` (boolean) Specifies if a gateway is in a downtime period. - `additionalFilters` (string,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](https://www.rebilly.com/docs/dev-docs/search-filters). Example: "amount:1..100;bin:411111,444433" - `timeout` (integer,null) Gateway account request timeout, in seconds. - `token` (string,null) Gateway account token. Example: "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w" - `sticky` (boolean) Specifies if all future payments by the customer's payment instrument are processed by this gateway account. For more information, see [Gateway routing](https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts). - `setupInstruction` (string) Creates zero, one, or more child transactions such as and . The transactions are linked to the transaction by the relationship. Enum: "authorize", "authorize-and-void", "sca", "do-nothing" - `readyToPayoutInstruction` (string) Defines the mode of gateway payout behaviour for the [Ready to payout](https://www.rebilly.com/catalog/all/storefront-purchases/storefrontpostreadytopayout) operation. Enum: "all", "covered-payout", "approved-payment", "none" - `customFields` (object) 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](https://www.rebilly.com/catalog/all/custom-fields). Example: {"foo":"bar"} - `createdTime` (string) Date and time which is set automatically when the resource is created. - `updatedTime` (string) Date and time which updates automatically when the resource is updated. - `_links` (array) Related links. - `_links.href` (string) Link URL. - `_links.rel` (string) Type of link. Enum: "self", "onBoardingUrl", "dynamicIpnUrl", "staticIpnUrl" - `organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: "org_0YVDM8RC7GDADADSBSMW124JA8" ## Response 401 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 403 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 404 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 429 fields (application/json): - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". Example: "about:blank" - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. Example: "Rate Limit Exceeded" - `status` (integer) HTTP status code. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. Example: "A request cannot be executed because the user has sent too many requests within a certain period of time" - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.