Skip to main content
POST
https://api.fossapay.com
/
v1
/
payouts
/
bulk
Create Bulk Payout
curl --request POST \
  --url https://api.fossapay.com/v1/payouts/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "payouts": [
    {}
  ],
  "batch_reference": "<string>",
  "amount": 123,
  "account_number": "<string>",
  "account_name": "<string>",
  "bank_code": "<string>",
  "narration": "<string>",
  "reference": "<string>"
}
'
{
  "status": "success",
  "message": "Bulk payout initiated",
  "data": {
    "batch_id": "batch_xyz789",
    "batch_reference": "salary-jan-2024",
    "total_amount": 110000,
    "total_fee": 100,
    "total_debit": 110100,
    "count": 2,
    "status": "processing",
    "created_at": "2024-01-15T11:00:00Z"
  }
}

​
Request

​
payouts
array
required
Array of payout objects (max 1000 per batch)
​
batch_reference
string
required
Unique reference for this batch

​
Payout Object

​
amount
number
required
Amount to send
​
account_number
string
required
Recipient account number
​
account_name
string
required
Recipient account name
​
bank_code
string
required
Recipient bank code
​
narration
string
Payment description
​
reference
string
required
Unique reference for this payout

​
Request Example

curl -X POST https://api.fossapay.com/v1/payouts/bulk \
  -H "Authorization: Bearer fp_live_sk_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "batch_reference": "salary-jan-2024",
    "payouts": [
      {
        "amount": 50000,
        "account_number": "0123456789",
        "account_name": "John Doe",
        "bank_code": "058",
        "narration": "January salary",
        "reference": "sal-jan-001"
      },
      {
        "amount": 60000,
        "account_number": "9876543210",
        "account_name": "Jane Smith",
        "bank_code": "057",
        "narration": "January salary",
        "reference": "sal-jan-002"
      }
    ]
  }'

const bulk = await client.payouts.createBulk({
  batch_reference: 'salary-jan-2024',
  payouts: [
    {
      amount: 50000,
      account_number: '0123456789',
      account_name: 'John Doe',
      bank_code: '058',
      reference: 'sal-jan-001'
    },
    {
      amount: 60000,
      account_number: '9876543210',
      account_name: 'Jane Smith',
      bank_code: '057',
      reference: 'sal-jan-002'
    }
  ]
});

​
Response

{
  "status": "success",
  "message": "Bulk payout initiated",
  "data": {
    "batch_id": "batch_xyz789",
    "batch_reference": "salary-jan-2024",
    "total_amount": 110000,
    "total_fee": 100,
    "total_debit": 110100,
    "count": 2,
    "status": "processing",
    "created_at": "2024-01-15T11:00:00Z"
  }
}