​
Payout Status

After initiating a payout via Single Transfer, use the payout status endpoint to confirm the final outcome of the transaction.

​
Confirm Payout Status

Request
curl --request GET \
  --url 'https://adapter.cepta.co/api/v1/pay/payout-status?reference=sngTW201321082886170_788589' \
  --header 'X-Access-Ts: <EPOCH Timestamp(seconds)>' \
  --header 'X-Access-Key: <PUBLIC_KEY>' \
  --header 'X-Access-Signature: <HMAC SHA256 signature>'

​
Query Parameters

​
reference
string
required

The transaction reference returned after initiating a payout.

​
Response

Success Response
{
  "status": true,
  "message": "Payout status retrieved successfully",
  "data": {
    "reference": "sngTW201321082886170_788589",
    "status": "successful",
    "amount": 1000.00,
    "currency": "KES",
    "accountNumber": "254712345678",
    "accountName": "Jane Wanjiku",
    "message": "Transfer completed successfully"
  }
}

​
Response Fields

​
status
boolean

true if the request was processed successfully.

​
data
object

Contains payout status details.

​
reference
string

The payout transaction reference.

​
status
string

Current status of the payout: "pending", "successful", or "failed".

​
amount
number

Amount of the payout in KES.

​
currency
string

Currency code ("KES").

​
accountNumber
string

Recipient phone number.

​
accountName
string

Recipient name.

​
message
string

Descriptive message about the payout outcome.

​
Simulate Payout Notification (Sandbox Only)

This endpoint is available in sandbox mode only. Do not use it in production.

In sandbox, payout notifications are not sent automatically. Use this endpoint to simulate the outcome of a payout and trigger your webhook handler.

Request
curl --request POST \
  --url https://adapter.cepta.co/api/v1/pay/simulate-payout-notification \
  --header 'X-Access-Ts: <EPOCH Timestamp(seconds)>' \
  --header 'X-Access-Key: <PUBLIC_KEY>' \
  --header 'X-Access-Signature: <HMAC SHA256 signature>' \
  --header 'Content-Type: application/json' \
  --data '{
    "reference": "sngTW201321082886170_557122",
    "isSuccess": true,
    "message": "Insufficient funds at provider"
  }'

​
Request Parameters

​
reference
string
required

The transaction reference of the payout to simulate.

​
isSuccess
boolean
required

Set to true to simulate a successful payout, false to simulate a failure.

​
message
string

Optional message describing the simulated outcome (e.g., "Insufficient funds at provider").

​
Response

Success Response
{
  "status": true,
  "message": "Payout notification simulated successfully"
}
Single TransferAccept Payment with Cepta Checkout