Troubleshooting

Trace a deposit by rail reference

Traces an incoming deposit to one of your virtual accounts by the reference on the payer's receipt, and tells you what happened to it: credited, still pending, rejected, expired, or settled on the payment rail but never credited.

The reference is the rail's own identifier for the transfer:

  • BRL — the Pix end-to-end ID, a 32-character code starting with E.
  • ARS — the Coelsa transfer ID.

Pix end-to-end IDs are often transcribed by hand, where the letter O and the digit 0 are easily confused, so for BRL those variations are tried as well. When the match came from a corrected reference, typo_corrected is true and matched_reference holds the reference that actually matched. Coelsa IDs are matched exactly, so for ARS typo_corrected is always false.

The lookup is read-only and scoped to the authenticated company and its sub-companies.

get/deposits/

Request

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

Query parameters

currency'BRL' | 'ARS' required

Rails the lookup can trace. The reference is the rail's own id for the transfer.

Rail of the deposit, which decides how reference is read.

  • BRL — Pix; the reference is the end-to-end ID.
  • ARS — Transferencias 3.0; the reference is the Coelsa transfer ID.
referencestring required

The rail reference of the transfer, as shown on the payer's receipt.

Headers

x-company-idinteger

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

Response

The lookup resolved; branch on data.result.

status'success'

Changes

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