Skip to main content
POST
/
transactions
/
{transaction_id}
/
refunds
/
all
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "mattilda",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.Refunds.All.CreateAsync(transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591");

// handle response
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "processing",
      "currency": "<string>",
      "amount": 49999999,
      "target_type": "payment-method",
      "reconciliation_id": "<string>",
      "transaction_reconciliation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "refund",
      "payment_service_refund_id": "refund_xYqd43gySMtori",
      "reason": "Refund due to user request.",
      "target_id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
      "external_identifier": "refund-12345",
      "transaction_external_identifier": "transaction-12345",
      "creator": {
        "email_address": "[email protected]",
        "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
        "name": "Jhon Doe"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}
This endpoint requires the transactions.write scope.

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

​
transaction_id
string<uuid>
required

The ID of the transaction

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

Body

application/json
​
reason
string | null

An optional reason to attach extra context to the refund requests.

Maximum string length: 100
Example:

"Refund due to user request."

​
external_identifier
string | null

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

Required string length: 1 - 300
Example:

"refund-12345"

Response

Successful Response

​
items
Refund · object[]
required

A list of items returned for this request.

​
limit
integer
default:20

The number of items for this page.

Required range: 1 <= x <= 100
Example:

20

​
next_cursor
string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

​
previous_cursor
string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000
Example:

"Xkjss7asS"