List darf payments
GET {{baseUrl}}/{{version}}/darf-payment
Get a list of non-deleted DARF payments in chunks of at most 100. If you need smaller chunks, use the limit parameter.
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. | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | List of strings to get specific entities by ids. | |
status | null | Filter payments by the specified status. |
RESPONSES
status: OK
{"cursor":"ClAKFAoHY3JlYXRlZBIJCKvWrImDjPICEjRqGGl-YXBpLW1zLXRheC1wYXltZW50LXNieHIYCxILRGFyZlBheW1lbnQYgICAkMKBqggMGAAgAQ==","payments":[{"status":"processing","scheduled":"2021-08-02T18:36:20.775512+00:00","updated":"2021-08-02T18:36:21.952373+00:00","fee":0,"description":"92886864d3322df8b76a14ca4f0903c2c4eae69f6dc180501a440ee8d7febeff","tags":[],"competence":"2021-07-29T02:59:59.999999+00:00","referenceNumber":"062021","revenueCode":"4333","taxId":"16.281.034/0001-31","nominalAmount":961,"amount":1069,"created":"2021-08-02T18:36:20.775981+00:00","due":"2021-08-05T02:59:59.999999+00:00","fineAmount":90,"interestAmount":18,"id":"5464422667517952","transactionIds":[]},{"status":"failed","scheduled":"2021-07-31T00:12:30.879976+00:00","updated":"2021-07-31T11:20:18.288919+00:00","fee":0,"description":"description test","tags":["tag1","tag2"],"competence":"2021-06-21T02:59:59.999999+00:00","referenceNumber":"860","revenueCode":"8325","taxId":"012.345.678-90","nominalAmount":821,"amount":964,"created":"2021-07-31T00:12:30.881579+00:00","due":"2021-08-10T02:59:59.999999+00:00","fineAmount":59,"interestAmount":84,"id":"4688369690869760","transactionIds":[]}]}