Card Collection Integration Guide

Use hosted checkout when you want to accept card payments without handling raw card data directly.

What This Flow Does

The card collection flow creates a checkout session on your server, sends the customer to a hosted payment page, and then confirms the result through webhooks or follow-up verification.

Before You Start

  1. Make sure your API keys are active.
  2. Implement .
  3. Configure a webhook endpoint for transaction updates.
  4. Choose a unique reference for every payment attempt.

Integration Flow

1. Initialize the payment

Create a checkout session from your backend using:

POST /client/checkout/initialize

You will receive:

  • checkout_link
  • transactionRef
  • your original reference

2. Redirect the customer

Send the customer to checkout_link so they can complete payment on the hosted page.

3. Wait for the payment outcome

Use as the source of truth for completion status.

4. Verify when needed

If you need manual confirmation, polling, or reconciliation, call the verify endpoint after the checkout attempt.

Recommended Operational Rules

  1. Treat your own reference as the idempotent business identifier.
  2. Store transactionRef for support and reconciliation.
  3. Do not trust redirect success alone; always confirm by webhook or verify API.
  4. Display clear pending states because payment completion may take a short time to finalize.

Related Pages