API reference

Getting started API reference How-tos

Getting started API reference How-tos Data model

Metrics API Provisioning API

Core API Other APIs Changelog

List all voids

How to fetch a collection of voids via API

Request

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

Example

The following request fetches a collection of voids:

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

Sortable fields

Attributes

number
type
amount_cents
id
created_at
updated_at
reference
reference_origin

Relationships

order

Filterable 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
attachments
events
reference_authorization

PreviousThe void object NextRetrieve a void

Last updated 1 day ago

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

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

The list of voids can be by the following fields:

The list of voids can be by the following fields: