Verify Payout/Withdrawal
The withdrawal process for cash to bank.
GET /verify-payout
This endpoint verifies the status of a payout (i.e., a bank transfer) associated with a previously initiated withdrawal. It accepts the transaction reference, tx_ref, and returns a sanitized response with key information
Headers
Name
Value
Content-Type
application/json
Authorization
Bearer <api_key>
Body
Name
Type
Description
tx_ref
string
The transaction reference used to identify the payout record.
Example
{
"pvRef": "PV-E8823747",
"txHash": "0x2234a21626a407ae1a065dde7331a361114139c88077978811089f40f7323f90"
}{
"status": 200,
"message": "Withdrawal processed successfully",
"data": {
"pvRef": "PV-E8823747",
"txHash": "0x2234a21626a407ae1a065dde7331a361114139c88077978811089f40f7323f90",
"txStatus": "PENDING",
"receiptStatus": 1,
"transfer": {
"status": "success",
"data": {
"id": "TR-AB12CD34",
"reference": "TR-AB12CD34",
"currency": "NGN",
"amount": 100,
"narration": "Withdrawal transfer for ENSC conversion",
"debit_currency": "NGN",
"account_bank": "058",
"account_number": "0343761669",
"beneficiary_name": "Resolved Account Name",
"meta": [
{
"transactionType": "withdrawal",
"originalReference": "PV-E8823747"
}
]
}
},
"amount": 100,
"assetType": "ENSC",
"payout": {
"accountName": "Resolved Account Name",
"bank": "058",
"accountNumber": "0343761669"
}
}
}Common Error Responses
{
"status": 400,
"error": "Invalid Request",
"message": "Both pvRef and txHash are required"
}{
"status": 404,
"error": "Transaction Not Found",
"message": "No transaction record found for the provided pvRef and entity"
}{
"status": 400,
"error": "Invalid Asset",
"message": "Only ENSC asset type is allowed for withdrawal"
}{
"status": 400,
"error": "Invalid Transaction Hash",
"message": "Transaction not found on blockchain"
}{
"status": 400,
"error": "Transaction Failed",
"message": "The blockchain transaction did not succeed"
}{
"status": 400,
"error": "Bank Transfer Failed",
"message": "Unable to initiate bank transfer"
}Last updated