Getting Started

2.1. Quick Start Guides

Once-off Payments

eg. E-commerce checkout, Once-off collections and Pay-by-link.

Steps to create an InstantPay payment 💸

  1. Get client token
  2. Generate Payment Request url
  3. Surface url to user to action the payment
  4. Handle the callback after the user has actioned the payment
  5. Poll for the final payment status and/or subscribe to receive a webhook upon payment completion

Linked account payments

eg. Wallet funding, Onboarding + payments, KYC + payments, and Recurring checkout.

Steps to create a LinkPay payment 🔗

  1. Get client token
  2. Generate payment authorization request url
  3. Surface url to user using the user authorization flow
  4. Get user token
  5. Initiate a payment using a user token
  6. Handle user interaction required during payment initiation
  7. Handle the final payment initiation response from the API, and query the status and/or optionally subscribe to receive a webhook upon payment completion

Financial data

eg. Affordability checks, Insurability checks, Risk assessment, Personal financial management, KYC + identity verification, Onboarding, Reconciliation and Balance checks.

Steps to query a user’s bank account 🏦

  1. Get auth code
  2. Get user token
  3. Query the GraphQL API
  4. Handle reauthorization for recurring data access use cases

Steps to query the client API 🧑🏿‍💻

  1. Get client token
  2. Query the GraphQL API