API Reference

Callback Integration

The system will automatically send a callback to the specified webhook URL whenever the status of your transaction changes. The callback contains important information such as the current status, a timestamp, and relevant transaction details (e.g., reference ID, amount, and currency).

{
  "status" : "payment_created",
  "created_at" : "2006-01-02T15:04:05.999999999Z07:00",
  "data" : {
    "reference_id": "XXX",
    "invoice_currency": "USD",
    "amount": 1000.00
  }
}

    

Possible Statuses:

The transaction status will update over time based on the customer's interaction and payment process. Below are the possible statuses you can expect to receive:

  • payment_created: Sent when the client clicks on "pay" and completes the initial payment workflow.
  • payment_started: Sent after the client completes the workflow when using a non-instant payment method (such as a wire transfer).
  • payment_finalized: Sent once the payment has been received and the transaction is fully settled.
  • payment_failed: Sent if there was an issue with the payment method (e.g., credit card declined). This is a final status indicating the transaction failed.
  • payment_not_approved: Sent if the user is already a wallet customer and the payment was refused by the approval process. This is a final status indicating the transaction failed.

Why Use Callbacks?
Callbacks are essential for keeping your application synchronized with the transaction's status in real time. Instead of continuously polling the API to check for updates, your application can react immediately to status changes such as payments being completed, canceled, or declined, enabling a smoother user experience and more reliable transaction handling.