This endpoint will let the Distributor create a redeem gold transaction. This will return the tx_id, which has to be passed to the next endpoint to confirm the transaction.


Distributor will pass the unique ID of the product that the customer wants to ask for delivery and the address of the customer to which the gold product would be delivered to.


URL Params

Parameter

Value

user_id

[integer]
Example: user_id = 2


Request Parameters

Field

Description

Data Type

Length

product_code

Product ID of the Product. (Available as ​ id ​ in the Gold Products API).

Integer

Autoincremental ID generated by SafeGold system

name

Name of the customer to whom the product would be delivered
(Not compulsory)

String

255

phone_no

Mobile number of the customer to whom the product would be delivered.
(Not compulsory)

Numeric

10

address.state

State of the Customer

String

255

address.city

City of the Customer

String

255

address.pincode

Pincode of the Customer

Numeric

6

address.address

All details of the Address needs to be sent in this parameter

String

Text

address.landmark

Optional

String

255


Success 200 Response Parameters

Field

Description

tx_id

Unique Transaction ID provided by Safegold which will be passed to the next endpoint to confirm the transaction.

estimated_dispatch

Estimated days for Delivery for the particular product.

price

Minting Cost of the particular product.


Failure Parameters

Status Code

Code

Description

HTTP Status

1

Missing required information

2

Invalid Product Code

4

Product out of Stock

5

User not registered

7

Insufficient Balance


SafeGold will recheck the Pincode sent by the Distributor. SafeGold will also validate whether the User has sufficient Gold Balance. If the validations match, SafeGold will create a transaction ID and send it as a response to the Distributor.

Post the success of the Redeem Verify API​, ​the Redeem Gold Confirm API will be called by the Distributor bypassing the User ID in the URL and by sending transaction ID as a request.

📘

Points to Remember

  1. Sometimes there can be a case when the Product ID mentioned as default is out of stock. In that case select another product id from the Gold Products Catalog from the response of Gold Products API
Language
Response
Click Try It! to start a request and see the response here!