Skip to content

Payouts Overview

This document provides an overview of the payout functionality available through the PayOnUs API. Payouts allow you to transfer funds from your PayOnUs wallet to bank accounts or other payment destinations.

Available Endpoints

Bank Transfers

Transfer funds from your PayOnUs wallet to bank accounts.

Name Enquiry

  • Path: /api/v1/transfer-requests/name-enquiry
  • Method: POST
  • Description: Verify bank account details before initiating a transfer

For detailed documentation, see Bank Transfer Payouts Guide.

Initiate Bank Transfer

  • Path: /api/v1/transfer-requests/bank-transfer
  • Method: POST
  • Description: Transfer funds from your PayOnUs wallet to a bank account

For detailed documentation, see Bank Transfer Payouts Guide.

Fetch List of Transfer Requests / Payouts

  • Path: /api/v1/transfer-requests
  • Method: GET
  • Description: Retrieve a list of transfer requests with optional filtering

For detailed documentation, see Bank Transfer Payouts Guide.

Bulk Transfers

See Bulk Transfers

Wallets

See Wallets

Important Notes

  1. Always perform Name Enquiry before initiating a bank transfer to ensure the account details are valid
  2. Store both the merchantReference and onusReference for reconciliation purposes
  3. Monitor the status of your transfers using the Fetch List of Transfer Requests endpoint
  4. Ensure all amounts are in the correct currency format