Skip to main content
GET
https://api.fossapay.com
/
v1
/
payouts
/
{payout_id}
Get Payout Status
curl --request GET \
  --url https://api.fossapay.com/v1/payouts/{payout_id}
{
  "status": "success",
  "data": {
    "payout_id": "pay_abc123",
    "amount": 50000,
    "fee": 50,
    "status": "completed",
    "account_number": "0123456789",
    "account_name": "JANE SMITH",
    "bank_code": "058",
    "bank_name": "GTBank",
    "reference": "payout-jan-2024-001",
    "narration": "Salary payment",
    "completed_at": "2024-01-15T11:05:23Z",
    "created_at": "2024-01-15T11:00:00Z"
  }
}

Path Parameters

payout_id
string
required
The unique identifier of the payout

Request Example

curl https://api.fossapay.com/v1/payouts/pay_abc123 \
  -H "Authorization: Bearer fp_live_sk_xxxxxxxx"
const payout = await client.payouts.getStatus('pay_abc123');

Response

{
  "status": "success",
  "data": {
    "payout_id": "pay_abc123",
    "amount": 50000,
    "fee": 50,
    "status": "completed",
    "account_number": "0123456789",
    "account_name": "JANE SMITH",
    "bank_code": "058",
    "bank_name": "GTBank",
    "reference": "payout-jan-2024-001",
    "narration": "Salary payment",
    "completed_at": "2024-01-15T11:05:23Z",
    "created_at": "2024-01-15T11:00:00Z"
  }
}

Status Values

StatusDescription
pendingPayout initiated, not yet processed
processingBeing processed by recipient bank
completedSuccessfully completed
failedFailed (funds refunded)