Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Transfers

Initiate A Transfer

Send funds from your Payaza account to a bank account or mobile wallet. Supports single and bulk payouts. See the full Transfers guide for a step-by-step walkthrough.

Before you call this endpoint:

  • Your server IP address must be whitelisted on the Payaza Dashboard under Settings → Developers → IP Whitelisting (live environment only).
  • Your transaction PIN must be set up on the dashboard under Settings → Profile → Security.
  • The account_reference is retrieved from the View Payaza Account Details endpoint.
  • Bank codes for each supported country are available <a href="https://docs.google.com/spreadsheets/d/1ZvJBIIHMlqIy0pRYDHL-4PYFpHWXgIYV3lZFSgseV7o/edit#gid=790657640" target="_blank">here</a>
  • Cross-border payouts outside Nigeria are not enabled by default — email support@payaza.africa to activate this on your account.
post/payout-receptor/payout

Request body

OR

Example request

{
  "transaction_type": "nuban",
  "service_payload": {
    "payout_amount": 100,
    "transaction_pin": 490736,
    "account_reference": "1010000009",
    "currency": "NGN",
    "country": "NGA",
    "payout_beneficiaries": [
      {
        "credit_amount": 100,
        "account_number": "9207067319",
        "account_name": "John Doe",
        "bank_code": "000013",
        "narration": "Test Payment",
        "transaction_reference": "TD93001234",
        "sender": {
          "sender_name": "Jane Doe",
          "sender_phone_number": "01234595",
          "sender_address": "123, Ace Street",
          "dial_code": "237"
        }
      }
    ]
  }
}

Response

Transfer initiated successfully

OR