List transaction refunds

GET /transactions/{transaction_id}/refunds

List refunds

C#

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/transactions/{transaction_id}/refunds");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

200

{
  "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": "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"
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

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

transaction_id · string · required

The ID for the transaction to get the information for.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

Response

200

application/json

Returns a list of refunds.

A list of refunds.

items · Refund · object[]

A list of refunds.

Show child attributes

limit · integer<int32> · default: 20

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

Required range: 1 <= x <= 100

Example:

1

next_cursor · string | null

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

Example:

"ZXhhbXBsZTE"

previous_cursor · string | null

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

Example:

null