GET

/transactions/{transaction_id}/refunds

curl --request GET \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/refunds \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "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"
    }
  ],
  "limit": "1",
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "null"
}

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.

Query Parameters

limit
Default: "20"
integer

Defines the maximum number of items to return for this request.

cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Response

200 - application/json
items
object[]

A list of refunds.

limit
Default: "20"
integer

The limit applied to request. This represents the number of items that are at maximum returned by this request.

next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.