List Pix requests

GET {{baseInfraUrl}}/{{version}}/pix-request

Here you can list and filter all Pix Requests you have made. We return it paged.

Request Params

KeyDatatypeRequiredDescription
cursornullString used to get the next batch of results.
limitnullMaximum number of objects to be retrieved. Max = 100.
fieldsnullList of strings to filter response JSON keys.
afternullFilter entities created after this date.
beforenullFilter entities created before this date.
statusnullList of strings to filter Pix Requests by the specific status.
tagsnullList of strings to filter Pix Requests that contain specific tags.
idsnullList of strings to filter Pix Requests by their ids.
externalIdsnullList of strings to filter Pix Requests by external ids.
endToEndIdsnullList of strings to filter Pix Requests by end to end ids

RESPONSES

status: OK

{"cursor":"CkcKFAoHY3JlYXRlZBIJCMyR69q55_cCEitqEGl-YXBpLW1zLXNwaS1kZXZyFwsSClBpeFJlcXVlc3QYgICA5NDXkAoMGAAgAQ==","requests":[{"amount":10,"cashAmount":0,"cashierBankCode":"","cashierType":"","created":"2022-05-18T17:23:00.278215+00:00","description":"","endToEndId":"E35547753202205181722Jy9eAC3yjXX","externalId":"php-438493277","fee":35,"flow":"out","id":"4684809204924416","initiatorTaxId":"","method":"manual","receiverAccountNumber":"000001","receiverAccountType":"checking","receiverBankCode":"341","receiverBranchCode":"0001","receiverKeyId":"","receiverName":"Daenerys Targaryen Stormborn","receiverTaxId":"012.345.678-90","reconciliationId":"","senderAccountNumber":"765438","senderAccountType":"checking","senderBankCode":"35547753","senderBranchCode":"2201","senderName":"Joao","senderTaxId":"594.739.480-42","status":"success","tags":[],"updated":"2022-05-18T17:23:06.472103+00:00"},{"amount":1000,"cashAmount":0,"cashierBankCode":"","cashierType":"","created":"2022-05-17T21:13:06.035916+00:00","description":"Money for nothing","endToEndId":"E34052649202205172113cHFAlbI6WO9","externalId":"","fee":0,"flow":"in","id":"5702879260180480","initiatorTaxId":"","method":"manual","receiverAccountNumber":"00000","receiverAccountType":"checking","receiverBankCode":"35547753","receiverBranchCode":"0000","receiverKeyId":"","receiverName":"","receiverTaxId":"594.739.480-42","reconciliationId":"","senderAccountNumber":"5692908409716736","senderAccountType":"checking","senderBankCode":"34052649","senderBranchCode":"0001","senderName":"Cora Pagamentos Ltda.","senderTaxId":"34.052.649/0001-78","status":"failed","tags":[],"updated":"2022-05-17T21:13:07.365846+00:00"}]}