Retrieve a refund
How to fetch a specific refund via API
To fetch a single refund, send a GET
request to the /api/refunds/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/refunds/:id
Example
The following request fetches the refund identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/refunds/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": "refunds",
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde"
},
"attributes": {
"amount_cents": 1500,
"amount_float": 15.0,
"created_at": "2018-01-01T12:00:00.000Z",
"currency_code": "EUR",
"error_code": "00001",
"error_detail": "Already settled",
"formatted_amount": "€15,00",
"gateway_transaction_id": "xxxx-yyyy-zzzz",
"message": "Accepted",
"metadata": {
"foo": "bar"
},
"number": "42/T/001",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"succeeded": false,
"token": "xxxx-yyyy-zzzz",
"type": "authorizations",
"updated_at": "2018-01-01T12:00:00.000Z"
},
"relationships": {
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/events"
}
},
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/order"
}
},
"reference_capture": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/reference_capture",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/reference_capture"
}
},
"return": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/return",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/return"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/refunds/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last updated