API reference
Search
K
Links

Retrieve a void

How to fetch a specific void via API
To fetch a single void, send a GET request to the /api/voids/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

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

Example

Request
Response
The following request fetches the void identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/voids/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a single resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "voids",
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde"
},
"attributes": {
"number": "42/T/001",
"currency_code": "EUR",
"amount_cents": 1500,
"amount_float": 15.0,
"formatted_amount": "€15,00",
"succeeded": false,
"message": "Accepted",
"error_code": "00001",
"error_detail": "Already settled",
"token": "xxxx-yyyy-zzzz",
"gateway_transaction_id": "xxxx-yyyy-zzzz",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/order"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/events"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/versions"
}
},
"reference_authorization": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/relationships/reference_authorization",
"related": "https://yourdomain.commercelayer.io/api/voids/xYZkjABcde/reference_authorization"
}
}
},
"meta": {
"mode": "test"
}
}
}