Create a new retail order entry
POST/retail_orders
note
This endpoint is a work in progress and may change before being stabilized.
Create a new order entry to purchase a giftcard product in a physical retail location. This will not actually trigger the purchase and is only responsible for preliminary checks and verification.
Note: The request must include an Idempotency-Key header to ensure that duplicate requests are not processed multiple times.
Request
Responses
- 201
- 400
- 500
Retail Order entry created and processed successfully
Bad Request
Internal Server Error
Error Codes
| HTTP Status | Class | Code | Description |
|---|---|---|---|
| 400 | invalid_request | invalid_body_parameters | Invalid body parameters with details in the fields attribute |
| 400 | invalid_state | product_not_available | The given product does not exist or is disabled for the client |
| 400 | idempotency | invalid_idempotency_key_header | The Idempotency-Key header is invalid or missing |
| 400 | idempotency | reused_idempotency_key | The Idempotency-Key has already been used for a previous request |
| 403 | forbidden | insufficient_available_balance | The client does not have sufficient available balance to place the order |
| 403 | forbidden | store_limit_exceeded | The requested amount exceeds the maximum allowed value for the store |
| 403 | forbidden | terminal_limit_exceeded | The requested amount exceeds the maximum allowed value for the terminal |
| 403 | forbidden | receipt_limit_exceeded | The requested amount exceeds the maximum allowed value for the receipt |
| 403 | forbidden | product_limit_exceeded | The requested amount exceeds the maximum allowed value for the product |
| 403 | forbidden | processing_declined | The order processing was declined |
| 403 | forbidden | fraudulent_processing_declined | The order processing was declined due to fraudulent behaviour. |