Account statements
GET /order/v1/banking/accounts/{accountId}/statements
Retrieve the account statement for the informed period.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Identifier of the account
Query Parameters
Section titled “Query Parameters ”Start date of the statement period in ISO 8601 format
End date of the statement period in ISO 8601 format
Currency used for the statement (ISO 4217)
Maximum number of records returned
Sorting direction for the records
Filters records by transaction direction (in or out)
Filters records by end-to-end id. Matches the order end-to-end id and the refund end-to-end id
Cursor to continue pagination (use the value returned in nextCursor)
When true, merges all transactions belonging to the same batch into a single entry, summing their amounts
Responses
Section titled “ Responses ”The resource was returned successfully
object
Parameters used to generate the statement
object
Start date of the statement period in ISO 8601 format
End date of the statement period in ISO 8601 format
Currency used for the statement (ISO 4217)
Maximum number of records returned in the statement
Order of the records (asc or desc)
Filters records by transaction direction (in or out)
Filters records by end-to-end id
Cursor to retrieve the next page of results
Indicates if more records are available for pagination
Statement items returned for the requested period
object
Identifier of the order associated with the transaction
External reference code of the transaction
Unique identifier of the transaction
Date and time of the transaction
End-to-end identifier of the transaction
End-to-end identifier of the refund transaction
Operation type of the transaction.
Transaction amount; negative values indicate debits
Account balance after the transaction
Counterparty information when available
object
Counterparty name
Counterparty document information
object
Document type of the counterparty
Document number of the counterparty
ISPB of the counterparty financial institution
Name of the counterparty financial institution
Branch number of the counterparty
Account number of the counterparty
Type of the counterparty account
Payment method used for the transaction
Description of the transaction
The identifier of the refund transaction
Batch information when this transaction belongs to a batch
object
Id of the batch
Total number of child transactions in the batch
Number of child transactions already paid
Number of child transactions that failed
Number of child transactions still pending
Amount already paid across all child transactions
Amount still pending across all child transactions
Child transactions the batch was split into
object
Id of this child transaction
Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it
Ordering position of this child transaction within the batch
Amount of this child transaction
Status of this child transaction
End-to-end id of this child transaction
Date this child transaction was paid
Error message when this child transaction failed
object
object
Unauthorized Request