Retrieve payment method metadata

Request

Retrieves payment method metadata.
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payment-methods?limit=0&offset=0'

Responses

Payment methods metadata received.
Bodyapplication/json
Array [
apiNamestring^[\w\. -]+$required
Name of the payment method returned in the API response.
namestring^[\w\. -]+$required
Name of the payment method.
summarystringrequired
Short description of the payment method. This field supports Markdown.
descriptionstringrequired
Detailed information about the payment method. This field supports Markdown.
countriesobject(CountriesMetadata)required
storefrontEnabledboolean
Default:false
isSingleUseboolean
Specifies that the payment method requires the customer to review and confirm payment options and terms specific to the purchase every time. The merchant cannot assist the customer in adding this payment method during the checkout process. The customer must complete the process independently.
Default:false
supportedCurrenciesobject
relevantBusinessModelsArray of strings
Business models that are relevant to the payment method.
Items Enum:"B2B""B2C"
typestring or null
Type of payment method. For example, wallet, bank transfer, credit card.
recurringPaymentsboolean
Specifies whether the payment method supports recurring payments.
Default:false
refundsboolean
Specifies whether the payment method supports refunds.
Default:false
disputesboolean
Specifies whether the payment method supports disputes.
Default:false
uxArray of objects
List of steps that describes the user experience during the payment flow.
_linksArray of objects(SelfLink)read-only
Related links.
]
Response
[
  {
    "apiName": "string",
    "name": "string",
    "landscapeLogo": "http://example.com",
    "portraitLogo": "http://example.com",
    "summary": "string",
    "description": "string",
    "countries": { … },
    "storefrontEnabled": false,
    "isSingleUse": false,
    "supportedCurrencies": { … },
    "relevantBusinessModels": [ … ],
    "type": "string",
    "recurringPayments": false,
    "refunds": false,
    "disputes": false,
    "ux": [ … ],
    "_links": [ … ]
  }
]