🇳🇬Payout Nigeria

This endpoint allows you to initiate a payout transaction to Nigeria with YoguPay . Payouts are done via Bank Transfer.

Create a Payout to Nigeria

POST /auth/payout

Headers

Name	Value
Content-Type	application/json
Token	token

Body

The required fields for this request are marked *

Name	Type	Description
bank_account_number*	string	The bank account number of the recipient.
bank_code*	string	The of the recipient's bank
country_code*	string	The of the recipient
source_currency*	string	The currency in which the funds will be deducted from.
source_amount*	number	The amount the recipient will receive .
purpose_of_funds	string	The purpose of the funds transfer
recipient_name*	string	The name of the recipient.
msisdn	string	The mobile number of the recipient.
recipient_email	string	The email address of the recipient.
payment_reference*	string	A reference unique to your system
collection_network*	string	The collection network for the payout
channel*	string	The channel through which the payout will be made.

Request & Response

Request

{
    "bank_account_number": "0112424236",
    "country_code": "NG",
    "source_currency": "NGN",
    "source_amount": "100",
    "purpose_of_funds": "School Fees",
    "recipient_name": "John Doe",
    "bank_code": "058",
    "msisdn": "",
    "recipient_email": "[e-mail]",
    "payment_reference": "johnngntest1",
    "collection_network": "BANKTRANSFER",
    "channel": "BANKTRANSFER"
}

Successful Response

{
    "status": 1,
    "trx_code": "ECEM8LGFEO",
    "message": "Success You have successfully initiated a transfer. Please wait a few minutes as we complete this for you"
}

Failed Response

{
  "error": "Invalid request"
}