Create a checkout · PayProof Docs

POST/api/v1/checkouts/

Also available as POST /api/platform/checkouts/ with a dashboard JWT.

Body parameters

Field	Required	Notes
app_id	yes	Target app
product_id	yes	Must belong to the app
amount_etb	if dynamic	Omit for fixed products
customer_ref	no	Your user/order id
customer_email / customer_name	no	Shown on pay page
idempotency_key	no	Rejects duplicate creates
expires_in_hours	no	1–720; default from app settings
success_url / cancel_url	no	Override app defaults
metadata	no	Opaque JSON

Example

cURL

curl -X POST https://verifyitet.duckdns.org/api/v1/checkouts/ \
  -H "Authorization: Bearer pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": 1,
    "product_id": 6,
    "customer_ref": "order_1001",
    "idempotency_key": "order_1001",
    "success_url": "https://shop.example/thanks"
  }'

Response highlights

checkout.public_id — e.g. cs_…
checkout.reference_code — customer must include in transfer remark
payment_accounts[] — banks to display
pay_url — path on your PayProof website host