Create a checkout link
create_checkoutCreate a signed, single-purpose checkout link (30-minute expiry) for one gift to one country. The schema has no recipient fields on purpose: name, address, phone, delivery details and payment are collected on the secure page. Show the returned summary and get the user's explicit confirmation before sharing the link. Use the same idempotency_key when retrying.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locale | No | Language of the conversation with the user (e.g. he-IL, fr-FR). Localizes content and messages; prices and availability are unaffected. The checkout page opens in this language. | |
| country | Yes | Destination country, ISO-3166 alpha-2. | |
| gift_id | Yes | gift_id from search_gifts. | |
| quantity | No | Always 1 in v1. | |
| delivery_date | No | Requested delivery date YYYY-MM-DD; omit for as-soon-as-possible. | |
| gift_card_text | No | Card message (≤180 chars) if the user already gave one. | |
| idempotency_key | Yes | Client-generated key; retries with the same key return the same link. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present only when the call failed | |
| locale | No | BCP-47 locale the texts are localized to | |
| summary | No | ||
| expires_at | No | ||
| checkout_url | No | Single-purpose secure checkout link on checkout.giftroam.com (30-minute expiry) | |
| display_text | No | Human-readable one-line summary of the result |