INinfiniaweb
Troubleshooting

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.

get/deposits/rejected/

Request

  • Base URL
    https://app2test.infiniaweb.com/infinia_api/v1/troubleshooting
  • URL
    https://app2test.infiniaweb.com/infinia_api/v1/troubleshooting/deposits/rejected/
  • Auth
    HTTP basic

Query parameters

account_idinteger

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

include_child_companiesboolean

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

voucher_idstring

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

date_fromstring date-time

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

date_tostring date-time

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

limitinteger
cursorstring

Headers

x-company-idinteger

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

Response

A page of rejected deposits, newest first.

next_cursorstring
has_moreboolean
status'success'

Changes

No recorded changes to this operation across all 1 revision of this API.