Refund transaction
/transactions/{transaction_id}/refunds
{
"amount": "1299",
"created_at": "2013-07-16T19:23:00.000+00:00",
"currency": "USD",
"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"status": "processing",
"transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"type": "refund",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
This endpoint requires the transactions.write
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID for the transaction to get the information for.
Body
The amount requested to refund.
If omitted, a full refund will be requested.
Otherwise, the amount must be lower than or equal to the remaining balance in the associated transaction.
Negative and zero-amount refunds are not supported.
Response
The amount requested for this refund.
The date and time when this refund was created.
The currency code for this refund. Will always match that of the associated transaction.
The unique ID of 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.
processing
, succeeded
, declined
, failed
, voided
The ID of the transaction associated with this refund.
The type of this resource. Is always refund
.
refund
The date and time when this refund was last updated.
{
"amount": "1299",
"created_at": "2013-07-16T19:23:00.000+00:00",
"currency": "USD",
"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"status": "processing",
"transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"type": "refund",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}