Skip to main content

Query Issued Voucher

HTTP Request

POST /v5/broker/award/distribution-record

Request Parameters

ParameterRequiredTypeComments
accountIdtruestringUser ID
awardIdtruestringVoucher ID
specCodetruestringCustomised unique spec code, up to 8 characters
withUsedAmountfalsebooleanWhether to return the amount used by the user
  • true
  • false (default)
  • Response Parameters

    ParameterTypeComments
    accountIdstringUser ID
    awardIdstringVoucher ID
    specCodestringSpec code
    amountstringAmount of voucher
    isClaimedbooleantrue, false
    startAtstringClaim start timestamp (sec)
    endAtstringClaim end timestamp (sec)
    effectiveAtstringVoucher effective timestamp (sec) after claimed
    ineffectiveAtstringVoucher inactive timestamp (sec) after claimed
    usedAmountstringAmount used by the user

    Request Example

    POST /v5/broker/award/distribution-record HTTP/1.1
    Host: api.bybit.com
    X-BAPI-SIGN: XXXXXX
    X-BAPI-API-KEY: XXXXXX
    X-BAPI-TIMESTAMP: 1726112099846
    X-BAPI-RECV-WINDOW: 5000
    Content-Type: application/json
    Content-Length: 111

    {
    "accountId": "5714139",
    "awardId": "189528",
    "specCode": "demo000",
    "withUsedAmount": false
    }

    Response Example

    {
    "retCode": 0,
    "retMsg": "",
    "result": {
    "accountId": "5714139",
    "awardId": "189528",
    "specCode": "demo000",
    "amount": "1",
    "isClaimed": true,
    "startAt": "1725926400",
    "endAt": "1733788800",
    "effectiveAt": "1726531200",
    "ineffectiveAt": "1733817600",
    "usedAmount": "",
    }
    }