List darf payment logs
GET {{baseUrl}}/{{version}}/darf-payment/log
Get a paged list of all utility payment logs. A log tracks a change in the payment entity according to its life cycle.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | null | String used to get the next batch of results. | |
limit | null | Number of results per cursor. Max = 100. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
types | null | Filter logs by log types. | |
paymentIds | null | Array of payment ids that are linked to the desired logs. | |
fields | null | List of strings to filter response JSON keys. |
RESPONSES
status: OK
{"cursor":"ClMKFAoHY3JlYXRlZBIJCNLkn93_kvICEjdqGGl-YXBpLW1zLXRheC1wYXltZW50LXNieHIbCxIORGFyZlBheW1lbnRMb2cYgICAsOzE-goMGAAgAQ==","logs":[{"payment":{"status":"canceled","scheduled":"2021-08-04T15:00:00+00:00","updated":"2021-08-02T18:46:12.384371+00:00","fee":0,"description":"2021-08-02 15:45:57.597399","tags":["tag1","tag2"],"competence":"2021-08-01T02:59:59.999999+00:00","referenceNumber":"062021","revenueCode":"1557","taxId":"01.793.865/0001-15","nominalAmount":328,"amount":380,"created":"2021-08-02T18:45:58.007443+00:00","due":"2021-08-08T02:59:59.999999+00:00","fineAmount":21,"interestAmount":31,"id":"6496458446471168","transactionIds":[]},"errors":[],"type":"canceled","id":"5605476809048064","created":"2021-08-02T18:46:11.310050+00:00"},{"payment":{"status":"created","scheduled":"2021-08-04T15:00:00+00:00","updated":"2021-08-02T18:46:12.384236+00:00","fee":0,"description":"2021-08-02 15:45:57.597399","tags":["tag1","tag2"],"competence":"2021-08-01T02:59:59.999999+00:00","referenceNumber":"062021","revenueCode":"1557","taxId":"01.793.865/0001-15","nominalAmount":328,"amount":380,"created":"2021-08-02T18:45:58.007443+00:00","due":"2021-08-08T02:59:59.999999+00:00","fineAmount":21,"interestAmount":31,"id":"6496458446471168","transactionIds":[]},"errors":[],"type":"canceling","id":"6168426762469376","created":"2021-08-02T18:46:11.257938+00:00"}]}