PUT /gateway-accounts/{id}

Default value: "application/json"

Gateway account descriptor value.

Specifies if a gateway is in a downtime period.

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

Default value: 3600

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

Specifies if a gateway account allows 3D Secure.

Default value: false

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

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

Valid values:

• "covered-payout"
• "approved-payment"
• "none"
• "all"

Default value: "none"

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

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

For more information, see Gateway routing.

Default value: true

ID of the payment gateway account.

Related links.

Link URL.

Type of link.

Valid values:

• "dynamicIpnUrl"
• "staticIpnUrl"
• "onBoardingUrl"
• "self"

Payment method.

Valid values:

• "iDebit"
• "Boleto-3"
• "Litecoin"
• "Wallet88"
• "Giropay"
• "Neosurf"
• "PagoEffectivo"
• "MercadoPago"
• "PinPay"
• "Interac-express-connect"
• "PayULatam"
• "Piastrix"
• "Bancontact-mobile"
• "Affirm"
• "OXXO"
• "Yandex-money"
• "paypal"
• "ecoVoucher"
• "Pagsmile-lottery"
• "Paysafecard"
• "Alipay"
• "XPay-P2P"
• "Khelocard"
• "MiFinity-eWallet"
• "QQPay"
• "Megafon"
• "Ripple"
• "Nordea-Solo"
• "Airpay"
• "CODVoucher"
• "FasterPay"
• "eZeeWallet"
• "Afterpay"
• "Alfa-click"
• "cryptocurrency"
• "Flexepin"
• "PhonePe"
• "InstantPayments"
• "Paynote"
• "Zip"
• "Bizum"
• "Blik"
• "Webpay-2"
• "domestic-cards"
• "bank-transfer-2"
• "Directa24Card"
• "POLi"
• "Zimpler"
• "Bancontact"
• "loonie"
• "Onlineueberweisen"
• "Dimoco-pay-smart"
• "Klarna"
• "PayU"
• "Gpaysafe"
• "ToditoCash-card"
• "Payeer"
• "iDEAL"
• "Sofort"
• "BankReferenced"
• "ING-homepay"
• "XPay-QR"
• "Mollie"
• "bank-transfer-3"
• "swift-dbt"
• "VegaWallet"
• "iWallet"
• "Telr"
• "Terminaly-RF"
• "ecoPayzTurkey"
• "Skrill"
• "bank-transfer"
• "PaymentAsia-crypto"
• "INOVAPAY-wallet"
• "Trustly"
• "Viva"
• "UPayCard"
• "bank-transfer-4"
• "phone"
• "SparkPay"
• "reverse-withdrawal"
• "Matrix"
• "USD-coin"
• "PayCash"
• "AstroPay Card"
• "EPS"
• "bank-transfer-6"
• "Conekta-oxxo"
• "Interac"
• "bank-transfer-5"
• "Paymero"
• "SMSVoucher"
• "Paymero-QR"
• "PostFinance-e-finance"
• "bank-transfer-7"
• "China UnionPay"
• "Boleto"
• "AdvCash"
• "P24"
• "Payco"
• "Webmoney"
• "cash-deposit"
• "Resurs"
• "CyberSource"
• "ezyEFT"
• "bank-transfer-8"
• "QIWI"
• "Jeton"
• "jpay"
• "TWINT"
• "ePay.bg"
• "Google Pay"
• "VenusPoint"
• "SPEI"
• "LPG-payment-card"
• "PayTabs"
• "QPay"
• "bank-transfer-9"
• "BankSEND"
• "Clearpay"
• "MobilePay"
• "MTS"
• "Pagsmile-deposit-express"
• "AstroPay-GO"
• "Webpay Card"
• "Perfect-money"
• "SafetyPay"
• "voucher-2"
• "Cleo"
• "instant-bank-transfer"
• "CASHlib"
• "ecoPayz"
• "Webpay"
• "voucher"
• "MaxiCash"
• "Pay4Fun"
• "payment-card"
• "Aircash"
• "Skrill Rapid Transfer"
• "voucher-3"
• "Neteller"
• "SEPA"
• "NordikCoin"
• "Samsung Pay"
• "ach"
• "WeChat Pay"
• "miscellaneous"
• "online-bank-transfer"
• "Zotapay"
• "Siirto"
• "MuchBetterVoucher"
• "INOVAPAY-pin"
• "Ethereum"
• "voucher-4"
• "Efecty"
• "PIX"
• "VCreditos"
• "Netbanking"
• "Baloto"
• "Tupay"
• "Tether"
• "AmazonPay"
• "JetonCash"
• "Tele2"
• "Multibanco"
• "bitcoin"
• "OchaPay"
• "MyFatoorah"
• "CashToCode"
• "Apple Pay"
• "invoice"
• "Belfius-direct-net"
• "cash"
• "InstaDebit"
• "echeck"
• "Interac-online"
• "check"
• "iCashOne Voucher"
• "MuchBetter"
• "oriental-wallet"
• "PostFinance-card"
• "Beeline"
• "Boleto-2"
• "Cupon-de-pagos"
• "Aera"
• "Pagadito"
• "rebilly-hosted-payment-form"
• "rapyd-checkout"
• "LPG-online"
• "UPI"
• "Conekta-spei"
• "KNOT"
• "Interac-eTransfer"
• "KakaoPay"
• "e-wallet"
• "CCAvenue"
• "UniCrypt"

Configure which digital wallets are enabled.

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

Merchant name in Google Pay™.

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

Specifies if Google Pay™ is enabled.

Default value: false

ISO 3166 alpha-2 country code. For examples, see ISO.org.

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

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.

Specifies if Apple Pay is enabled.

Default value: false

ISO 3166 alpha-2 country code. For examples, see ISO.org.

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

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

Valid values:

