Buy Gift Cards

Buys one or more cards of a single product. Your gift card wallet is debited for the full amount when the order is created.

If a card fails, its price is refunded to your wallet and shown in refunded_amount. An order where at least one card was delivered is successful. Check each item's status to see which cards were delivered.

With sync false, the order returns as created and the cards are delivered in the background. Listen for the giftcard.successful or giftcard.failed webhook, then fetch the order to read the codes.

Body Params
string
required
length ≤ 100
Defaults to a1f3c9e2-docs-1

Your unique reference for this order. Reusing one is rejected, so retries are safe.

string
required
Defaults to amazon-us-25

The product code from Get Gift Card Products.

integer
required
1 to 10
Defaults to 1

Number of cards to buy.

boolean
Defaults to false

Set to true to wait for the result in this request. Otherwise the order is processed in the background and you get the result by webhook.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json