🇬🇭Payout Ghana

This endpoint allows you to initiate a payout transaction to Ghana with YoguPay . Payouts are done via Mobile Money.

Create a Payout to Ghana

POST /auth/payout

Ghana Payout

Headers

Name	Value
Content-Type	application/json
Token	token

Body

The required fields for this request are marked *

Field	Type	Description
bank_account_number	string	The bank account number of the recipient.
bank_code	string	The bank code of the recipient's bank
country_code*	string	The of the recipient
source_currency*	string	The in which the funds will be deducted from.
dest_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": "",
    "country_code": "GH",
    "source_currency": "GHS",
    "source_amount": "10",
    "purpose_of_funds": "School Fees",
    "recipient_name": "John Doe",
    "bank_code": "",
    "msisdn": "233248284561",
    "recipient_email": "[e-mail]",
    "payment_reference": "johnkghstest1",
    "collection_network": "MOBILEMONEY",
    "channel": "MOBILEMONEY"
}

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"
}

Unsuccessful Response

{
    "status": "0",
    "message": "Cannot complete this transaction, please contact admin"
}