Guides

End-to-end steps from credentials to fulfillment, aligned with the Kollect backend behavior.


Phase 1 — Account and configuration

  1. Complete merchant onboarding and KYB as required by your program.

  2. Configure a deposit wallet on the merchant form or user profile so Smart Contract payout initiation can resolve a payee address.

  3. Create API key + secret (access token) and store them in a secrets manager.

  4. (Recommended) Register webhookUrl via profile APIs and save the signing secret.


Phase 2 — Create payment (S2S)

  1. Build the JSON body per Create payment URL.

  2. Generate X-Timestamp (Unix seconds) within server clock skew.

  3. Compute X-Signature over the raw body per Request signing.

  4. Send X-Idempotency-Key unique to the order or checkout session.

  5. On 200, persist paymentId, invoiceId, and invoiceNumber in your system.


Phase 3 — Customer payment

  1. Deliver paymentUrl to the customer (email, SMS, redirect, or in-app browser).

  2. The customer completes payment on the hosted Kollect experience.

Kollect may also send invoice-related email per product configuration.


Phase 4 — Settlement notification

  1. Smart Contract notifies Kollect at the internal webhook endpoint.

  2. Kollect updates invoice and payment records.

  3. For kollect-server payments with an active webhook, Kollect POSTs to your URL with X-Kollect-Signature.


Phase 5 — Your fulfillment

  1. Verify the signature as documented.

  2. Upsert order state by paymentId (idempotent).

  3. Return 2xx quickly; run heavy work in a queue.


Reconciliation

Because outbound webhook delivery has no automatic retries, maintain a reconciliation process (scheduled job or support tools) that can compare your orders against Kollect state if needed.


Last updated

Was this helpful?