v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Payment Methods

Use this method to get a list of your active payment methods according to the filters you set.

get/paymentMethods

Query parameters

Countrystring

The country code of the customer. MX, CR, CO, EC, PE, BR, CL, AR

Channelstring

The channel through which the customer will pay. ONLINE, CASH, CREDITCARD, WALLET

Currencystring

The currency code in which the customer will pay. MXN, CRC, COP, USD, PEN, BRL, CLP, ARS

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Response

200

countinteger

Example response

{
  "count": 3,
  "list": [
    {
      "paymentMethodId": "9edecd07-91f9-4aa8-9581-ae56c77d553e",
      "name": "TEST METHOD 1",
      "channel": "CASH",
      "group": "APM",
      "imageUrl": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "country": "BR",
      "orderPriority": 2147483647,
      "paymentMethodTag": "TEST_METHOD_1"
    }
  ]
}