Skip to main content
POST
/
transactions
/
{transaction_id}
/
refunds
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.CreateAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    transactionRefundCreate: new TransactionRefundCreate() {}
);

// handle response
{
  "type": "refund",
  "id": "6a1d4e46-14ed-4fe1-a45f-eff4e025d211",
  "transaction_id": "7099948d-7286-47e4-aad8-b68f7eb44591",
  "payment_service_refund_id": "refund_xYqd43gySMtori",
  "status": "succeeded",
  "currency": "EUR",
  "amount": 1299,
  "reason": "Refund due to user request.",
  "target_type": "payment-method",
  "target_id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
  "reconciliation_id": "7jZXl4gBUNl0CnaLEnfXbt",
  "external_identifier": "refund-12345",
  "transaction_reconciliation_id": "aLEnfXbt7jZXl4gBUNl0Cn",
  "transaction_external_identifier": "transaction-12345",
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "updated_at": "2013-07-16T19:23:00.000+00:00",
  "creator": {
    "email_address": "[email protected]",
    "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
    "name": "Jhon Doe"
  }
}
This endpoint requires the transactions.write scope.

Authorizations

​
Authorization
string
header
required

Headers

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

Path Parameters

​
transaction_id
string<uuid>
required
Examples:

Body

application/json
​
amount
integer | null
Required range: 0 <= x <= 99999999
Examples:
​
reason
string | null
Maximum length: 100
Examples:
​
external_identifier
string | null
Required string length: 1 - 300
Examples:

Response

​
id
string<uuid>
required
Examples:
​
transaction_id
string<uuid>
required
Examples:
​
status
enum<string>
required
Available options:
processing,
succeeded,
failed,
declined,
voided
​
currency
string
required
Examples:
​
amount
integer
required
Required range: 0 <= x <= 99999999
Examples:
​
target_type
enum<string>
required
Available options:
payment-method
​
reconciliation_id
string
required
Examples:
​
transaction_reconciliation_id
string
required
Examples:
​
created_at
string<date-time>
required
Examples:
​
updated_at
string<date-time>
required
Examples:
​
type
string
default:refund
Allowed value: "refund"
Examples:
​
payment_service_refund_id
string | null
Required string length: 1 - 300
Examples:
​
reason
string | null
Examples:
​
target_id
string<uuid> | null
Examples:
​
external_identifier
string | null
Examples:
​
transaction_external_identifier
string | null
Examples:
​
creator
object | null
Examples: