Skip to main content

GET Coupon

/api/v1/coupon/<COUPON_ID>

This call responds with a coupon data for a specified COUPON_ID provided within a path. If coupon is not found, 404 is returned. For a spent coupon

Response contains the following data:

  1. code: Success or failed.
  2. coupon: a coupon structure with the following data:
    1. id: coupon ID
    2. rtrx_limit: a upper limit of the transaction fee that can be covered with this coupon
    3. valid_to: coupon expiration time
    4. address: when coupon is spent, this field is returned and contains address of the spender
    5. tx_id: when coupon is spent, this field is returned and contains transaction hash that coupon was applied for
    6. rtrx_spent: when coupon is spent, this field is returned and contains exact amount of TFN (former RTRX) that was charged, remaining amount is credited back to an account of the entity that created a coupon.
  3. balance_on_coupons_rtrx: total balance that is currently locked on all issued and not yet spent coupons.
  4. balance_rtrx and balance_rusdt: current Transatron account balances in TFN (former RTRX) and TFU (former RUSDT).

Example of response:

{
    "code": "SUCCESS",
    "coupon":
    {
        "valid_to": 1756462987130,
        "id": "9cf04de1-1f2a-47b5-9e5c-04b51b0f67a2",
        "rtrx_limit": 7925001
    },
    "balance_on_coupons_rtrx": 7925001,
    "balance_rtrx": 120548547,
    "balance_rusdt": 69399295
}