Skip to Content
Developers
Redemptions

List redemptions

GET
/redemptions

Redemptions reported with this key's mode, most recently updated first.

Authorization

integrationKey
headerAuthorizationBearer <token>

A brand integration key, created by an Owner or Admin in Brand Settings › Integrations and shown once. endvr_ik_test_… keys write test data that is never billed; endvr_ik_live_… keys are live.

Query Parameters

proDealId?string
code?string
orderId?string
updatedSince?string

Only redemptions updated at or after this time.

Formatdate-time
cursor?string

The nextCursor of the previous page. Omit for the first page.

limit?integer

Items per page.

Range1 <= value <= 100
Default50

Response Body

A page of redemptions.

application/json
  1. response
data*array<>
nextCursor*|

Pass it as cursor for the next page; null on the last page.

Example Request
curl -X GET 'https://api.endvr.io/v1/redemptions'
Example Response
{  "data": [    {      "code": "string",      "orderId": "string",      "orderAmount": "129.90",      "currency": "USD",      "processedAt": "2019-08-24T14:15:22Z",      "status": "paid",      "updatedAt": "2019-08-24T14:15:22Z",      "refunds": [        {          "amount": "129.90",          "processedAt": "2019-08-24T14:15:22Z"        }      ],      "id": "string",      "proDealId": "string",      "mode": "test",      "receivedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}