List transfers
GET {{baseUrl}}/{{version}}/transfer
Here you can list and filter all transfers you have made. We return it paged.
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. | |
transactionIds | null | Filter entities that are linked to the specified transactions. | |
status | null | Filter transfer by the specified status. | |
taxId | null | Filter transfers sent to the specified taxId. | |
sort | null | Sort entities by the specified sort order. Options are "-created", "created", "-updated", "updated". | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | List of strings to get specific entities by ids. | |
fields | null | List of strings to filter response JSON keys. |
RESPONSES
status: OK
{"cursor":"CkoKFAoHY3JlYXRlZBIJCO3boMSpxusCEi5qFWl-YXBpLW1zLXRyYW5zZmVyLXNieHIVCxIIVHJhbnNmZXIYgICA_Nj3gQoMGAAgAA==","transfers":[{"accountNumber":"10000-0","accountType":"checking","amount":728,"bankCode":"01","branchCode":"0001","created":"2020-08-31T20:52:51.876298+00:00","description":"João (012.345.678-90)","externalId":"NjM0MTMyMDI5MzQ4MjQ5Njo3Mjg6MDEyLjM0NS42NzgtOTA6MDAxOjAwMDE6MTAwMDAtMDoyMDIwLTA4LTMx","fee":200,"id":"6281485963231232","name":"João","rules":[],"scheduled":"2020-09-01T11:00:00+00:00","status":"canceled","tags":[],"taxId":"012.345.678-90","transactionIds":[],"updated":"2021-03-27T23:49:35.473878+00:00"},{"accountNumber":"10000-0","accountType":"checking","amount":188,"bankCode":"01","branchCode":"0001","created":"2020-08-31T20:53:34.212589+00:00","description":"João (012.345.678-90)","externalId":"NjM0MTMyMDI5MzQ4MjQ5NjoxODg6MDEyLjM0NS42NzgtOTA6MDAxOjAwMDE6MTAwMDAtMDoyMDIwLTA4LTMx","fee":200,"id":"5638010271956992","name":"João","rules":[],"scheduled":"2020-09-01T11:00:00+00:00","status":"canceled","tags":[],"taxId":"012.345.678-90","transactionIds":[],"updated":"2021-03-27T23:49:35.473793+00:00"}]}