Get refund status

Retrieve Refund Status

get

Retrieve the status of a previously created refund. You can trigger the check of the status of a refund at any moment you consider pertinent. However, every time a refund changes its status, we will send you a notification containing the ID of the refund so that you can check its status back to retrieve the new refund's status.

Regarding the Authorization value, since the body of the requests will be empty, you should use an empty ("") string or nothing as the jsonPayload field for generating the signature.

Path parameters

refund_idintegerRequired

onekeypayments refund_id. It is obtained when creating the refund.

Example: 1682844

Query parameters

voucherbooleanOptional

true / false value. The request with true value will return the refund invoice in base64 to be decoded to create a .pdf file.

Header parameters

Content-TypestringRequired

Media type of the request. For GET, this is typically application/json if any specific content negotiation is implied by the server, even without a body.

Default: application/json

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ).

Example: 2023-05-27T10:30:00Z

X-LoginstringRequired

Merchant X-Login API Key.

Example: your-x-login-key

AuthorizationstringRequired

Authentication signature. The signature is generated based on specific headers and an empty payload for GET requests.

Example: onekeypayments-HMAC-SHA256 SignedHeaders=x-date;x-login, Signature=your_signature_hash

X-Idempotency-Keystring · uuidOptional

Unique idempotency key for ensuring that the same request is not processed more than once. (Generally more applicable for state-changing requests like POST, PUT, DELETE).

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200

Refund status successfully retrieved.

application/json

Details of the refund status. The API may add more fields to this response object in the future; integrations should be tolerant of new fields.

deposit_idintegerOptional

ID of the deposit refunded.

Example: 300533569

merchant_invoice_idstringOptional

Merchant invoice id of the deposit refunded.

Example: 84044

statusstring · enumOptional

Status of the refund. Possible values:

• PENDING: The refund request has been created and is awaiting processing.
• DELIVERED: The refund has been sent for processing.
• COMPLETED: The refund has been successfully processed.
• INCORRECT_DETAILS: More information is needed, or details were incorrect.
• REJECTED: The refund was rejected (e.g., by the bank).
• CANCELLED: The refund was manually cancelled (only possible in PENDING or INCORRECT_DETAILS).

Example: COMPLETEDPossible values:

amountnumber · floatOptional

Amount of the refund. This field is typically present when the status is COMPLETED.

Example: 100

voucherstring · byteOptional

Proof of refund in base64 coding for generation of a .pdf file. Included in the response only if voucher is sent as true in the query parameters.

Example: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFIvTGFuZ...

401

Unauthorized access. This could be due to an invalid X-Login, X-Date, or Authorization signature.

application/json

404

The refund with the specified refund_id could not be found.

application/json

get

/refunds/{refund_id}

HTTPcURLJavaScriptPython

GET /v3/refunds/{refund_id} HTTP/1.1
Host: api-stg.onekeypayments.com
Content-Type: application/json
X-Date: 2023-05-27T10:30:00Z
X-Login: your-x-login-key
Authorization: onekeypayments-HMAC-SHA256 SignedHeaders=x-date;x-login, Signature=your_signature_hash
Accept: */*

{
  "deposit_id": 300533569,
  "merchant_invoice_id": "84044",
  "status": "COMPLETED",
  "amount": 100
}