List All Redemptions

List all available redemptions based on status and/or payment type

Response Details

Attribute

Type

Description

paymentID

string

Redemption identifier

type

string

Type of redemption. Refer to Redemption Payment Methods for all options.

amount

number

Amount of redemption

currency

object

Currency object

currency.name

string

Currency of redemption. Follows the ISO 4217 three character currency.

currency.description

string

Description of currency

status

object

Object provides details about the status of the redemption

status.id

number

Status identifier. Refer to Redemption Statuses for all options.

status.message

string

Description of status

status.updated

string

Timestamp of last update to redemption

userDetails

object

Object provides user details about redemption owner

userDetails.userID

string

User identifier of redemption owner

userDetails.username

string

Username of redemption owner

userDetails.firstName

string

First name of redemption owner

userDetails.lastName

string

Last name of redemption owner

userDetails.email

string

Email of redemption owner

accountDetails

object

Object provides account details about redemption owner

accountDetails.accountID

string

Account identifier of redemption owner

accountDetails.accountNo

string

Account number of redemption owner

accountDetails.accountType

object

Object provides details on the type of account

accountDetails.accountType.name

string

Type of account

accountDetails.accountType.description

string

Description of type of account

accountDetails.accountManagementType

object

Object provides details on account management type

accountDetails.accountManagementType.name

string

Account management type

accountDetails.accountManagementType

string

Description of account management type

Language