API Reference

Redeem Product

Weight: 1

Request Parameters


Parameter

Type

Required

Example Value

Description

productId

STRING

Y

Product ID

unit

STRING

C

Up to 2 decimal places

percent

STRING

C

The proportion of the total position, 0.50
— ratio per unit (0.50 = 50%)
— precision: 2 decimal places
— must be validated to be > 0 and ≤ 1.00.

clOrderId

STRING

C

Client Order Id A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 16 characters.
Idempotent, non-repeatable

timestamp

LONG

Y

1691567587389

Timestamp

signature

STRING

Y

Response Content


ParamExampleTypeDescription
orderIdSTO773500357380034560STRINGorderId generated by Hashkey
clOrderIdSTRINGorderId defined by customer
Language
Credentials
Header
Click Try It! to start a request and see the response here!