Get redemption orders from a redemption configuration.

get

https://example.com/servicing/api/redemptions/{redemptionId}/orders

Allow an token agent or token holder to retrieve redemption orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

redemptionId

string

required

Query Params

limit

number

≤ 1000

Defaults to 20

Limit of results to return in one call

offset

number

Defaults to 0

Offset to return results from

sortBy

string

enum

Defaults to created_at

Sort by field expression

sortDirection

string

enum

Defaults to DESC

Sort direction expression

Allowed:

status

string

enum

Filter by order status

holderName

string

Filter by holder name

holderId

string

Filter by holder id

holderEmail

string

Filter by holder email

paymentCurrency

string

Filter by payment currency

afterDate

string

Filter orders that were created after a date (in ISO format)

beforeDate

string

Filter orders that were created before a date (in ISO format)

Responses

400

Missing redemptionId!

Redemption order operation failed due to invalid data.

Redemption operation failed due to invalid data.

401

Unauthorized.

403

Token not manageable with this authentication.

404

Redemption not found.

Token not found.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Redemption orders retrieved.