BAbanqzinc
Payout
Admin

List payout batches for a merchant

Changed on

List payout batches for a merchant

get/api/v1/admin/merchants/{merchantId}/payouts

Request

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Query parameters

'pending'
OR
'processing'
OR
'completed'
OR
'failed'

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "payment_reference": "QKM1ABC2DEF34G",
      "merchant_id": "550e8400-e29b-41d4-a716-446655440001",
      "source_account_id": "550e8400-e29b-41d4-a716-446655440002",
      "currency": "GBP",
      "gross_amount": "1395.94",
      "fees_total": "14.00",
      "net_amount": "1234.56",
      "transaction_count": 5,
      "payout_amount": "1111.10",
      "retained_amount": "123.46",
      "retention_rate": "0.1000",
      "retention_reference": "QKM1ABC2DEF34G-RET",
      "retention_tm_transaction_id": "TM-87654321",
      "tm_transaction_id": "TM-12345678",
      "error_message": "Settlement account not found",
      "executed_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Changes