Payment Gateway Object

{
  "id": "string",
  "live_payment_methods_url": "string",
  "test_payment_methods_url": "string",
  "name": "string",
  "description": "string",
  "image": "string",
  "icons": [ "string" ]
}

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