Estimate order

The estimate endpoint is currently unsupported in the playground environment.

Authorizations

X-Api-Key

string

header

required

Your API key. See the API key page on details of how to generate and store your keys.

Headers

X-Api-Version

string

The dated version of the API, if not specified a default is used. See API versioning for more information.

Body

application/json

The details of the order to estimate.

Request for a price estimate for an order.

payment_method

Payment Method · object

required

Payment method for the order. Select the ACCOUNT_BALANCE you want to pay for the order from.

Show child attributes

payment_method.type

enum<string>

required

Account balance payment method.

Available options:

ACCOUNT_BALANCE

payment_method.currency

string

required

The currency of the account, represented by ISO 4217 currency codes. Check the currencies for a listing of supported currencies.

Example:

"USD"

items

OrderItemPriceRequest · object[]

required

List of order items for price estimation.

Required array length: 1 - 500 elements

Show child attributes

items.products

Multiple · object

required

Choose SINGLE if you want the end user to redeem the face value on a single specific product. Choose MULTIPLE if the end user can choose to spend the face value across multiple products.

Multiple
Single

Show child attributes

items.products.type

enum<string>

required

Multiple products. When more than one product code is provided.

Available options:

MULTIPLE

items.products.values

string[]

required

The codes for the products the end user can choose from when redeeming their payout link. All products must use the same currency.

Minimum array length: 2

Example:

["AMZ-US", "AIRBNB-US"]

items.face_value

number

required

Face value of the reward link.

Example:

10

Response

Response object for a order price estimate.

payment_method

Payment Method · object

required

Account balance payment.

Show child attributes

payment_method.type

enum<string>

required

Account balance payment.

Available options:

ACCOUNT_BALANCE

payment_method.currency

string

The currency of the account, represented by ISO 4217 currency codes. Check the currencies for a listing of supported currencies.

Example:

"USD"

items

OrderItemDiscount · object[]

required

List of order items with price and discount.

Show child attributes

items.products

Multiple · object

required

Choose SINGLE if you want the end user to redeem the face value on a single specific product. Choose MULTIPLE if the end user can choose to spend the face value across multiple products.

Multiple
Single

Show child attributes

items.products.type

enum<string>

required

Multiple products. When more than one product code is provided.

Available options:

MULTIPLE

items.products.values

string[]

required

The codes for the products the end user can choose from when redeeming their payout link. All products must use the same currency.

Minimum array length: 2

Example:

["AMZ-US", "AIRBNB-US"]

items.face_value

number

required

Face value of the reward link.

Example:

10

items.price

number

required

The price of the order item.

items.discount_multiplier

string

required

The discount multiplier used when ordering. 0 means no discount and 0.1 means 10% discount. The discount is applied on the price of the order item before any fees are applied.

Example:

"0.05"

items.currency

string

required

The currency of the product, represented by ISO 4217 currency codes. Please check the currency section in the guidelines for how to use this field.

Example:

"USD"

currency

string

required

The currency of the order, represented by ISO 4217 currency codes. Please check the currency section in the guidelines for how to use this field.

Example:

"USD"

total_discount

number

required

Total discount on the entire order.

total_price

number

required

Total price of the entire order.

transaction_detail

TransactionDetail · object

A mapping of the subtotal of the order using the payout currency as a key.

Show child attributes

transaction_detail.{key}

TransactionDetailEntry · object

A subtotal of the value purchased and associated fees and data about the transaction.

Show child attributes

transaction_detail.{key}.value

string

required

The total value purchased of a payout link currency.

Example:

"10.00"

transaction_detail.{key}.fx

TransactionDetailFxDetails · object

Provides details on fx conversion for an order transaction detail. Present when the payment method currency is different from the transaction detail currency.

Show child attributes

transaction_detail.{key}.fx.rate

string

required

The FX rate received for the transaction between the payout currency and payment currency.

Example:

"1.234"

transaction_detail.{key}.fx.rate_symbol

string

required

The currency pair associated with the FX transaction.

Example:

"GBPUSD"

transaction_detail.{key}.fx.fee

Fee · object

required

The fee charged for making this transaction.

Show child attributes

transaction_detail.{key}.fx.fee.value

string

required

The value of the fee.

Example:

"0.00"

transaction_detail.{key}.fx.fee.currency

string

required

The currency of the fee.

Example:

"USD"

Example:

{ "USD": { "value": "10.00", "fx": null } }

Reference

Orders

Products

Balance

Utility

Webhooks

Authorizations

Headers

Body

Response