List rejected deposits

Lists the incoming deposits to your virtual accounts that the payment rail rejected. A rejected deposit is never credited and its funds are returned to the payer, so it does not appear among your movements: this is where to find it.

Each item names the account the payer sent it to, the rail's reason for rejecting it and, once the rail reports it, the voucher ID of the refund to the payer. The payer is in third_party, as in a movement.

Available for BRL (Pix) deposits. Deposits rejected before this listing was released are not included.

The listing is read-only and scoped to the authenticated company; set include_child_companies to include its sub-companies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

If provided, only return deposits sent to this account ID.

boolean
Defaults to false

If set to true, include deposits sent to accounts owned by any child companies of the authenticated company. Default: false.

string
length between 1 and 64

If provided, only return the deposit with this voucher ID (the Pix end-to-end ID).

date-time

ISO 8601 timestamp (UTC). Only include deposits rejected on or after this time.

date-time

ISO 8601 timestamp (UTC). Only include deposits rejected on or before this time.

integer
1 to 100
Defaults to 50
string
Headers
integer

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json