Skip to content

getPayOutTransactions

List outgoing payout transactions (money paid out to your bank account).

Request

POST /api/v2/getPayOutTransactions

Headers

Header Required Description
token Yes Your API Key
Content-Type Yes application/json

Body Parameters

Field Type Required Default Description
page integer No 1 Page number
limit integer No 10 Maximum results (max: 1000)
search string No — Search by transaction_id
start_date string No — Filter from date (YYYY-MM-DD)
end_date string No — Filter until date (YYYY-MM-DD)

Response

Success

{
  "data": [
    {
      "payout_id": "21503",
      "user_id": "b44c4429-4a7b-4e27-85af-c1c2f43f4ffe",
      "transaction_id": "20260512-po-tYlGbn74wT",
      "payout_amount": "74.06",
      "service_fee": 0.73,
      "net_amount": 71.53,
      "payout_status": "InProgress",
      "request_date": "2026-05-12",
      "created_at": "2026-05-20 02:01:14",
      "is_split_link": "true",
      "is_dispute": "false",
      "is_refund": "false",
      "transaction_type": "Split"
    }
  ],
  "ResponseCode": 1,
  "ResponseMsg": "List retrived successfully",
  "Result": "True",
  "ServerTime": "CEST"
}

Response Fields (per item)

Field Type Description
payout_id string Unique payout identifier
transaction_id string Payout reference (format: YYYYMMDD-po-XXXXXXXXXX)
payout_amount string Total gross payout amount
service_fee number SecPaid fee deducted
net_amount number Net amount paid out
payout_status string "InProgress" or "Approved"
request_date string Date the payments were aggregated for (YYYY-MM-DD)
created_at string When the payout record was created
is_split_link string Whether this payout includes split link payments
is_dispute string Whether this payout includes disputed payments
is_refund string Whether this payout includes refunds
transaction_type string "Basic" or "Split"

Examples

curl -X POST https://app.secpaid.com/api/v2/getPayOutTransactions \
  -H "Content-Type: application/json" \
  -H "token: YOUR_API_KEY" \
  -d '{"limit": 20}'

const response = await fetch("https://app.secpaid.com/api/v2/getPayOutTransactions", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "token": "YOUR_API_KEY"
  },
  body: JSON.stringify({ limit: 20 })
});

$response = Http::withHeaders([
    'token' => 'YOUR_API_KEY',
])->post('https://app.secpaid.com/api/v2/getPayOutTransactions', [
    'limit' => 20,
]);

Notes

  • Payouts aggregate all successful payments from a given day into a single record
  • Payouts are processed daily via a cron job (aggregating prior day's payments)
  • request_date is the day the payments were originally received
  • payout_status: "InProgress" means the payout is pending admin approval
  • Results ordered by request_date descending (newest first)
  • Use start_date / end_date to filter by payout request date range