OI Payments Docs
API ReferenceRefunds

Get By Id

GET
/api/v1/refunds/{id}

Authorization

AppApiKey AppApiSecret
X-Api-Key<token>

Per-app API key. Sent together with the X-Api-Secret header. The key's mode (TEST or LIVE) selects the data partition — it is never taken from the request body.

In: header

X-Api-Secret<token>

Per-app API secret that pairs with X-Api-Key. Both headers are required on every app-facing call.

In: header

Path Parameters

id*integer

Response Body

*/*

curl -X GET "https://example.com/api/v1/refunds/0"
{
  "data": {
    "id": 0,
    "paymentId": 0,
    "mode": "string",
    "amountMinor": 0,
    "currency": "string",
    "reason": "string",
    "status": "string",
    "gatewayRefundId": "string",
    "createdBy": "string",
    "approvedBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "success": true,
    "message": "string",
    "errorCode": "RESOURCE_NOT_FOUND",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "pagination": {
    "page": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}