API Reference

PAAS Cash Withdrawal API

The purpose of this api is to allow a registered merchant or platform (Account) to initiate automated cash disbursements of funds to end users (Customers) in a secure, traceable, and auditable manner.

The PAAS Cash Withdrawal API enables registered merchants or platforms (Accounts) to generate secure cashout references for their end users (Customers), allowing them to withdraw physical cash at authorized stores or agents.

🔁 How It Works

🔹 1. Account Setup

Each merchant or partner is registered as an Account in the PAAS system, with its own wallet and balance. Funds in this balance can be disbursed to customers via cash withdrawal.

  • Each Account has:
    • A unique identifier
    • A cashout balance (see Get Account Data)
    • Permissions to manage Customers and cashout references

🔹 2. Customer Registration

Before an individual can receive a cashout reference, they must be registered as a Customer under an Account.

✅

A Customer represents the recipient of funds and is linked to one Account only.

Creating a Customer is a one-time action and is required for linking:

  • Cashout references
  • CLABE accounts
  • Cash-in aliases

🔹 3. Create Cashout Reference

Once a Customer is registered, the Account can initiate a cashout reference by calling the Create Reference endpoint with:

  • Customer ID
  • Amount

This generates a unique reference code that the Customer can present at supported stores or agencies to withdraw the specified amount.

  • On successful withdrawal, the reference is marked as completed
  • The Account's balance is reduced accordingly

🔹 4. Stores & Agents

Customers can take their reference to any supported location returned by the Get Stores endpoint. Each store can validate the reference, verify identity (if required), and dispense the cash.

📊 API Flow Summary

[Account] ──▶ [Create Customer] ──▶ [Create Reference]
     │                               │
     ▼                               ▼
[Get Account Data]              [Get Reference]
                                    │
                                    ▼
                                [Stores / Cashier]
                                    │
                             Customer withdraws cash
                                    │
                                    ▼
                          Reference marked as completed
                          Balance subtracted from Account

🧪 Postman Collection

We provide a ready-to-use Postman collection to make testing and integration fast and simple.

👉 Download Collection: PAAS Cashout Postman Collection