Skip to main content
GET
/
api
/
Payout
/
status
/
{transactionRef}
Transaction Status Re-Query
curl --request GET \
  --url https://payout-staging.embedly.ng/api/Payout/status/{transactionRef} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "status": "Pending",
    "transactionReference": "EMBEDLY-IB-12-1765129847157"
  },
  "statusCode": 200,
  "code": null,
  "message": "Successfully retrieved transaction",
  "succeeded": true
}

​
Payout Status Definitions

The system defines the following primary status states for your transactions:
StatusDescriptionWhen It Occurs
CREATEDInitial status when payout record is createdAfter successful validation and payout initialization
DEBIT_INITIATEDWallet debit process has startedWhen the system begins debiting the source wallet
DEBIT_SUCCESSWallet debit completed successfullyAfter successful withdrawal from the source wallet
TRANSFER_INITIATEDExternal transfer process has startedWhen the system begins the actual money transfer
TRANSFER_PROCESSEDTransfer has been sent to NIBBS for processingAfter successful submission to payment gateway
SUCCESSPayout completed successfullyFinal success state after all processes complete
FAILEDPayout failed at any stageWhen any critical error occurs during the process
​
transactionRef
string
required
The unique reference number of the transaction whose status you want to check. Exmaple: 3212-1234-5678-9101
{
  "data": {
    "status": "Pending",
    "transactionReference": "EMBEDLY-IB-12-1765129847157"
  },
  "statusCode": 200,
  "code": null,
  "message": "Successfully retrieved transaction",
  "succeeded": true
}