The RefundAPI is an API that allows clients to automate the refund process for their customers. This API enables the client to refund the customer's points and update it without any manual intervention. The API has to be built by the client so Xoxoday can consume it.
The request and response are for illustrative purposes and to help the client refer to a skeleton that Xoxoday deems acceptable.
Note: Please ensure that you share your response in JSON format only, as our system does not support any other data types.
Headers
- application/JSON
Request
{
"auth_token" : "123xyz", //client's api token provided at the time of SSO
"transactionid" : "AB1890082790",
"redemption_amount" : "200"
}
Schema
| Parameters | Description |
|---|---|
| unique_id | Unique identifier of a user |
| auth_token | An authorisation value to successfully allow the request from Xoxoday to your system. This value is to be sent by the client during SSO redirection |
| transactionid | OrderID of the order |
| redemption_amount | Points/Amount used by the end-user |
Response
{
"status":"1",
"message": "Successfully updated",
"data" : {
"transaction_id" : "123",
"points" : "200"
}
}
Schema
| Parameters | Description |
|---|---|
| status | 1 = Successful 0 = Failure |
| message | Indicates the APIs success/failure |
| data.transaction_id | OrderID of the voucher |
| data.points | Points refunded |