Get Order
Retrieve information about an order, including payment status, customer details, and line items. Orders are created when a payment link is successfully paid.Authentication
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Order ID (e.g., ord_abc123xyz) |
Request
Response
Response Fields
See Order Object for complete field descriptions.Examples
Basic Retrieval
Check Order Status
Fulfillment Check
Extract Shipping Information
Order Status
| Status | Description |
|---|---|
pending | Order created, awaiting payment |
processing | Payment being processed |
completed | Payment successful, order complete |
failed | Payment failed |
cancelled | Order cancelled |
Payment Status
| Status | Description |
|---|---|
pending | Payment not yet attempted |
authorized | Payment authorized (not captured) |
captured | Payment captured successfully |
failed | Payment failed |
refunded | Payment refunded (full or partial) |
disputed | Payment disputed/chargebacked |
Use Cases
Order Fulfillment Workflow
Customer Service Portal
HSA/FSA Amount Tracking
Refund Eligibility Check
Errors
| Status Code | Error Code | Description |
|---|---|---|
| 401 | unauthorized | Invalid or missing API key |
| 404 | not_found | Order not found |
| 429 | rate_limit_exceeded | Too many requests |
Best Practices
Check Payment Status
Verify
payment_status === 'captured' before fulfillingUse Webhooks
Don’t poll this endpoint. Use webhooks for order updates.
Validate Before Actions
Always check order status before refunds or fulfillment
Store Order IDs
Link orders to your internal system via metadata
Related Endpoints
- List Orders - GET /v2/orders
- Create Refund - POST /v2/refunds
