Retrieve metadata of a payment method

Retrieves the metadata of a payment method with a specified apiName.

Request
path Parameters
apiName
required
string (PaymentMethodApiName) ^[\w\. -]+$

Name of the payment method API.

Responses
200

Payment method metadata received.

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

Name of the payment method returned in the API response.

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

Name of the payment method.

summary
required
string

Short description of the payment method. This field supports Markdown.

description
required
string

Detailed information about the payment method. This field supports Markdown.

required
Unrestricted (object) or Subset (object) (CountriesMetadata)

Countries metadata.

One of:

Countries metadata.

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 (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
get/payment-methods/{apiName}
Request samples
Response samples
application/json
{
  • "apiName": "string",
  • "name": "string",
  • "landscapeLogo": "http://example.com",
  • "portraitLogo": "http://example.com",
  • "summary": "string",
  • "description": "string",
  • "countries": {
    },
  • "storefrontEnabled": false,
  • "_links": [
    ]
}