List all payment methods

How to fetch a collection of payment methods via API

To fetch a collection of payment methods, send a GET request to the /api/payment_methods endpoint.

Request

GET https://yourdomain.commercelayer.io/api/payment_methods

Example

The following request fetches a collection of payment methods:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/payment_methods/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of payment methods can be sorted by the following fields:

Attributes

  • name

  • payment_source_type

  • currency_code

  • price_amount_cents

  • id

  • disabled_at

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • market

Filterable fields

The list of payment methods can be filtered by the following fields:

Attributes

  • name

  • payment_source_type

  • currency_code

  • price_amount_cents

  • id

  • disabled_at

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • market

  • payment_gateway

  • attachments

Last updated