curl --request GET \
--url https://api.mattildapayments.com/transactions/{transaction_id}/refunds \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"type": "refund",
"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"payment_service_refund_id": "refund_xYqd43gySMtori",
"status": "processing",
"currency": "MXN",
"amount": 1299,
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"target_type": "payment-method",
"target_id": "c23ea83f-1b1c-4584-a0e8-78ef8c041949"
}
],
"limit": 1,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": null
}
This endpoint requires the transactions.read scope.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID for the transaction to get the information for.
Example:"fe26475d-ec3e-4884-9553-f7356683f7f9"
Returns a list of refunds.
A refund record.
A refund is always associated with a single transaction, while a transaction
can potentially have several refunds.
The type of this resource. Is always refund.
Available options:
refund
The unique ID of the refund.
Example:"8724fd24-5489-4a5d-90fd-0604df7d3b83"
The ID of the transaction associated with this refund.
Example:"fe26475d-ec3e-4884-9553-f7356683f7f9"
items.payment_service_refund_id
The payment service's unique ID for the refund.
The status of the refund.
It may change over time as asynchronous processing events occur.
processing - The refund is being processed.succeeded - The refund was successful.declined - The refund was declined by the underlying PSP.failed - The refund could not proceed due to a technical issue.voided - The refund was voided and will not proceed.
Available options:
processing,
succeeded,
declined,
failed,
voided
The currency code for this refund.
Will always match that of the associated transaction.
The amount requested for this refund.
Required range: 0 <= x <= 99999999
The date and time when this refund was created.
Example:"2013-07-16T19:23:00.000+00:00"
The date and time when this refund was last updated.
Example:"2013-07-16T19:23:00.000+00:00"
The type of the instrument that was refunded.
Available options:
payment-method,
gift-card-redemption
The optional ID of the instrument that was refunded. This may be null if
the instrument was not stored.
Example:"c23ea83f-1b1c-4584-a0e8-78ef8c041949"
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
Required range: 1 <= x <= 100
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
