---
title: "GetPixOutById"
method: POST
path: "/GetPixOutById"
tags: ["Payment and Payment Management"]
---

# GetPixOutById

`POST /GetPixOutById`

This method can be used to consult a pix payment by its identifier (DocumentNumber)

## Request body

- object
  - `Method` string, required
  - `PartnerId` integer, required — Partner identifier provided by Fitbank
  - `BusinessUnitId` integer, required
  - `DocumentNumber` integer — Transaction id
  - `TaxNumber` string, required — Legal Identification From Company
  - `Bank` Bank, required
    - `bank` string, required — > Bancos >> Clique no link a seguir para visualizar os bancos <a href="https://developers.easycredito.com.br/enum/bank.json" target="_blank">https://developers.easycredito.com.br/enum/bank.json</a>
    - `type` 'CONTA_CORRENTE_INDIVIDUAL' | 'CONTA_CORRENTE_CONJUNTA' | 'CONTA_POUPANCA_CONJUNTA' | 'CONTA_POUPANCA_INDIVIDUAL', required — Tipo de conta bancária
    - `agency` string, required — Número da agência
    - `account` string, required — Número da conta
    - `pixKey` string — Chave Pix da conta
  - `BankBranch` string, required — Beneficiary's Bank Branch
  - `BankAccount` string, required — Beneficiary's Account Number (without digit)
  - `BankAccountDigit` string, required — Beneficiary's Account Digit
  - `Identifier` string — Identifier Of The Transaction

## Response `200`

OK

- object
  - `Success` string
  - `Message` string
  - `Infos` object[]
    - `DocumentNumber` number
    - `Identifier` string
    - `EndToEndId` string
    - `FromName` string
    - `FromTaxNumber` string
    - `FromISPB` string
    - `FromBankCode` string
    - `FromBankBranch` string
    - `FromBankAccount` string
    - `FromBankAccountDigit` string
    - `ToName` string
    - `ToTaxNumber` string
    - `ToISPB` string
    - `ToBankCode` string
    - `ToBankBranch` string
    - `ToBankAccount` string
    - `ToBankAccountDigit` string
    - `ErroDescription` string
    - `ErroCode` string
    - `Status` string
    - `RateValue` string
    - `TotalValue` string
    - `PaymentDate` string
    - `ReceiptValue` string
    - `Tags` string[]

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/versions/f94d262a8f58/schema)