Retrieve a specified payment method metadata

Retrieve a specified payment method metadata.

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

Payment method API name.

Responses
200

Payment method metadata received.

Response Schema: application/json
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/{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": [
    ]
}