Create a Pix statement
POST {{baseInfraUrl}}/{{version}}/pix-statement
Create a Pix Statement for a specific date. After that, the statement will be downloaded asynchronously from the Central Bank. When its status changes to success
, the statement will be available for download in CSV format.
| Parameters | Value/ Type | Description |
|---|---|---|
| after | REQUIRED | Transactions that happened at this date are stored in the Pix Statement, must be the same as the before parameter. Example: after=2022-01-20 |
| before | REQUIRED | Transactions that happened at this date are stored in the Pix Statement, must be the same as the after parameter. Example: after=2022-02-20 |
| type | REQUIRED | Type of statement to be created. Options: interchange, interchangeTotaland transaction. |
Request Body
{"after"=>"2022-01-01", "before"=>"2022-01-01", "type"=>"interchange"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"statement":{"after":"2022-01-01T03:00:00+00:00","before":"2022-01-02T02:59:59.999999+00:00","created":"2022-05-17T21:39:33.876594+00:00","id":"4887900760047616","status":"created","transactionCount":0,"updated":"2022-05-17T21:39:33.876601+00:00"}}