You can add a gateway account more than once by using a different name each time.

Each of the gateways requires a different set of parameters. Refer to the list below for more information.

  1. Add gateway using your credentials.
  2. Add gateway using your credentials and activate wallet payments (Apple/Google Pay)

Gateway types

NameType
AfterpayAfterpay
MasterCardMasterCard
PayPalPaypal
PayPal ClassicPaypalClassic
Zip MoneyZipmoney

Request body

fieldrequired[flow]typedescription
type+1typeA type of the gateway. See Types table
name+1stringA manually defined name
default-boolUse the gateway by default for the Client SDK widget. Default value is false
mode-stringDefaults to test, must be live for the production mode
proccess_custom_fields-boolAll custom fields will be sent to the payment gateway during any transaction, if the payment gateway supports it. false by default (this feature is disabled)
meta-objectAn optional object with specific fields for different gateways
meta.reversal-boolA flag to use reversal functionality for transactions which have unexpected responses from a payment gateway (e.g., connection timeout, server errors, etc.). Supported Gateways: MasterCard. false by default
meta.store_ccv-boolA flag to be able to use a CVV value for the initial transaction
meta.version-numberA number to specify gateway version when supported (Afterpay)
wallet-objectAn optional object with specific fields for wallet payments such as Apple/Google Pay
wallet.apple+2 (Apple wallet)objectAn optional object with specific fields for Apple Pay
wallet.apple.merchant+2stringAn Apple Merchant ID
wallet.apple.certificate_passphrase+2stringAn Apple Merchant ID Certificate
wallet.apple.signature+2stringAn Apple Merchant ID Private Key
wallet.apple.username+2stringAn Apple Payment Processing Certificate used for the encryption process
wallet.apple.password+2stringAn Apple Payment Processing Private Key used to authenticate the communication with Apple Pay servers
wallets.google+2 (Google wallet)objectAn optional object with specific fields for Google Pay
wallets.google.merchant+2stringGoogle Merchant ID
settings-objectAn optional object with additional settings
settings.terminal_id+stringTerminal ID
settings.acquiring_institution_id+stringAcquiring Institution ID
settings.forwarding_institution_id+stringForwarding Institution ID
settings.merchant_name+stringMerchant Name
settings.merchant_tier_code+stringMerchant Tier Code
settings.merchant_category_code+stringMerchant Category Code

Request body for each gateway

gatewayfieldrequired[flow]typedescription
PayPal
PayPalusername+stringClient ID
PayPalpassword+stringSecret key
PayPal Classic
PayPal Classicusername+stringClient ID
PayPal Classicpassword+stringSecret key
PayPal Classicsignature+stringSignature
Afterpay
Afterpayusername+stringUsername
Afterpaypassword+stringPassword
Zip Money
Zip Moneyusername+stringUsername
MasterCard
MasterCardusername+1stringMerchant
MasterCardpassword+1stringPassword
MasterCardwallets+2objectOptional object with specific fields for wallet payments like Apple/Google Pay
MasterCardwallets.apple+2 (Apple pay)objectOptional object with specific fields for Apple Pay
MasterCardwallets.apple.merchant+2 (Apple pay)string Merchant ID
MasterCardwallets.apple.certificate_passphrase+2 (Apple pay)stringMerchant ID Certificate
MasterCardwallets.apple.signature+2 (Apple pay)stringMerchant ID Private Key
MasterCardwallets.apple.username+2 (Apple pay)stringPayment Processing Certificate
MasterCardwallets.apple.password+2 (Apple pay)stringPayment Processing Private Key
MasterCardwallets.google+2 (Google pay)objectObject with specific fields for Apple Pay
MasterCardwallets.google.merchant+2 (Google pay)stringGoogle Merchant ID
Language
URL