Skip to main content
Use this endpoint to confirm whether a bank transfer is still processing, successful, failed, or reversed.
Check the transfer status before marking a payout as complete in your system.

Endpoint

GET /v1/disbursements/bank-transfer/{reference}/status

Headers

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Path parameters

ParameterTypeRequiredDescription
referencestringYesThe Pasteaza transfer reference.

Example request

curl https://api.oyapasteaza.com/v1/disbursements/bank-transfer/pst_trf_01JABCXYZ/status \
  -X GET \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Successful response

{
  "status": true,
  "message": "Transfer status retrieved successfully.",
  "data": {
    "reference": "pst_trf_01JABCXYZ",
    "merchant_reference": "PAYOUT_12345",
    "amount": 500000,
    "currency": "NGN",
    "status": "successful",
    "recipient": {
      "account_number": "1234567890",
      "account_name": "JOHN DOE",
      "bank": {
        "code": "044",
        "name": "Access Bank Plc"
      }
    },
    "created_at": "2026-06-11T14:30:00Z",
    "completed_at": "2026-06-11T14:31:12Z"
  }
}

Possible statuses

StatusDescription
processingTransfer has been created and is being processed.
successfulTransfer was completed successfully.
failedTransfer failed.
reversedTransfer was reversed after processing.

How to use this endpoint

1

Store the reference

Save the transfer reference when you create the payout.
2

Query the status

Call the status endpoint with the transfer reference.
3

Check the final state

Read data.status to determine whether the transfer completed or failed.
4

Update your records

Sync your database or dashboard after the transfer reaches a final status.

Notes

  • Always check data.status before marking a transfer as completed.
  • A transfer may remain in processing for a short period.
  • Use webhooks for real-time updates when possible.
  • Store the transfer reference and merchant reference in your database.

Create transfer

Send money to a verified bank account.

Resolve account

Confirm the recipient account before sending money.