List payment requests
GET {{baseUrl}}/{{version}}/payment-request
Here you can list and filter payment requests created by the requesting user. We return it paged.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
centerId | null | {Required} Unique ID of the targeted cost center. You can check out the cost center ID directly on its approval section on our Web Banking. | |
cursor | null | String used to get the next batch of results. Our SDKs handle this for you. | |
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 | |
type | null | Filters payment requests by the type inferred from the payment parameter, if it is not a dictionary. Example: boleto-payment | |
status | null | Filter payment requests by the specified status. Example: success | |
sort | null | Sort order considered in the response. Options are: "created", "-created", "updated" and "-updated". "-" means descending order. Default is "-created". | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | Filter payment requests by list of ids. Example: ["5656565656565656", "4545454545454545"] |
RESPONSES
status: OK
{"cursor":null,"requests":[{"status":"pending","updated":"2020-11-24T07:50:50.349399+00:00","attachments":[],"tags":[],"centerId":"5634161670881280","actions":[{"pictureUrl":"","name":"Parker's API","action":"requested","type":"project","id":"5644554002759680","email":""},{"pictureUrl":"https://storage.googleapis.com/api-ms-workspace-sbx.appspot.com/pictures/member/5157234329780224?20200806005629","name":"Dalton Felipe de Menezes","action":"required","type":"member","id":"5157234329780224","email":"dalton.menezes@starkbank.com"},{"pictureUrl":"","name":"Matheus Ferraz","action":"required","type":"member","id":"5672009245655040","email":"matheus.ferraz@starkbank.com"},{"pictureUrl":"https://storage.googleapis.com/api-ms-workspace-sbx.appspot.com/pictures/member/5690930589859840?20200808003729","name":"Caio Dottori","action":"required","type":"member","id":"5690930589859840","email":"caio.dottori@starkbank.com"},{"pictureUrl":"","name":"Rafael Stark","action":"required","type":"member","id":"5792156111339520","email":"rafael@starkbank.com"}],"payment":{"name":"Daenerys Targaryen Stormborn","accountNumber":"76543-8","taxId":"594.739.480-42","amount":100000000,"bankCode":"341","branchCode":"2201"},"description":"Daenerys Targaryen Stormborn (594.739.480-42)","created":"2020-11-24T07:50:50.120749+00:00","due":"2020-11-24T04:50:50.080507+00:00","id":"6145679692922880","amount":100000000,"type":"transfer"}]}