GET /v2/client/redeem-rewards/history
Header bearer token

Get User Payout History returns the payout history of the user.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attribute Show data attribute object
      • items array[object] Required
        Hide items attributes Show items attributes object
        • id integer Required

          The unique identifier for the payout, used for routing to payout details page.

        • reward_amount string Required
        • reward_name string Required
        • image_url string Required
        • categories array[string] Required
        • created_at string Required

          The date the user payout request is created.

        • status string Required

          Status of the payout request:

          • pending: The payout is pending processing or review
          • completed: The payout has been successfully completed
          • cancelled: The payout was cancelled/refunded
          • failed: The payout failed after retries (e.g., processor error, max attempts reached)

          Values are pending, completed, cancelled, or failed.

        • amount string Required
        • status_updated_at string

          The timestamp of the payout request was last updated.

        • estimated_delivery integer

          The estimated delivery time in seconds for the payout to be completed

        • currency string

          The currency of the redemption (e.g., USD, EUR).

        • credentials array[object] Required
          Hide credentials attributes Show credentials attributes object
          • label string Required
          • value string Required
          • type string Required

            Values are text, url, barcode, or date.

          • credential_type string Required
  • 404

    User history not found

GET /v2/client/redeem-rewards/history 
curl \
 --request GET 'https://api.bitlabs.ai/v2/client/redeem-rewards/history' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "items": [
      {
        "id": 123,
        "reward_amount": "1.23",
        "reward_name": "card-1",
        "image_url": "image.url",
        "categories": [
          "string"
        ],
        "created_at": "2022-01-01T00:00:00Z",
        "status": "pending",
        "amount": "1.23",
        "status_updated_at": "2022-01-01T00:00:00Z",
        "estimated_delivery": 86400,
        "currency": "USD",
        "credentials": [
          {
            "label": "Redemption Link",
            "value": "https://www.amazon.com",
            "type": "text",
            "credential_type": "redemptionUrl"
          }
        ]
      }
    ]
  }
}