Refund Status Endpoint

Retrieve the status of a previously created refund

Refund Status

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

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.

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

  • Send the request with GET method.

  • Use the headers described here.

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

  • Send the Authorization header, as explained here.

Path Parameters

Name
Type
Description

refund_id

integer

Lime-Pay 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

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 --location --request GET 'https://api-stg.lime-pay.com/v3/refunds/1682844' \
--header 'X-Login: {{X-Login}}' \
--header 'X-Date: {{X-Date}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Example response

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

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

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

Status codes

Check all the possible status in the following page:

Last updated

Was this helpful?