Listar status do pix

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/banking/pix/transferencias//status' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json'

{ "idAccount": 1234, "idEndToEnd": "000000091320530329T1219469887051", "transactionDate": "2025-03-21T15:19:52.754Z", "transactionType": "TRANSFER_DEBIT", "transactionStatus": "EXECUTED", "transferType": 0, "errorType": 1, "debitParty": { "ispb": 1, "bankName": "BB", "nationalRegistration": "03967713045", "name": "Maria João Silva", "bankBranchNumber": "01", "bankAccountType": "CC", "bankAccountNumber": "00011234" }, "creditParty": { "ispb": 342, "bankName": "BANCO 01", "nationalRegistration": "03967703035", "name": "Mário Brothers", "bankBranchNumber": "007", "bankAccountType": "CC", "bankAccountNumber": "0099812", "key": "seiyadepegaso@deathena.com.br" }, "amount": 10, "tariffAmount": 0, "finalAmount": 0, "idAdjustment": 987, "transactionCode": "127", "tariffTransactionCode": "0", "idTx": "DOCK202001030000000000021", "payerAnswer": "Resposta", "pixType": "TRANSFER", "purchaseAmount": "20", "changeAmount": "25", "agentWithdrawalIspb": "8343", "agentMode": "AGPSS", "amountDetails": { "original": "20", "fees": { "fine": 0, "interest": 0, "abatement": 0, "discount": 0 }, "final": "20" }, "details": [ { "title": "Título da mensagem", "content": "Conteúdo da mensagem" } ] }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

idTransacao

string

requerido

Identificador da transação.

Parâmetros Header

string

requerido

Tipo de conteúdo aceito.

Exemplo:

