Submit a single payout request. The transactionReference must be a concatenation of [6-digit partner code] + [YYYYMMDD date in GMT+1] + [reference string], with a minimum total length of 30 characters.
| Field | Type | Req | Description |
|---|---|---|---|
transactionReference | string | ● | Unique payout reference in the format [6-digit partner code] + [YYYYMMDD date in GMT+1] + [reference string]. Minimum length is 30 characters. |
paymentCurrency | string | ● | Payout currency. Example: GHS. |
paymentAmount | string | ● | Payout amount as a string. |
paymentNarration | string | ● | Narration to attach to the payout. |
recipientInformation | object | ● | Recipient account, identity, phone, address, and ISO country details. |
recipientInformation.recipientAccountNumber | string | ● | Recipient account number for the destination bank or wallet rail. |
recipientInformation.recipientAccountName | string | ● | Recipient account name. |
recipientInformation.recipientFinancialInstitutionCode | string | ● | Recipient bank or financial institution code. |
recipientInformation.recipientPhoneNumber | string | ● | Recipient phone number. |
recipientInformation.recipientAddress | string | ● | Recipient address. |
recipientInformation.recipientISOCountryCode | string | ● | Recipient ISO country code. Example: GHA. |
senderInformation | object | ● | Sender identity and KYC information. |
senderInformation.senderName | string | ● | Sender full name. |
senderInformation.senderEmailAddress | string | ● | Sender email address. |
senderInformation.senderPhoneNumber | string | ● | Sender phone number. |
senderInformation.senderIdentificationNumber | string | ● | Sender identification number. |
senderInformation.senderAddress | string | ● | Sender address. |
senderInformation.senderISOCountryCode | string | ● | Sender ISO country code. Example: GHA. |
A submission summary showing whether the payout was accepted or rejected, plus the responseCode for the transaction reference. See the example response in the panel.