List all voids

How to fetch a collection of voids via API

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

Request

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

Example

Request

The following request fetches a collection of voids:

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

Response

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

Sortable fields

The list of voids can be sorted by the following fields:

Attributes

• number

• type

• amount_cents

• id

• created_at

• updated_at

• reference

• reference_origin

Relationships

• order

Filterable fields

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

Attributes

• number

• type

• 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

• payment_source

• attachments

• events

• reference_authorization