GET
/
refunds
/
{refund_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "refund",
  "id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
  "transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "payment_service_refund_id": "refund_xYqd43gySMtori",
  "status": "processing",
  "currency": "USD",
  "amount": 1299,
  "reason": "Refund due to user request",
  "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",
  "external_identifier": "refund-789123",
  "reconciliation_id": "7jZXl4gBUNl0CnaLEnfXbt",
  "transaction_external_identifier": "transaction-789123",
  "transaction_reconciliation_id": "7jZXl4gBUNl0CnaLEnfXbt"
}

This endpoint requires the transactions.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
refund_id
string
required

The unique ID of the refund.

Example:

"8724fd24-5489-4a5d-90fd-0604df7d3b83"

Response

200
application/json
Returns a refund.

A refund record.

A refund is always associated with a single transaction, while a transaction can potentially have several refunds.

​
type
enum<string>

The type of this resource. Is always refund.

Available options:
refund
Example:

"refund"

​
id
string

The unique ID of the refund.

Example:

"8724fd24-5489-4a5d-90fd-0604df7d3b83"

​
transaction_id
string

The ID of the transaction associated with this refund.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

​
payment_service_refund_id
string

The payment service's unique ID for the refund.

Example:

"refund_xYqd43gySMtori"

​
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.
Available options:
processing,
succeeded,
declined,
failed
Example:

"processing"

​
currency
string

The currency code for this refund. Will always match that of the associated transaction.

Example:

"USD"

​
amount
integer

The amount requested for this refund.

Required range: 0 <= x <= 99999999
Example:

1299

​
reason
string | null

The reason for this refund. Could be a multiline string.

Maximum length: 100
Example:

"Refund due to user request"

​
created_at
string

The date and time when this refund was created.

Example:

"2013-07-16T19:23:00.000+00:00"

​
updated_at
string

The date and time when this refund was last updated.

Example:

"2013-07-16T19:23:00.000+00:00"

​
target_type
enum<string>

The type of the instrument that was refunded.

Available options:
payment-method,
gift-card-redemption
Example:

"payment-method"

​
target_id
string | null

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"

​
external_identifier
string | null

An external identifier that can be used to match the refund against your own records.

Required string length: 1 - 300
Example:

"refund-789123"

​
reconciliation_id
string

The base62 encoded refund ID. This represents a shorter version of this refund's id which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's refund against our system.

Example:

"7jZXl4gBUNl0CnaLEnfXbt"

​
transaction_external_identifier
string | null

The external identifier of the related transaction.

Example:

"transaction-789123"

​
transaction_reconciliation_id
string

The base62 encoded transaction ID. This represents a shorter version of the related transaction's id which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's transaction against our system.

Example:

"7jZXl4gBUNl0CnaLEnfXbt"

Was this page helpful?

Refund all instrumentsGet session