Skip to main content
Consulta um comprovante de uma transação específica.
Por meio deste endpoint, o parceiro pode consultar todos os tipos de comprovantes: título de pagamento, boleto, transferência, débito, lançamentos, entre outros. Formas de consulta (informe uma delas):
  • CodigoMovimento: código do movimento financeiro (lançamento do extrato).
  • CodigoTransacao + OrigemTransacao: código da transação e sua origem; o movimento é localizado a partir deles.
  • CodigoTransacao sem OrigemTransacao: o valor é tratado como CodigoMovimento.
A conta do movimento deve pertencer ao mesmo parceiro do operador autenticado.
Vale ressaltar que o a interface do comprovante deve ser desenvolvida no front do parceiro.

Autorizações

Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

CodigoTransacao
string<uuid>

Código UUID identificador da transação (ex.: pagamento, TED, Pix) para a qual o comprovante será consultado. Quando informado junto com OrigemTransacao, o movimento é localizado pela transação. Quando informado sem OrigemTransacao, o valor é tratado como CodigoMovimento.*

OrigemTransacao
enum<integer>

Origem da transação informada em CodigoTransacao. Utilizado apenas em conjunto com CodigoTransacao. Valores suportados: 1 - Transferência Interna, 2 - Envio TED, 3 - Pagamento de Boleto, 5 - Pix, 6 - Pagamento de Título Concessionária, 1006 - Devolução Pix.

Opções disponíveis:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
501,
502,
503,
504,
505,
506,
507,
1001,
1002,
1003,
1004,
1005,
1006,
1007,
1008,
1009,
1010,
1011,
1012,
1013,
1014,
1200,
1501,
1502,
1503,
1601,
1701,
2001,
2002,
2003,
2004,
2010,
2012,
2501,
3001,
3002,
4001,
4501,
5001,
5002,
5003,
5004
CodigoMovimento
string<uuid>

Código UUID identificador do movimento financeiro específico para o qual o comprovante será consultado.*

Resposta

Success

sucesso
boolean
mensagem
string | null
comprovante
any | null

Objeto contendo informações do comprovante respectivas ao OrigemTransacao enviado na requisição.

codigoTransacao
string<uuid>

Código UUID identificador da transação.

tipoTransacao
enum<integer>
Opções disponíveis:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
501,
502,
503,
504,
505,
506,
507,
1001,
1002,
1003,
1004,
1005,
1006,
1007,
1008,
1009,
1010,
1011,
1012,
1013,
1014,
1200,
1501,
1502,
1503,
1601,
1701,
2001,
2002,
2003,
2004,
2010,
2012,
2501,
3001,
3002,
4001,
4501,
5001,
5002,
5003,
5004