How do you integrate Instant with a refunds system?

The refund order API can cater for use cases where a third party system needs to call Instant to process refunds.

It is recommended that Instant brands utilise the Instant dashboard, or eCommerce dashboards to process refunds.

However, if your integration is more advanced / bespoke, and requires custom integration with Instant's Orders API, the documentation below can assist with integration. Please contact Instant support or your Customer Success Manager for assistance if you encounter any issues.

Any refunds created through this endpoint will be immediately available in the Instant dashboard as well.

Endpoint (POST):

Production:

https://api.instant.one/order/refund

Staging:

https://staging.api.instant.one/order/refund

Headers: 

X-Instant-App-Auth: {YOUR_APP_AUTH_TOKEN}
X-Instant-App-Id: {YOUR_APP_ID}

If you do not have these values, please contact your Customer Success manager.

Please note that the header values are case-sensitive.

Payload:

{
    "amountToRefund": number // Amount to refund, e.g. 10.99 for 10 dollars and 99 cents.
    "displayOrderId": string // Customer facing order ID. 
    "storeCode": string // This is provided by Instant.
}

If you do not have the storeCode, please contact your Customer Success manager.

Please note that for Magento, displayOrderId is the order increment ID - i.e. the order ID the customer sees, which differs from the entity ID (the underlying database ID).

For BigCommerce and WooCommerce, the displayOrderId is the order ID the customer sees.

The amount to refund will be rounded to the nearest smallest unit of currency, and the amount after rounding must be a positive value.

Responses:

Status: 200 - refund successful and no further action required 

Status: 500 - possible responses. If INTENRAL_SERVER_ERROR is received, please contact Instant support for more details.

{
    "error": string,
    "message": string
}

The possible values for the "error" field are below.