Created
Created
The order was accepted but card fulfillment has not started yet.
GET
Get Order
Retrieve order details, fulfillment status, purchased cards, and error information for a previously submitted RequestId.
GET
/api/integration/v1.0/orders/:idFollow this flow to place your first order
View all steps1
Get catalog
Discover available products
2
Get accounts
Retrieve your accounts
3
Place order
Create an order for your customer
4
Get order
Check order status
5
Notification
Receive webhook updates
Get Order retrieves the order identified by the id path value. In Bamboo integrations, this value is the RequestId returned by Place Order and echoed in notification callbacks.
Use Get Order after you place an order, after a webhook callback, or when an order remains in a non-final status and you need the latest fulfillment result.
This endpoint requires Basic Auth using your API credentials.
Path parameter
Pass the RequestId or order identifier you want to inspect.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The RequestId / order identifier returned by Place Order and used to retrieve the full order details. |
Response specifications
The order response includes the parent order status plus item-level and card-level fulfillment data.
| Field | Type | Description |
|---|---|---|
orderId | number | Internal Bamboo order identifier. |
requestId | string | Client RequestId originally submitted in Place Order. |
items | array | Requested products returned as order items. |
productId | number | Product identifier that was ordered. |
productFaceValue | number | Face value issued for the product. |
quantity | number | Requested quantity for the order item. |
countryCode | string | Product country code. |
currencyCode | string | Product currency code. |
cards | array | Purchased cards linked to the order item. |
id | number | Internal Bamboo card identifier. |
serialNumber | string | Card serial number. |
cardCode | string | Card redemption code. |
pin | string | Card PIN when applicable. |
expirationDate | string | Card expiration timestamp when supplied by Bamboo. |
status | string | Card-level fulfillment status. |
status | string | Overall order status. |
createdDate | string | Timestamp when Bamboo created the order. |
total | number | Total amount charged to the account. |
errorMessage | string | null | Order-level failure information when Bamboo returns one. |
orderType | string | Order environment or order type returned by Bamboo. |
currency | string | Settlement currency for the charged total. |
Order statuses
Use the overall order status to decide whether to poll again or consume card data.
Processing
Processing
Bamboo is actively purchasing or finalizing the requested cards.
Pending
Pending
The order has not reached a final state yet. Wait and retry or rely on the notification callback before consuming the result.
Succeeded
Succeeded
All requested cards were fulfilled successfully.
Failed
Failed
The order did not complete successfully and no final fulfillment was produced.
PartialFailed
PartialFailed
At least one requested card succeeded and at least one failed.
Card statuses
Inspect card-level status to understand how each generated card was processed.
Paused
Paused
The card has been paused and should be checked again later.
Sold
Sold
The card was purchased successfully and its redemption details are available.
Failed
Failed
The card purchase failed.
Created
Created
The card record exists but Bamboo has not begun fulfillment.
Processing
Processing
The card is currently being fulfilled.
Examples
Full request and response examples for this endpoint.
Example request
Use this full request as the primary reference for client-side implementation.
# Generate token: echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64
curl --location 'https://api.bamboocardportal.com/api/integration/v1.0/orders/:id?id=71ac2817-e51a-438a-bb7b-5ffdda23603c' \
--header 'Authorization: Basic YOUR_BASE64_TOKEN' \
--header 'Accept: application/json'Example response
Use this sample payload to validate parsing, field mapping, and downstream handling.
200 OK
{
"orderId": 6779294,
"requestId": "71ac2817-e51a-438a-bb7b-5ffdda23603c",
"items": [
{
"brandCode": null,
"productId": 439685,
"productFaceValue": 10,
"quantity": 2,
"pictureUrl": null,
"countryCode": "BH",
"currencyCode": "USD",
"cards": [
{
"id": 24153984,
"serialNumber": "4005c08f-1aeb-4527-8eb0-ccd1c745f467",
"cardCode": "cb05747ed9fe497b92c80f10cf8406d7",
"pin": "392",
"expirationDate": "2025-05-16T04:36:35.3922677",
"status": "Sold"
},
{
"id": 24153985,
"serialNumber": "29744102-1e84-48e0-a440-8b3a5c04b4d2",
"cardCode": "7dffe979e54c49f692e7894eb91407d1",
"pin": "392",
"expirationDate": "2025-05-16T04:36:35.3922628",
"status": "Sold"
}
]
}
],
"status": "Succeeded",
"createdDate": "2024-05-16T04:36:35.3673422",
"total": 18.9401,
"errorMessage": null,
"orderType": "Sandbox",
"currency": "USD"
}Status handling guidance
These behaviors matter when you reconcile order totals and card outcomes.
Pending orders
If the order status is Pending, Bamboo has not reached a final answer yet. Retry the endpoint or wait for the notification callback.
Partial fulfillment
Not all cards may be purchased successfully. Inspect item-level and card-level statuses before assuming the order fully succeeded.
Failure details
errorMessage can contain order-level failure information, and failed cards may expose failure state even when other cards succeed.
Charged total
total indicates the amount charged to the selected account for the order.
Webhook fallback
If webhook delivery is delayed or unavailable, Get Order remains the source of truth for the final result.
Card release timing
Only release card codes to downstream systems after the relevant card status is final.
On this page
Try it out
Open the interactive API panel to test this endpoint with your own credentials.