List payment methods

GET

/v1/payment_methods

const url = 'https://api.example.com/v1/payment_methods?limit=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/v1/payment_methods?limit=10' \
  --header 'Authorization: Bearer <token>'

Your enabled methods, ordered by method then channel.

Authorizations

AccessToken

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

How many objects to return, from 1 to 100.

cursor

string

A next_cursor from the previous page.

Responses

200

A page of payment methods.

application/json

object

object

required

string

Allowed value: list

data

required

Array

has_more

required

boolean

next_cursor

required

Pass back as cursor for the next page. null on the last page.

string | null

data

required

Array<object>

object

required

pm_<method>-<channel>.

string

object

required

string

Allowed value: payment_method

method

required

string

channel

required

string

available

required

Whether it can take a payment now.

boolean

unavailable_reason

required

Why it cannot, when available is false.

string | null

Allowed values: account_inactive not_permitted_for_account method_not_enabled method_not_set_up method_suspended not_available

livemode

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "id": "pm_qrph-ecommerce",
      "object": "payment_method",
      "method": "qrph",
      "channel": "ecommerce",
      "unavailable_reason": "account_inactive"
    }
  ]
}

Headers

X-Request-ID

string

This request’s id. Quote it when you contact support.

400

validation_failure: invalid_parameter for a parameter missing or not valid, named in param; invalid_json for a body that is not JSON; unsupported_media_type for a body that is not sent as JSON; not_acceptable when the request will not accept JSON; method_not_allowed for an HTTP method the path does not take.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure",
    "code": "invalid_parameter",
    "message": "A whole number of minor units, from 1 to 999999999999999999.",
    "param": "amount",
    "request_id": "req_4f1c0b2e9a7d"
  }
}

401

authentication_failure: access_token_required when no token was sent, invalid_access_token when it is not valid, has expired, or is a client secret. Sent with a WWW-Authenticate: Bearer header, which adds error="invalid_token" when a token was sent.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}

403

authorization_failure with merchant_mismatch: a Merchant-Id header, query parameter or body field names a merchant or tenant other than the key’s.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}

503

dependency_failure with service_unavailable: something on our side, or a payment network behind it, did not answer. This call only reads, so nothing was changed; retry.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}