Refunds
Get refund
Gets information about a refund associated with a certain transaction.
GET
/transactions/{transaction_id}/refunds/{refund_id}
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/refunds/{refund_id} \
--header 'Authorization: <authorization>'
{
"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.read
scope.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
transaction_idrequired
string
The ID for the transaction to get the information for.
refund_idrequired
string
The unique ID of the refund.
Response
200 - application/json
amount
integer
The amount requested for this refund.
created_at
string
The date and time when this refund was created.
currency
string
The currency code for this refund. Will always match that of the associated transaction.
id
string
The unique ID of the refund.
status
enum<string>
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
transaction_id
string
The ID of the transaction associated with this refund.
type
enum<string>
The type of this resource. Is always refund
.
Available options:
refund
updated_at
string
The date and time when this refund was last updated.
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/refunds/{refund_id} \
--header 'Authorization: <authorization>'
{
"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"
}