Retrieve payment methods metadata

Retrieve payment methods metadata.

Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Payment methods metadata received.

Response Schema: application/json
Array
apiName
required
string (PaymentMethodApiName) ^[\w\. -]+$

Name of the payment method returned in our API response.

name
required
string^[\w\. -]+$

Name of the payment method.

summary
required
string

Short description of the payment method. (Markdown is supported).

description
required
string

Detailed information about the payment method. (Markdown is supported).

required
Unrestricted (object) or Subset (object) (CountriesMetadata)
One of:
mode
required
string

Specifies how the countries are compared.

Enum: "unknown" "all" "subset"
landscapeLogo
string or null <uri>

URL for the payment method logo optimized for landscape orientation.

portraitLogo
string or null <uri>

URL for the payment method logo optimized for portrait orientation.

storefrontEnabled
boolean
Default: false
Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
get/payment-methods
Request samples
Response samples
application/json
[
  • {
    }
]