Skip to main content
POST
Create a gift card order

Authorizations

x-api-key
string
header
required

Your API key, starting with ct_key_.

x-api-secret
string
header
required

Your API secret, starting with ct_secret_.

Body

application/json
orderDate
string<date>
required

YYYY-MM-DD.

Example:

"2026-10-01"

retailer
string
required

Store name, such as Best Buy.

Example:

"Best Buy"

orderNumber
string
required

Must be unique across your orders. Surrounding spaces are trimmed.

Maximum string length: 100
Example:

"BBY01-123456"

platform
string
required

Resale platform: aligned_incentives, card_center, card_cash, qgcg, or one of your custom platforms.

Maximum string length: 100
Example:

"card_cash"

status
enum<string>
required
Available options:
purchased,
submitted,
partially_paid,
issue,
paid,
cancelled
Example:

"purchased"

orderLineItems
object[]
required
Required array length: 1 - 10 elements
orderTime
string

HH:mm or HH:mm:ss, in your local time.

Example:

"14:30"

shipping
integer
default:0

Shipping in cents.

Required range: x >= 0
tax
integer
default:0

Tax in cents.

Required range: x >= 0
Example:

4800

discount
integer
default:0

Discount in cents.

Required range: x >= 0
creditCardId
string

ID of one of your credit cards, from List credit cards.

subCreditCardId
string

ID of one of that card's subCards.

cardEarnRate
number
default:0

Points or cashback multiplier, e.g. 2 for 2x or 1.5 for 1.5x. Up to three decimal places; more are rounded.

Required range: x >= 0
retailerAccount
string

The retailer account the order was placed with, such as its email.

Maximum string length: 100
notes
string
Maximum string length: 1000
redemptionCodes
object[]

Gift card codes, vouchers, or credits for the order. Write-only: responses don't include them. Your plan's per-order limit applies.

Maximum array length: 50

Response

The created order.

data
object