{
"id": "string",
"live_payment_methods_url": "string",
"test_payment_methods_url": "string",
"name": "string",
"description": "string",
"image": "string",
"icons": [ "string" ],
"management_url": "string"
}
Need help with a custom payment gateway?You can find a detailed guide on implementing a payment gateway in our Integrate a Payment Gateway how-to.
payment_gateway
Property | Description | Mutable |
|---|---|---|
id string | System identifier of the custom payment gateway. | No |
live_payment_methods_url string | The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in LIVE mode. | Yes |
test_payment_methods_url string | The payment methods API endpoint that will be called to retrieve the available payment methods for the cart in TEST mode. This URL can be the same as live_payment_methods_url. | Yes |
name string | The name for the payment gateway. | Yes |
description string | The description for the payment gateway. | Yes |
image string | The image url for the payment gateway. | Yes |
icons string[] | An array of the icon url(s) for the payment gateway. | Yes |
management_url string | When defined, a contextual menu will be displayed on the card in the payment gateway’s page, with a link to the set url in the property. Merchants will be able to access their gateway’s account from this button. | Yes |