POST
/
transactions
/
{transaction_id}
/
refunds
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "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.write 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"

Body

application/json

A request to refund a transaction.

Response

201
application/json

Returns the created refund.

A refund record.

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