Skip to main content
Orders are like invoices but without a formal invoice number or required due date — suited for e-commerce and retail checkouts. Try in API Reference: Create · List · Publish · Receipt

​
When to use

  • Storefront checkouts where a formal invoice is unnecessary
  • Payment links for one-off product purchases — see Hosted checkout

​
Lifecycle

Same source statuses as invoices: IDLE → ACTIVE → PROCESSING → PAID | CANCELED.

​
Typical flow

  1. POST /v1/orders/create
  2. POST /v1/orders/{order_id}/items/add
  3. PUT /v1/orders/publish/{id}
  4. Collect via hosted link or API-embedded session → execute → poll status
Or use Collect via checkout to skip manual party setup.

​
Create

curl -X POST "https://api.heydollr.app/v1/orders/create" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "counterparty_id": 15,
    "currency": "USD",
    "note": "Order #1042",
    "fee_bearer": "PAYER",
    "as_payment_link": true
  }'

​
List

curl "https://api.heydollr.app/v1/orders/list?currency=USD&status=ACTIVE" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Retrieve

curl "https://api.heydollr.app/v1/orders/retrieve/201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

curl "https://api.heydollr.app/v1/orders/retrieve/number/ORD-2025-0099" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Update

curl -X PUT "https://api.heydollr.app/v1/orders/update/201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note": "Updated order", "fee_bearer": "PAYEE"}'

​
Line items

curl -X POST "https://api.heydollr.app/v1/orders/201/items/add" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "T-Shirt", "currency": "USD", "qty": 2, "amount": 25.00}'

curl -X PUT "https://api.heydollr.app/v1/orders/201/items/5/update" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"qty": 3}'

curl -X DELETE "https://api.heydollr.app/v1/orders/201/items/5/remove" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Publish & cancel

curl -X PUT "https://api.heydollr.app/v1/orders/publish/201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

curl -X DELETE "https://api.heydollr.app/v1/orders/cancel/201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Receipt

curl "https://api.heydollr.app/v1/orders/receipt/201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

curl "https://api.heydollr.app/v1/orders/receipt/number/ORD-2025-0099" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
State transitions

Same as invoices: IDLE → ACTIVE → PROCESSING → PAID | CANCELED. Do not cancel during PROCESSING.
Last modified on June 23, 2026