List Pix claims
GET {{baseInfraUrl}}/{{version}}/pix-claim
Here you can list and filter all Pix Claims you have. We return it paged.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | null | String used to get the next batch of results. | |
fields | null | List of strings to filter response JSON keys. | |
limit | null | Maximum number of Pix Claims to be retrieved. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
status | null | List of strings to filter Pix Claims by the specific status. | |
type | null | Filter Pix Claims by their type. | |
agent | null | Filter Pix Claims by their agent. | |
keyType | null | Filter Pix claims by their Pix key type. | |
keyId | null | Filter Pix claims by their Key id. | |
ids | null |
RESPONSES
status: OK
{"claims":[{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"5692908409716736","accountType":"checking","agent":"claimer","bankCode":"35547753","branchCode":"0000","claimedBankCode":"31804966","claimerBankCode":"35547753","created":"2022-05-17T19:31:21.972149+00:00","id":"5961418104897536","keyId":"postmanteste@starkbank.com","keyType":"email","name":"testKey","status":"created","taxId":"012.345.678-90","type":"ownership","updated":"2022-05-17T19:31:25.234171+00:00"},{"accountCreated":"2022-01-02T02:59:59.999999+00:00","accountNumber":"76549","accountType":"salary","agent":"claimer","bankCode":"35547753","branchCode":"1234","claimedBankCode":"70431630","claimerBankCode":"35547753","created":"2022-05-16T21:20:40.479804+00:00","id":"6129836925911040","keyId":"+551165857989","keyType":"phone","name":"Tony Stark","status":"delivered","taxId":"012.345.678-90","type":"ownership","updated":"2022-05-16T21:21:01.253442+00:00"}],"cursor":"CkcKFAoHY3JlYXRlZBIJCLzY5sT55PcCEitqEWl-YXBpLW1zLWRpY3QtZGV2chYLEglEaWN0Q2xhaW0YgICAhN7h8QoMGAAgAQ=="}