Skip to main content
The Payment API allows you to create and retrieve payment transactions associated with your account. This API enables:
  • Creating payment links to collect funds
  • Retrieving individual payment details
  • Listing outgoing payments
  • Listing incoming paymentsd

​
What This API Provides

The Payment API allows your integration to:
  • Generate secure payment links for wallet-based collections
  • Retrieve a payment record by its unique identifier
  • List payments sent from the user account
  • List payments received into the user account
Each payment record includes:
  • Unique payment ID
  • Amount (USD)
  • Payment status
  • Payer and payee details
  • Timestamps
  • System-generated metadata

​
Available APIs

Create Payment Link

Generate a secure payment link to collect funds.

Get Payment

Retrieve a specific payment using its ID.

List Sent Payments

Retrieve all outgoing payments from the user account.

List Received Payments

Retrieve all incoming payments to the user account.

​
Typical Integration Flow

1

1. Create a payment link

Call Create Payment with the amount and optional description to generate a shareable payment URL.
2

2. Share the payment link

Send the generated URL to the payer for completion.
3

3. Track payment status

Use Get Payment to retrieve transaction details and monitor status updates.
4

4. Reconcile transactions

Use List Sent Payments and List Received Payments for reporting and reconciliation.

​
Pagination

The list endpoints require:
  • rows_per_page (10, 20, 50, or 100)
  • page_no (starting from 1)
Responses include:
  • records
  • totalRecords
  • queryGeneratedTime
Use pagination to efficiently handle large transaction volumes.

​
Best Practices

  • Always validate amounts before submission.
  • Store the returned payment_id for reconciliation and status tracking.
  • Use Get Payment to confirm final transaction state.
  • Implement proper pagination handling for production environments.
  • Securely store API credentials and never expose them client-side.