This endpoint will let the Distributor confirm the redeem gold transaction post the Redeem Verify API.
The Redeem Confirm API will be called by the Distributor once the customer has successfully completed the payment for the minting charges for the particular delivery transaction. On success, the value of gold for the particular transaction would be debited from the customer’s gold wallet.
Once the Redeem Verify API is called by the Distributor, the Redeem Confirm API needs to be called within 10 minutes from the time the Redeem Verify API was called. Which means the payment for the minting charges needs to be completed by the customer for the particular buy transaction within 10 minutes of the transaction ID created through the Redeem Verify API.
If the Distributor calls the Redeem Confirm API post the time limit of 10 minutes from the time the Redeem Verify API was called, the particular transaction would be Failed and the response in the Redeem Confirm Method would be rendered as Failed. (Status - 2 in Order Status API)
Note : Post the Distributor calls the Redeem Verify API, Distributor can set a limit on Distributor’s side that the Redeem Confirm API needs to be called within 8 minutes from the time the Redeem Verify API was called. So if the customer fails to complete the payment of the minting charges within 8 minutes of the transaction ID created through the Redeem Verify API, Distributor will not hit the Redeem Confirm API for the particular transaction.
If the customer completes the payment but the time limit extends beyond 8 minutes, the Distributor will not hit the Redeem Confirm API and refund the Minting charges of the particular transaction to the customer.
URL Params
| Parameter | Value |
|---|---|
| user_id | [integer] Example: user_id = 2 |
Request Parameters
| Field | Description | Data Type | Length |
|---|---|---|---|
| tx_id | This would be the Transaction ID which was passed by Safegold in the previous Redeem Verify API for the particular User ID. | Integer | Auto-incremental ID generated By SafeGold system |
| date | Timestamp that needs to be considered for Reconciliation | Y-M-D H:I:S |
Ignore client_reference_id and pincode in request example
Success 200 Response Parameters
| Field | Description |
|---|---|
| invoice_id | Invoice ID generated by Safegold which would be seen in the Invoice for the particular transaction. |
Failure Parameters
| Status Code | Code | Code Description |
|---|---|---|
| HTTP Status 400 | ||
| 1 | Missing required information | |
| 2 | Invalid transaction ID | |
| 3 | User ID missing in transaction. | |
| 5 | Invalid Product Code | |
| 7 | User not registered | |
| 8 | Insufficient Gold balance |
Once the Confirm API is successful, SafeGold will generate an Invoice. The Invoice will be accessible to the Distributor through an Invoice API. The Distributor will pass the transaction ID on the Invoice API and will receive a Link to the Invoice in PDF Format.
(Note : Invoice API details mentioned above.)
Points to Remember
- The tx_id generated from the Redeem Gold Verify API needs to be passed and added as an response for the above API i.e Redeem Gold Confirm API.
- The tx_id is an unique id generated for every user for a particular transaction. Therefore you need to update the tx_idafter every new transaction.