Payout Transaction List

The Payout List API endpoint facilitates efficient retrieval of detailed payout transaction information, empowering businesses to seamlessly integrate, automate, and manage outgoing payments. Gain insights into transaction status, amounts, and dates for enhanced financial control and reporting.

The payout transaction list that is returned are unique per API Auth token. Using different API Auth token will returned a different transaction list.

Authentication

LeanX uses Auth Token to authenticate in each request's header.

Auth Token can be retrieved in your portal dashboard under API page.

Request Header

{
    "auth-token": "LP-0D7C06DE-MM|7394e58e-edee-4c42-9ca5-bcbc449f1b9f|2141df4a3cb633d5ce8683bb0c55067e5caebfbe07390dde277dc455bcc95c91723a81b5e565c7c02d68fb84e396722563016bf99e576a4b8cdbe4423fbf226b"
}

Getting the payout transaction list

HTTP Method: POST

https://api.leanx.dev/api/v1/merchant/payout-transaction-list

Request Query

?skip=0&limit=10

Attribute

Property	Description
skip*	Skips a specified number of rows
limit*	Limits the results to the number of rows

Request Body

{
  "start_date": "01-02-2022",
  "end_date": "27-02-2023",
  "record_status": 1,
  "search": {
    "search_enable": false,
    "search_key": "WEB_PAYMENT",
    "search_column": "payment_mode"
  },
  "sort": {
    "parameter_name": "created_at",
    "sort_type": "desc"
  }
}

Attribute

Please ensure that the search_enable flag is set to false if search_key is not provided to avoid errors.

Property	Type	Description
start_date*	string	Start date of the transaction list. Kindly follow this format DD-MM-YYYY
end_date*	string	End date of the transaction list. Kindly follow this format DD-MM-YYYY
record_status*	number	Filter the result with record status 1 = active 2 = inactive
search*		Search for keyword
- search_enable*	Boolean	Enable or disable search function true or false
- search_key*	string	Keyword that you want to search for.
- search_column*	string	Column name that you want to search in
sort*		Sort the result
- parameter_name*	string	Column name that you want to sort
- sort_type*	string	Sorting direction "asc" = Ascending "desc" = Descending

Response

{
  "response_code": 2000,
  "description": "SUCCESS",
  "app_version": "/api/v1",
  "talk_to_server_before": "2023-12-05T15:50:05.572298",
  "data": {
    "list": {
      "draw": 10,
      "record_total": 21,
      "record_filtered": 21,
      "data": [
        {
          "merchant_invoice_id": "VA-F04EC4-164712020277-PAYOUT",
          "id": 376,
          "payout_invoice_no": "PAYOUT-918E:164211-LEANX",
          "payout_account_number": "8011408168",
          "recipient_name": "TEST CUSTOMER WP2",
          "transaction_fee": 0.50,
          "account_id": 3,
          "record_status": 1,
          "updated_at": "2023-10-20T16:42:12",
          "switch_invoice_id": "VP1678085468bA52B",
          "transaction_invoice_no": "NO_DATA",
          "transaction_status": "PENDING",
          "value": 100.00,
          "created_at": "2023-10-20T16:42:12"
        },
        ..........
        {
          "merchant_invoice_id": "VA-F04EC4-164712020277-PAYOUT",
          "id": 197,
          "payout_invoice_no": "PAYOUT-86B0:220453-LEANX",
          "payout_account_number": "11212121112111",
          "recipient_name": "TEST CUSTOMER WP2",
          "transaction_fee": 0.50,
          "account_id": 3,
          "record_status": 1,
          "updated_at": "2023-07-06T22:05:03",
          "switch_invoice_id": "VP1678085468bA52B",
          "transaction_invoice_no": "PAYOUT1688652293ClAEbwWK",
          "transaction_status": "SUCCESS",
          "value": 36.00,
          "created_at": "2023-07-06T22:04:53"
        }
      ],
      "next_page_start": 10,
      "next_page_length": 10,
      "previous_page_start": 0,
      "previous_page_length": 10
    }
  },
  "breakdown_errors": null,
  "token": "18e0933d-6bc1-4808-9bc7-aad2bcd38686"
}