*/*

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Respostas

🟢200OK

application/json

Body

idAccount

integer <int32>

opcional

Identificador da conta.

>= 1<= 14

Exemplo:

1234

idEndToEnd

string

opcional

Identificador end-to-end.

<= 32 Caracteres

Exemplo:

000000091320530329T1219469887051

transactionDate

string <date-time>

opcional

Data da transação.

Exemplo:

2025-03-21T15:19:52.754Z

transactionType

enum<string>

opcional

Tipo da transação bancária.

Valores permitidos:

TRANSFER_DEBITTRANSFER_CREDIT

Exemplo:

TRANSFER_DEBIT

transactionStatus

enum<string>

opcional

Status da transação.

EXECUTED = Executada

NOT_EXECUTED = Não executada

PENDING = Pendente

REVERSAL_EXECUTED = Devolução

Valores permitidos:

EXECUTEDNOT_EXECUTEDPENDINGREVERSAL_EXECUTED

Exemplo:

EXECUTED

transferType

opcional

Status da transação.

0 = Manual

1 = Chave pix

2 = QR Code estático

3 = QR Code dinâmico Dynamic QR Code

Valores permitidos:

0123

Exemplo:

errorType

enum<integer>

opcional

Tipo de erro.

Tipo	Erro
1	Pagamento cancelado por timeout
2	Transação interrompida por erro no agente de pagamento
3	Número da conta de pagamento inválido ou ausente
4	Conta bloqueada, transações com a conta estão proibidas
5	Número da conta de pagamento está fechado
6	Tipo da conta de pagamento ausente ou inválido
7	Tipo de transação não suportado ou autorizado para esta conta
8	ISPB não identificado
9	Valor especificado é igual a zero
10	Sem limite disponível para a transação
11	Valor recebido não corresponde ao valor esperado ou acordado
12	Quantidade de transações informada é inválida ou ausente.
13	Informações do cliente final divergentes com o número da conta
14	Identificador do pagador incorreto
15	Conteúdo incorreto
16	Transação rejeita pelo banco (motivos relacionados ao conteúdo)
17	Signatário não tem permissão para assinar este tipo de operação
18	Data e hora de criação incorretas
19	Informações de pagamento, mensagem associada à transação ou transação recebida após data de processamento ou data anterior
20	Acordo falhou ou possui identificador EndToEnd duplicado
21	Identificador EndToEnd ausente ou inválido
22	Informações de beneficiário ausentes ou inválidas
23	Informações de devedor ausentes ou inválidas

Valores permitidos:

1234567891011121314151617181920212223

Exemplo:

debitParty

object

opcional

Parte beneficiária.

ispb

integer

opcional

Número do Identificador de Sistema de Pagamentos Brasileiro da parte beneficiária.

Exemplo:

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

nationalRegistration

string

opcional

Número de documento de identificação do beneficiário. CPF ou CNPJ, dependendo do informado em beneficiaryType.

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03967713045

name

string

opcional

Nome da pessoa proprietária da conta.

<= 100 Caracteres

Exemplo:

Maria João Silva

bankBranchNumber

string

opcional

Número da agência bancária.

>= 1 Caracteres<= 4 Caracteres

Exemplo:

bankAccountType

enum<string>

opcional

Tipo da conta bancária.

CC = Conta corrente

PA = Conta de pagamento

SA = Conta poupança

Valores permitidos:

CCPASA

Exemplo:

bankAccountNumber

string

opcional

Número da conta bancária.

>= 1 Caracteres<= 20 Caracteres

Exemplo:

00011234

creditParty

object

opcional

Parte devedora.

ispb

integer

opcional

Número do Identificador de Sistema de Pagamentos Brasileiro da parte devedora.

Exemplo:

342

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

BANCO 01

nationalRegistration

string

opcional

Número de documento de identificação do beneficiário. CPF ou CNPJ, dependendo do informado em beneficiaryType.

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03967703035

name

string

opcional

Nome da pessoa proprietária da conta.

<= 100 Caracteres

Exemplo:

Mário Brothers

bankBranchNumber

string

opcional

Número da agência bancária.

>= 1 Caracteres<= 4 Caracteres

Exemplo:

007

bankAccountType

enum<string>

opcional

Tipo da conta bancária.

CC = Conta corrente

PA = Conta de pagamento

SA = Conta poupança

Valores permitidos:

CCPASA

Exemplo:

bankAccountNumber

string

opcional

Número da conta bancária.

>= 1 Caracteres<= 20 Caracteres

Exemplo:

0099812

key

string

opcional

Chave pix.

Exemplo:

seiyadepegaso@deathena.com.br

amount

number <double>

opcional

Valor da transação.

<= 10

Exemplo:

tariffAmount

number <double>

opcional

Valor de taxas.

>= 0<= 10

Exemplo:

finalAmount

number <double>

opcional

Valor final da transação.

<= 10

Exemplo:

idAdjustment

integer <int32>

opcional

Identificador do ajuste.

>= 0

Exemplo:

987

transactionCode

string

opcional

Código da transação. Gerado mesmo se o pagamento não for efetuado.

Exemplo:

ff19b493-01f4-4550-9af1-d1d42f8146ce

tariffTransactionCode

string

opcional

Código de transação tarifária

Exemplo:

idTx

string

opcional

Identificador para conciliação do recebedor.

Exemplo:

ef02e3e027114aeeb76efa19a5f121d1

payerAnswer

string

opcional

Campo para informações sobre o processo.

<= 60 Caracteres

Exemplo:

Resposta

Padrão de combinação:

[a-z|A-Z|0-9|À-ú|]

pixType

enum<string>

opcional

Tipo da transferência pix.

TRANSFER = Transferência

CHANGE = Troco

WITHDRAWAL = Resgate

Valores permitidos:

TRANSFERCHANGEWITHDRAWAL

Padrão:

TRANSFER

Exemplo:

TRANSFER

purchaseAmount

string

opcional

Valor da compra. Retornado quando pixType = CHANGE.

Exemplo:

changeAmount

string

opcional

Valor disponível para compra.

Exemplo:

agentWithdrawalIspb

string

opcional

Número do Identificador de Sistema de Pagamentos Brasileiro do agente de retirada.

<= 8 Caracteres

Exemplo:

8343

agentMode

opcional

Tipo da agência de retirada.

AGPSS = facilitador de serviço de saque, também chamado de AGPSS

AGTEC = agente de saque estabelecimento comercial

AGTOT = caixas eletrônicos compartilhados ou correspondentes no país

Valores permitidos:

AGPSSAGTECAGTOT

Exemplo:

AGPSS

amountDetails

object

opcional

Detalhes do valor.

original

string

opcional

Valor original da transação. Não inclui taxas, descontos e juros.

Exemplo:

fees

object

opcional

Informações de taxas.

final

string

opcional

Valor final da transação.

Exemplo:

details

array [object {2}]

opcional

Campos com mais detalhes.

title

string

opcional

Campo para informações adicionais.

<= 50 Caracteres

Exemplo:

Título da mensagem

content

string

opcional

Campo para informações adicionais.

<= 200 Caracteres

Exemplo:

Conteúdo da mensagem

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor