How Checkout Works

​

The Object Hierarchy

​

The Lifecycle

1. Your server calls POST /v3/checkout — returns a hosted payment page url
2. You redirect the customer to that url
3. Customer selects a payment method, completes authentication
4. Tazapay redirects customer back to your success_url or cancel_url
5. Tazapay sends webhooks — key events:
   • checkout.paid — payment_status changes to paid
   • payment_attempt.created — new payment attempt created
   • payment_attempt.succeeded — attempt succeeds
   • payment_attempt.failed — attempt fails
   • payment_attempt.processing — attempt moves to processing
   • checkout.expired — session expires before payment
   • checkout.created — session created

​

Checkout Status Fields

• active — session is open and the customer can still pay
• expired — session window closed before payment was completed

• unpaid — no payment received yet
• processing — customer completed all actions but Tazapay hasn’t confirmed funds yet; common for async methods like local bank transfer or wire transfer where intermediary banks take time to process
• paid — payment confirmed

​

Creating a Checkout Session

POST /v3/checkout
{
  "invoice_currency": "USD",
  "amount": 10000,
  "customer_details": {
    "name": "Andrea Lark",
    "email": "andrea@example.com",
    "country": "VN"
  },
  "transaction_description": "1 x T-shirt",
  "payment_methods": ["bank_push_vnd"],
  "success_url": "https://mystore.com/success",
  "cancel_url": "https://mystore.com/cancel",
  "webhook_url": "https://mystore.com/webhooks/tazapay",
  "reference_id": "mystore_order_00001"
}

{
  "status": "success",
  "data": {
    "id": "chk_cqd3nep5ct0u7aakeco0",
    "object": "checkout",
    "invoice_currency": "USD",
    "amount": 10000,
    "amount_paid": 0,
    "status": "active",
    "payment_status": "unpaid",
    "payment_methods": ["bank_push_vnd"],
    "url": "https://checkout-sandbox.tazapay.com/transaction/tGxhgHg5USrT3Gizxu-aL-GFF5FhyaCT4KHyXQXcxZE="
  }
}