List all authorizations

How to fetch a collection of authorizations via API

To fetch a collection of authorizations, send a GET request to the /api/authorizations endpoint.

Request

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

Example

The following request fetches a collection of authorizations:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/authorizations/' \
  -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 authorizations can be sorted by the following fields:

  • number

  • amount_cents

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of authorizations can be filtered by the following fields:

Attributes

  • number

  • currency_code

  • amount_cents

  • succeeded

  • message

  • error_code

  • error_detail

  • token

  • gateway_transaction_id

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • order

  • attachments

  • events

Last updated