v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Residual Details

get/v1/residual-details

Query parameters

from_datestring

If it is empty, it takes the 1st day of the current month. Example: 2024-10-01

to_datestring

If it is empty, it takes the current day. Example: 2024-10-23

tsys_midstring

Nullable | Digits:15

agent_idstring

This field is used for filtering merchants. If the Authenticated user is an agent, it takes their id and filters the merchants by it. Alternatively the agent_id can be passed as a parameter to filter. If both are true then the authenticated user's id take precedence.

bank'5670' | '6719' | '9267'

If it is empty, it takes all the banks from the lov values for banks

view_agent_idstring

Return all of the accounts where view_agent_it is primary agent. And view_agent_id should be secondary to the Authenticated user

excelboolean

If it set to true, provides additional fields with merchant and template data

limitinteger

It limits the results

merchant_idstring

This field is used for filtering results. The value should be crypted account id

Response

200

Example response

{
  "header_data": [
    {
      "column_name": "Merchant ID",
      "sortable": true,
      "column_id": "merchant_id",
      "type": "string"
    }
  ],
  "row_data": [
    {
      "merchant_id": "567000000000018",
      "fee_category_description": "MISC Per Item Fees",
      "sales_count": "0000000001",
      "sales_amount": "000000000000.00",
      "credit_count": "0000000000",
      "credit_amount": "000000000000.00",
      "interchange_fee": "000000000000.00",
      "interchange_percent_rate": "000.0000",
      "interchange_per_item_rate": "000000.00000",
      "report_date": "2020-11-01",
      "created_at": "2020-10-31T12:06:56.000000Z",
      "updated_at": "2021-10-25T11:23:37.000000Z",
      "pricing_fee_item_percent": "000.0000",
      "pricing_fee_item_per_item": "000000.00000",
      "income_amount": "000000000000.00",
      "object": "ResidualRecordType2",
      "id": "lwj3enjwdqwm7pka"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}