Refund Status Endpoint

Retrieve the status of a previously created refund

Refund Status

GET https://api-stg.onekeypayments.com/v3/refunds/{refund_id}

This endpoint allows you to retrieve the status of a refund request.

Path Parameters

Name	Type	Description
refund_id	integer	Directa24 refund_id. It is obtained when creating the refund

Headers

Name	Type	Description
X-Date	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login	string	Merchant X-Login API Key
Authorization	string	Authentication signature hash

200 Refund status successfully retrieved.

{
    "deposit_id": 300533646,
    "merchant_invoice_id": "newIUnit45328731",
    "status": "PENDING"
}

404 The refund with the refund_id specified could not be found.

Description

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.

Refunds Status Request

In order to check the status of the refunds, you need to:

1. Send the request with GET method.

2. Use the headers described here.

3. Specify a valid refund_id in the URL of the request as PATH PARAMETERS.

4. Send the Authorization header, as explained here.

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.

cURL

curl --location --request GET 'https://api-stg.onekeypayments.com/v3/refunds/1682844' \
--header 'X-Login: {{X-Login}}' \
--header 'X-Date: {{X-Date}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Content-Type: application/json' \
--data-raw ''

JAVA

C#

PHP

Example response

COMPLETED

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

PENDING

Response fields

Field name	Format	Description
deposit_id	Integer	ID of the deposit refunded
merchant_invoice_id	String	Merchant invoice id of the deposit refunded
status	Enum	Status of the refund. Click here for the full list of refund codes.
amount	Number	Amount of the refund

In order to make the experience more personalized, we may add more fields to this response's object in the future. Please develop your integration to be able to ignore new fields considering that it will continue working fine no matter if we add new fields.

Status Flow

Click here to see each Refund Status meaning.

Refund Status Flow

1. DECLINED is not a status by itself. It means the refund failed to be created.

2. As soon as the refund request is created, its status will be PENDING.

3. In case we need more information to complete the request or any of the details were incorrect, we will change the status to INCORRECT_DETAILS and you will need to provide the correct details. Once the details have been provided, its status will be PENDING again.

4. The status CANCELLED means the refund was manually cancelled by you. Only refunds in PENDING or INCORRECT_DETAILS can be cancelled. Final status.

5. If everything is fine we will send the refund for processing and the status will be marked as DELIVERED. It can't be cancelled at this point.

6. As soon as the processor/bank confirms the refund, it will be marked as COMPLETED or REJECTED (by the bank).

7. There are some corner cases in which the receiver's bank tell us that the refund was completed but days after it gets rejected. In those cases the status changes from COMPLETED to REJECTED.

Status codes

Check all the possible status in the following page:

API Codes