Skip to content

Getting all disbursements

GET|POST /api/disbursements

Request:

FieldRequiredTypeDescription
perPageintNumber of records per page. Default: 10
pageintPage number. Default: 1
filtersarrayArray of objects for filtering records
filters.*.typestringFilter type - and or or. Default: and
filters.*.fieldstringField to filter by. ('id', 'paySystem', 'contractId', 'amount', 'client_amount', 'commission', 'orderId', 'fundTransactionId', 'status', 'error', 'createdAt', 'updatedAt')
filters.*.operatorstringComparison operator (<, <=, >, >=, =, !=, like, not like, in, not in). Default: =
filters.*.valuemixedValue for comparison
sortstringField to sort by ('id', 'paySystem', 'contractId', 'amount', 'client_amount', 'commission', 'orderId', 'fundTransactionId', 'status', 'error', 'createdAt', 'updatedAt')
sortDirectionmixedSort direction (asc, desc). Default: asc

Response:

json
{
  "status": "ok",
  "timestamp": "1685516056000",
  "data": [
    {
      "id": 56,
      "paySystem": "tinkoff",
      "contractId": 101342406,
      "amount": 10000,
      "client_amount": 10000,
      "commission": 0,
      "orderId": "",
      "status": -1,
      "statusText": "???",
      "error": "Error append DDS data",
      "createdAt": "2022-03-25T19:48:29+03:00",
      "updatedAt": "2022-03-25T19:48:29+03:00"
    },
    {
      "id": 55,
      "paySystem": "tinkoff",
      "contractId": 101342406,
      "amount": 10000,
      "client_amount": 10000,
      "commission": 0,
      "orderId": "",
      "status": -1,
      "statusText": "???",
      "error": "Error append DDS data",
      "createdAt": "2022-03-25T19:48:16+03:00",
      "updatedAt": "2022-03-25T19:48:16+03:00"
    }
  ]
}