post http://{{url}}/v1/gateways
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.
- Add gateway using your credentials.
- Add gateway using your credentials and activate wallet payments (Apple/Google Pay)
Gateway types
| Name | Type |
|---|---|
| Afterpay | Afterpay |
| MasterCard | MasterCard |
| PayPal | Paypal |
| PayPal Classic | PaypalClassic |
| Zip Money | Zipmoney |
Request body
| field | required[flow] | type | description |
|---|---|---|---|
| type | +1 | type | A type of the gateway. See Types table |
| name | +1 | string | A manually defined name |
| default | - | bool | Use the gateway by default for the Client SDK widget. Default value is false |
| mode | - | string | Defaults to test, must be live for the production mode |
| proccess_custom_fields | - | bool | All 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 | - | object | An optional object with specific fields for different gateways |
| meta.reversal | - | bool | A 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 | - | bool | A flag to be able to use a CVV value for the initial transaction |
| meta.version | - | number | A number to specify gateway version when supported (Afterpay) |
| wallet | - | object | An optional object with specific fields for wallet payments such as Apple/Google Pay |
| wallet.apple | +2 (Apple wallet) | object | An optional object with specific fields for Apple Pay |
| wallet.apple.merchant | +2 | string | An Apple Merchant ID |
| wallet.apple.certificate_passphrase | +2 | string | An Apple Merchant ID Certificate |
| wallet.apple.signature | +2 | string | An Apple Merchant ID Private Key |
| wallet.apple.username | +2 | string | An Apple Payment Processing Certificate used for the encryption process |
| wallet.apple.password | +2 | string | An Apple Payment Processing Private Key used to authenticate the communication with Apple Pay servers |
| wallets.google | +2 (Google wallet) | object | An optional object with specific fields for Google Pay |
| wallets.google.merchant | +2 | string | Google Merchant ID |
| settings | - | object | An optional object with additional settings |
| settings.terminal_id | + | string | Terminal ID |
| settings.acquiring_institution_id | + | string | Acquiring Institution ID |
| settings.forwarding_institution_id | + | string | Forwarding Institution ID |
| settings.merchant_name | + | string | Merchant Name |
| settings.merchant_tier_code | + | string | Merchant Tier Code |
| settings.merchant_category_code | + | string | Merchant Category Code |
Request body for each gateway
| gateway | field | required[flow] | type | description |
|---|---|---|---|---|
| PayPal | ||||
| PayPal | username | + | string | Client ID |
| PayPal | password | + | string | Secret key |
| PayPal Classic | ||||
| PayPal Classic | username | + | string | Client ID |
| PayPal Classic | password | + | string | Secret key |
| PayPal Classic | signature | + | string | Signature |
| Afterpay | ||||
| Afterpay | username | + | string | Username |
| Afterpay | password | + | string | Password |
| Zip Money | ||||
| Zip Money | username | + | string | Username |
| MasterCard | ||||
| MasterCard | username | +1 | string | Merchant |
| MasterCard | password | +1 | string | Password |
| MasterCard | wallets | +2 | object | Optional object with specific fields for wallet payments like Apple/Google Pay |
| MasterCard | wallets.apple | +2 (Apple pay) | object | Optional object with specific fields for Apple Pay |
| MasterCard | wallets.apple.merchant | +2 (Apple pay) | string Merchant ID | |
| MasterCard | wallets.apple.certificate_passphrase | +2 (Apple pay) | string | Merchant ID Certificate |
| MasterCard | wallets.apple.signature | +2 (Apple pay) | string | Merchant ID Private Key |
| MasterCard | wallets.apple.username | +2 (Apple pay) | string | Payment Processing Certificate |
| MasterCard | wallets.apple.password | +2 (Apple pay) | string | Payment Processing Private Key |
| MasterCard | wallets.google | +2 (Google pay) | object | Object with specific fields for Apple Pay |
| MasterCard | wallets.google.merchant | +2 (Google pay) | string | Google Merchant ID |