Product schema

Property Type Description

id

string

name

string

Name of the product

description

string

Detailed description of the product.

category

string

The category of the product

Category	Description
`ach`	Bank transfer to the recipient
`charity`	Donations to a charity
`instant_debit_transfer`	Instant debit transfer to the recipient
`merchant_card`	A gift card for a certain merchant (e.g. Amazon)
`paypal`	Payout via PayPal
`venmo`	Payout via Venmo
`visa_card`	Payout in form of a Visa debit card
`cash_app`	Payout via Cash App
`international_bank`	Bank transfer to recipients outside of the US
`wallet`	Payout to a digital wallet (e.g. GCash, MoMo)

subcategory

string

Additional classification for the product. Only applicable to products with a category of merchant_card. Possible subcategories:

beauty_and_health
digital_financial_services
electronics
entertainment
fashion
food_and_drink
general_merchandise
grocery_and_supermarkets
home_and_living
mobility_and_fuel
sports_and_outdoor_gear
travel_and_hospitality

disclosure

string

Legal disclosures for this product. Can be in HTML format.

skus

array

Products are restricted in their usage based on the amount of the reward. The skus array defines bands of denominations in which this product may be used for payouts.

The skus apply to orders in any of the product's currency_codes.

Show array item type

Property	Type	Description
`min`	number	Minimum amount this product supports, in `currency_code`.
`max`	number	Maximum amount this product supports, in `currency_code`.
`currency_code`	string	Currency of `min` and `max`.

currency_codes

array string

Available currencies for this product

countries

array

List of countries in which this product is available to recipients.

Show array item type

Property	Type	Description
`abbr`	string	ISO 3166 country code

images

array

List of product images associated with this product (e.g. logos or images of the gift cards)

Show array item type

Property	Type	Description
`src`	string uri	URL to this image
`type`	string	Type of image
`content_type`	string	The MIME content type of this image

usage_instructions

string

Instructions for how to use the product, if applicable. Mostly used for products with a category of merchant_card.

documents

object

URLs and files related to product documentation.

Show object properties

Property	Type	Description
`cardholder_agreement_pdf`	string uri	URL to the cardholder agreement PDF file.
`cardholder_agreement_url`	string uri	URL to the cardholder agreement web page.
`privacy_policy_url`	string uri	URL to the privacy policy web page.