Sign in

v1

latestOpenAPI 3.0.02026-07-26355499.1 KB
Refunds

Retrieve Refund Status

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.

get/refunds/{refund_id}

Path parameters

refund_idinteger required

Directa24 refund_id. It is obtained when creating the refund.

Query parameters

voucherboolean

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

Headers

Content-Typestring required

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.

X-Datestring date-time required

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

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

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

X-Idempotency-Keystring uuid

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).

Response

Refund status successfully retrieved.

deposit_idinteger

ID of the deposit refunded.

merchant_invoice_idstring

Merchant invoice id of the deposit refunded.

status'PENDING' | 'DELIVERED' | 'COMPLETED' | 'INCORRECT_DETAILS' | 'REJECTED' | 'CANCELLED'

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).
amountnumber float

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

voucherstring byte

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.