List Payouts

Get Payouts

GET https://<PayEngine-host>/api/merchant/:merchant_id/payouts

Path Parameters

Name	Type	Description
merchant_id*	String	Merchant Id

Query Parameters

Name	Type	Description
page	String	Page Number
amount[from]	String	Fund Amount From
amount[to]	String	Fund Amount To
date[from]	String	Payout Date From as a unix timestamp in seconds since epoch.
date[to]	String	Payout Date To as a unix timestamp in seconds since epoch.

200: OK List of Payouts

List Payouts Field Definitions

Field Name	Type	Description	Required?
id	string	id of the payout	yes
fee_amount	string	Total fee amount	yes
funding_amount	string	Total funding amount	yes
chargeback_amount	string	Total chargeback amount	yes
adjustment_amount	string	Total adjustment amount	yes
debit_amount	string	Total debit amount	yes
payout_date	string	Date of the payout	yes

Payouts Sample Response

{
  "data": [
    {
      "id": "c903a0ef-3146-47cb-897e-e61aceef9868",
      "fee_amount": "-402.58",
      "funding_amount": "13975.25",
      "chargeback_amount": "10.00",
      "adjustment_amount": "10.00",
      "debit_amount": "14377.83",
      "payout_date": "2022-06-06T20:00:00.000Z"
    },
    {
      "id": "add8b858-7f68-475d-b79d-654402d684dc",
      "fee_amount": "-402.58",
      "funding_amount": "13975.25",
      "chargeback_amount": "0.00",
      "adjustment_amount": "10.00",
      "debit_amount": "14377.83",
      "payout_date": "2022-06-06T20:00:00.000Z"
    }
  ],
  "meta": { "total": 2, "current_page": 1, "total_pages": 1 }
}