• "authorize-and-void"
• "authorize"
• "sca"
• "do-nothing"

Default value: "do-nothing"

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

Default value: false

Default value: "Other"

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.

Status of the gateway account.

Valid values:

• "inactive"
• "active"
• "pending"
• "closed"

Merchant category code of the payment gateway account.

Default value: "0000"

Payment gateway name.

Valid values:

• "iDebit"
• "Pin4Pay"
• "Wallet88"
• "Panamerican"
• "Stripe"
• "EMS"
• "AuthorizeNet"
• "Walpay"
• "vegaaH"
• "Neosurf"
• "MercadoPago"
• "MuchBetterGateway"
• "PayULatam"
• "Piastrix"
• "NMI"
• "Dimoco"
• "Chillstock"
• "CoinGate"
• "ePay"
• "MtaPay"
• "VantivLitle"
• "Coppr"
• "CheckoutCom"
• "Paysafecard"
• "PPRO"
• "Limepay"
• "Rotessa"
• "DataCash"
• "EPG"
• "Gooney"
• "Khelocard"
• "Moneris"
• "ACI"
• "AsiaPaymentGateway"
• "Ezeebill"
• "EcorePay"
• "Airpay"
• "CODVoucher"
• "FasterPay"
• "Paybilt"
• "eZeeWallet"
• "Awepay"
• "Payeezy"
• "BitPay"
• "Orbital"
• "Flexepin"
• "LPG"
• "EasyPayDirect"
• "EBANX"
• "Paynote"
• "Monolo"
• "iCheque"
• "Powertranz"
• "Intuit"
• "Paysafecash"
• "OnRamp"
• "Zimpler"
• "PayRedeem"
• "Chase"
• "Inovio"
• "Plugnpay"
• "loonie"
• "SaltarPay"
• "HiPay"
• "Onlineueberweisen"
• "Safecharge"
• "PayEcards"
• "Klarna"
• "PayU"
• "Gpaysafe"
• "Sofort"
• "MiFinity"
• "Mollie"
• "VegaWallet"
• "PaymentAsia"
• "Telr"
• "Bambora"
• "Conekta"
• "Loonio"
• "ecoPayzTurkey"
• "Gigadat"
• "Pagsmile"
• "Skrill"
• "Trustly"
• "Naewe"
• "Viva"
• "UPayCard"
• "SparkPay"
• "A1Gateway"
• "WesternUnion"
• "Clearhaus"
• "PaymenTechnologies"
• "Antom"
• "GlobalOnePay"
• "PayCash"
• "SeamlessChex"
• "SmartInvoice"
• "TestProcessor"
• "Credorax"
• "LaCore"
• "Elavon"
• "GET"
• "Tabby"
• "Dropayment"
• "AstroPayCard"
• "Paymero"
• "PostFinance"
• "SMSVoucher"
• "Cayan"
• "dLocal"
• "iCashOne"
• "PSiGate"
• "Airwallex"
• "Payper"
• "ICEPAY"
• "NOWPayments"
• "ParamountEft"
• "ParamountInterac"
• "USAePay"
• "PayPal"
• "CyberSource"
• "ezyEFT"
• "Jeton"
• "Payr"
• "TWINT"
• "XPay"
• "Cashflows"
• "ApcoPay"
• "Circle"
• "Prosa"
• "Paycly"
• "Splitit"
• "Truevo"
• "PayTabs"
• "Worldpay"
• "JPMOrbital"
• "IpayOptions"
• "Konnektive"
• "PayRetailers"
• "PayCom"
• "Buckaroo"
• "BankSEND"
• "Ilixium"
• "Redsys"
• "SecureTrading"
• "OmniMatrix"
• "gate2way"
• "Cardknox"
• "MobilePay"
• "TrustsPay"
• "BraintreePayments"
• "Cleo"
• "INOVAPAY"
• "SecurionPay"
• "CASHlib"
• "ecoPayz"
• "Greenbox"
• "PandaGateway"
• "MaxiCash"
• "Pay4Fun"
• "NGenius"
• "Aircash"
• "Paysafe"
• "JetPay"
• "Realex"
• "Citadel"
• "FundSend"
• "Neteller"
• "eMerchantPay"
• "GoCardless"
• "NordikCoin"
• "CoinPayments"
• "Finrax"
• "RPN"
• "Forte"
• "Rapyd"
• "Dengi"
• "Wirecard"
• "Dragonphoenix"
• "Coinbase"
• "AmexVPC"
• "BVNK"
• "Realtime"
• "iCanPay"
• "Zotapay"
• "FinTecSystems"
• "Cryptonator"
• "NuaPay"
• "VCreditos"
• "PayClub"
• "Netbanking"
• "Cashterminal"
• "AmazonPay"
• "Sagepay"
• "MonRem"
• "Payflow"
• "OchaPay"
• "MyFatoorah"
• "CashToCode"
• "Cryptomus"
• "Directa24"
• "STPMexico"
• "InstaDebit"
• "ParamountCommerce"
• "PaymentsOS"
• "MuchBetter"
• "NinjaWallet"
• "Payvision"
• "CauriPayment"
• "Adyen"
• "BlueSnap"
• "Kushki"
• "WorldlineAtosFrankfurt"
• "Aera"
• "Pagadito"
• "Triple000"
• "Unlimit"
• "EPro"
• "StaticGateway"
• "Ingenico"
• "PharosPayments"
• "CCAvenue"
• "ToditoCash"
• "AsiaPay"
• "Euteller"

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

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

Specifies if a gateway allows dynamic descriptors.

Default value: false

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

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.

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

Gateway account token.

Gateway account request timeout, in seconds.

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

Default value: false

Accepted payment card brands.

Excluded Dynamic Currency Conversion (DCC) quote currencies.