Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Pix
  • Visão geral
  • O QUE HÁ DE NOVO
    • Release Notes
      • Horizon
  • GUIAS
    • Manuais
      • Diretrizes Básicas
      • Como se autenticar
      • Respostas e status
      • Nossas APIs
      • Webhook
      • FAQ
  • ESPECIFICAÇÕES
    • APIs
      • Autenticação
        • Gerar token de acesso
      • Acheron
        • Pagamento
          • Cadastrar um pagamento
          • Cancelar um pagamento
          • Criar intenção de pagamento
          • Confirmar intenção de pagamento
          • Cancelar intenção de pagamento
          • Listar intenções de pagamento
          • Criar pagamento via PIX
        • Venda
          • Criar venda com cartão
          • Cancelar venda com cartão
          • Criar venda com portador
          • Cancelar venda com portador
          • Estornar uma venda
        • E-Commerce
          • Criar venda e-commerce
          • Confirmar pagamento e-commerce
          • Listar pagamento e-commerce
          • Cancelar venda e-commerce
          • Gerar token de e-commerce
        • VTEX
          • Criar venda VTEX
          • Confirmar venda VTEX
          • Estornar venda VTEX
          • Cancelar venda VTEX
        • Simulação
          • Criar simulação
        • Pré-autorização
          • Listar pré-autorização
          • Listar valor reservado
        • BNPL
          • Confirmar estorno de venda
          • Estornar venda
          • Simular venda
          • Confirmar venda
          • Sensibilizar venda
      • Agenda lojista
        • Agenda
          • Cadastrar recebimento em agenda
          • Cadastrar agenda manual
          • Listar agenda por loja
          • Consultar agenda específica
          • Listar transações pelo ID da agenda ou loja
        • Configurações de Agendas
          • Cadastrar configuração
          • Listar configurações da agenda
          • Alterar configuração de uma loja
        • Modalidade
          • Cadastrar modalidades
          • Listar modalidades
          • Listar modalidade por lançamento
          • Alterar tipo de modalidade
        • Lançamentos
          • Listar lançamentos por loja
          • Cadastrar lançamentos
          • Cadastrar lançamento de ajuste
        • Tipo de ajuste
          • Cadastrar um tipo de ajuste
          • Listar tipo de ajuste
      • Banking
        • Conciliação bancária
          • Gerar saldo para um emissor
          • Gerar extrato para um emissor
          • Gerar arquivos de conciliação
        • Contas
          • Listar contas digitais
        • Pix
          • Transferir pix
            POST
          • Listar status do pix
            GET
          • Listar transferências Pix
            GET
          • Listar informações de chave
            GET
      • Biometria
        • Biometria
        • Handshake fortface
          • Iniciar o processo de autenticação biométrica SDK
          • Iniciar o processo de autenticação biométrica Backoffice
        • Biometria
          • Identificar um rosto
          • Cadastrar uma face utilizando o SDK Fortface
          • Cadastrar uma face através do Backoffice da Fortface
      • Broker
        • Enviar mensagem SMS
      • Cartões
        • Portadores
          • Buscar cartão pelo titular
          • Cadastrar portador adicional
          • Listar cartões do adicional
          • Gerar cartão adicional
        • CVV Virtual
          • Ativar CVV Virtual do titular
          • Inativar CVV Virtual
          • Atualizar data de expiração do CVV
        • Senha
          • Cadastrar senha
          • Alterar senha
          • Autenticar senha do cartão
          • Gerar senha e enviar por SMS
        • Bloqueios e Desbloqueios
          • Bloquear um cartão temporariamente
          • Bloquear permanentemente
          • Listar histórico de bloqueios
          • Listar tipos de bloqueio
          • Desbloquear cartão
        • Cartões
          • Solicitar segunda via
          • Trocar cartão pendente
          • Buscar cartão criptografado
          • Listar histórico de cancelamento
          • Listar tipos de cancelamento
          • Gerar um cartão virtual
          • Listar cartão virtual
          • Buscar cartão pelo id
          • Buscar cartão pelo número
          • Buscar cartão pelo CPF
          • Buscar cartão bandeirado
          • Token Merci
          • Trocar cartão do portador
          • Cadastrar Pessoa Jurídica
          • Solicitar troca do cartão
          • Listar BIN
        • No Name
          • Listar lotes de cartão
          • Criar lote de cartões
          • Destruir cartão
          • Vincular cartão ao titular
          • Vincular cartão adicional
          • Destruir lote de cartões
          • Embossar cartões por lote
          • Listar cartões
        • Vipagem
          • Listar cartões bandeirados
          • Emitir segunda via
      • Embossing
        • Cartões
          • Embossing de cartão
          • Bloquear cartão por falha
          • Listar cartões pendentes
        • Impressoras
          • Inativar impressora
          • Ativar impressora
      • Empréstimo
        • Empréstimo Pessoal
          • Cadastrar clientes para empréstimo
          • Solicitar crédito para empréstimo
        • Empréstimo Pix Card
          • Enviar arquivo
          • Alterar dados bancários
          • Transferir via Pix
          • Cadastrar pessoa física
          • Simular empréstimo
          • Confirmar empréstimo
          • Aprovar crédito
          • Criar contrato
          • Consultar pessoa
        • Empréstimo FGTS
          • Simular saldo
          • Obter saldo
          • Cadastrar pessoa física
          • Cadastrar operação
          • Submeter para aprovação
          • Consultar informações
          • Listar produto
          • Consultar pessoa
          • Listar operações
          • Acompanhar operação
          • Listar estado civil
          • Listar bancos
        • Empréstimo Simplificado
          • Listar bancos
          • Consultar informações de contrato
          • Consultar contratos de empréstimo
      • Faturamentos
        • Parcelamento de fatura
          • Antecipar uma parcela do parcelamento
          • Antecipar todo o parcelamento
          • Buscar parcelamento pendente
          • Buscar parcelamento ativo
          • Simular antecipação
          • Parcelar faturas
        • Ciclos de fatura
          • Consultar ciclos de vencimento
          • Alterar o ciclo de vencimento
        • Consulta de faturas
          • Consultar lançamentos futuros
          • Consultar faturas por período
          • Consultar faturas futuras
          • Consultar última fatura fechada
          • Consultar fatura detalhada
          • Consultar fatura atual
          • Visualizar saldo detalhado
        • Faturas digitais
          • Receber fatura em PDF
          • Aderir à fatura digital
          • Cancelar fatura digital
          • Aderir à fatura por SMS
          • Cancelar fatura por SMS
      • Financiamentos
        • Parcelamento total
          • Simular parcelamento devedor total
        • Parcelamento manual
          • Simular parcelamento manual
      • Gestão de contas
        • Cadastrar cartão físico para titular
      • Lançamentos
        • Ajustes
          • Lançar um ajuste financeiro
          • Listar um ajuste financeiro
          • Lançar ajustes a débito
          • Lançar ajustes a crédito
          • Listar tipos de ajustes
          • Listar faturas ajustadas
          • Lançar um ajuste na fatura
        • Vendas
          • Antecipar venda total
          • Antecipar venda avulsa
        • Antecipação
          • Listar compras passíveis de antecipação
        • Baixas bancárias
          • Estornar lançamento de baixa bancária
          • Lançar baixa báncaria
          • Lançar baixa bancária de pagamento
          • Estornar pagamento de baixa bancária
      • Loja
        • Formas de Pagamentos
          • Listar formas de pagamento
          • Cadastrar forma de pagamento
          • Atualizar forma de pagamento
          • Consultar parcelas de uma loja
        • Tarifas
          • Listar tarifas
          • Cadastrar tarifa
          • Associar tarifa a uma loja
          • Cancelar tarifas com a loja
          • Listar tarifas por loja
          • Consultar uma tarifa
          • Alterar cadastro de uma tarifa
        • Lojas
          • Cadastrar uma loja
          • Consultar uma loja
          • Consultar loja por id externo
          • Listar loja pelo CNPJ
          • Listar lojas
          • Alterar uma loja
      • Pacote SMS
        • Contratar um pacote SMS
        • Cancelar um pacote SMS
        • Consultar pacotes do portador
        • Habilitar celular para adesão do pacote
        • Habilitar celular para receber bônus
        • Consultar pacotes disponíveis
        • Consultar pacotes contratados
      • Parâmetros
        • Listar parâmetros cadastrados
        • Listar parâmetros exibíveis
      • Pix
        • Pix Imediato
          • Listar chaves Pix Imediato
          • Gerar Pix Imediato
          • Listar uma chave Pix Imediato
      • Pix Card
        • PixCard
          • Transferir via Pix
          • Consultar CPF
          • Cadastrar cliente
          • Simular operação
          • Confirmar operação
          • Cadastrar documento do portador
        • Assinatura
          • Listar as assinaturas
          • Cadastrar assinatura
          • Verificar assinaturas para cobrança
          • Listar assinaturas válidas
          • Listar planos
          • Alterar assinatura pelo CPF
        • Conta Digital
          • Listar termos obrigatórios
          • Cadastrar termo obrigatório
          • Cadastrar documento do portador
          • Criar uma conta digital
          • Criar uma conta alias
          • Listar contas pelo identificador
          • Listar informações do portador
        • Transferência
          • Agendar transferência
          • Efetuar transferência
          • Listar status de transferência
          • Listar devoluções
          • Listar transferências
          • Listar agendamentos de transferências
        • Relatórios
          • Listar operações
          • Listar relatórios de assinaturas
          • Listar adesões
        • QR Code
          • Criar QR Code estático
          • Decodificar QR Code
        • Chaves
          • Confirmar reivindicações
          • Fazer reivindicação
          • Cadastrar chave
          • Deletar chave
          • Listar chaves
          • Consultar chaves pelo identificador
          • Listar reivindicações
        • Limites
          • Criar limite de horário
          • Associar conta a grupo de serviço
          • Listar destinos confiáveis
          • Alterar limite do destino confiável
          • Listar limites de horários
          • Listar requisições
          • Remover destino confiável
      • Portadores
        • Gestão de portadores
          • Listar status do portador pelo CPF
          • Listar portadores
          • Alterar dados do portador
          • Alterar status de ativo problemático
          • Listar informações do portador
          • Alterar o limite do portador
          • Bloquear um portador
          • Desbloquear um portador
          • Listar adicionais pelo CPF
          • Listar portadores em lote
          • Listar contas pelo CPF (simplificado)
          • Listar contas pelo CNPJ
          • Alterar produto do portador
          • Listar contas pelo documento
          • Listar contas pelo RG
          • Listar contas pelo nome
          • Alterar vipagem
          • Consultar ciclo do portador
          • Listar contas pelo CPF (completo)
        • Gestão de dependentes
          • Listar dependentes pelo titular
          • Cadastrar dependentes
        • Gestão de telefones
          • Listar telefones
          • Cadastrar telefone
          • Deletar telefone
          • Receber SMS
        • Visualização de histórico
          • Listar histórico do portador
          • Listar ocorrências
          • Listar inadimplências pelo portador
          • Listar o histórico de limites
        • Gestão de senhas
          • Enviar senha por SMS
          • Alterar senha do portador
        • Cadastro de contas
          • Cadastrar uma conta PJ
          • Cadastrar uma conta PF
        • Informações da base de dados
          • Listar tipos de bloqueio
          • Listar escolaridades
          • Listar ocupações
        • BNPL
          • Consultar informações do portador
      • Portuno
        • Conta
          • Listar conta
          • Criar uma conta
          • Trocar o segredo da conta
        • Integração
          • Listar integrações
          • Alterar tempo de expiração de uma integração
      • Produtos
        • Produtos
          • Consultar produtos
          • Consultar um produto
        • Serviços financeiros
          • Listar serviços financeiros
      • Regulatório
        • Listar informações
      • Recompensa
        • Aderir à anuidade bonificada
        • Cancelar anuidade bonificada
        • Listar anuidades do produto
        • Listar anuidade do portador
        • Listar anuidades
        • Listar as anuidades
        • Cadastrar anuidades
      • Serviços Bancários
        • Registrar um boleto online
        • Listar pagamentos
        • Listar boleto completo
        • Listar contas habilitadas
      • Seguros
        • Seguros
          • Cancelar adesão do titular
          • Aderir seguro para o titular
          • Aderir seguro para dependente
          • Cancelar adesão do dependente
          • Listar seguros de dependentes
          • Listar seguros disponíveis
          • Cancelar um seguro
          • Listar seguros do portador
          • Listar campos de adesão ao seguro
          • Listar campos de adesão do portador
          • Listar seguros cancelados
        • Bilhetes de Seguro
          • Listar bilhetes de um portador
          • Listar o modelo de operação
          • Listar um bilhete de adesão
        • Cobranças e Pagamentos
          • Fazer estímulo de cobrança
        • Termos da Adesão
          • Listar termos de adesão
          • Listar modelos do código de operação
          • Listar termos de um seguro
      • SMS Notice
        • Processamento
          • Listar os eventos
          • Criar um evento
          • Alterar um evento
          • Listar as variáveis
          • Criar variáveis
          • Listar as transações
          • Criar mensagem para fila
        • Serviços
          • Criar um serviço de SMS
          • Listar serviços cadastrados
          • Alterar um serviço de SMS
          • Listar um serviço específico
        • Pacote de SMS
          • Listar os pacotes de sms
          • Cadastrar pacote SMS
          • Listar um pacote específico
          • Alterar um pacote específico
          • Aderir a um pacote SMS
          • Cancelar uma adesão
          • Listar adesões de um portador
          • Alterar o telefone do pacote
  1. Pix

Listar transferências Pix

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
GET
https://horizon-api-sb.app.rpe.tech
/api/v1/banking/pix/transferencias/listar
Use este endpoint para listar as transferências pix.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/banking/pix/transferencias/listar?date&from&to&page&sort&limit&idAccount&idEndToEnd&idTx&transactionCode&transactionType&transactionUUID&transferType&transactionStatus' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "totalItems": 207,
    "previousPage": 1,
    "last": false,
    "nextPage": 2,
    "maxItemsPerPage": 50,
    "totalItemsPage": 20,
    "totalPages": 11,
    "currentPage": 1,
    "items": [
        {
            "idTransacao": 234,
            "idContaEmissor": 345,
            "idAccount": 12,
            "idEndToEnd": "000000001320230329T1219469887051",
            "transactionDate": "2023-03-29T15:19:52.754Z",
            "transactionType": "TRANSFER_DEBIT",
            "transactionStatus": "EXECUTED",
            "transferType": 0,
            "amount": 0.01,
            "tariffAmount": 0,
            "finalAmount": 0.01,
            "idAdjustment": 1283,
            "transactionCode": "6e5d8275-94e3-4710-8ac8-85f0650141a0",
            "tariffTransactionCode": "0",
            "idTx": "DOCK202001030000000000001",
            "pixType": "TRANSFER",
            "name": "Mascarado",
            "purchaseAmount": 20,
            "changeAmount": 0,
            "agentWithdrawalIspb": "3456",
            "agentMode": "AGPSS",
            "taxIdPaymentInitiator": 0
        }
    ]
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Query
date
string <date>
opcional
Data para pesquisa da transferência, no formato YYYY-MM-DD.
Exemplo:
2024-06-09
from
string <date-time>
opcional
Data de início da pesquisa das transferências.
Exemplo:
2025-01-01T08:07:27.874Z
to
string <date-time>
opcional
Data de fim da pesquisa das transferências.
Exemplo:
2024-12-01T08:07:27.874Z
page
integer <int32>
opcional
Páginas para pesquisa.
Padrão:
0
Exemplo:
3
sort
enum<string> 
opcional
Ordenação da pesquisa.
Valores permitidos:
ASCDESC
Padrão:
DESC
Exemplo:
ASC
limit
integer <int32>
opcional
Limite da pesquisa.
<= 100
Padrão:
20
Exemplo:
4
idAccount
integer <int32>
opcional
Identificador da conta bancária.
>= 1<= 14
Exemplo:
2001
idEndToEnd
string 
opcional
Identificador end-to-end.
<= 3 Caracteres
Exemplo:
123
idTx
string 
opcional
Identificador do recipiente.
>= 25 Caracteres<= 35 Caracteres
Exemplo:
ef02e3e027114aeeb76efa19a5f121d2
transactionCode
string 
opcional
Código da transação.
<= 36 Caracteres
Exemplo:
ff19b593-01f4-4550-9af1-d1d42f8146cb
transactionType
enum<string> 
opcional
Tipo da transação.
Valores permitidos:
TRANSFER_DEBITTRANSFER_CREDIT
Exemplo:
TRANSFER_DEBIT
transactionUUID
string 
opcional
Identificador externo, dado de lançamento único.
Exemplo:
ff93824jf9834k9
transferType
enum<string> 
opcional
Tipo da transferência.
Valores permitidos:
MANUALKEYSTATIC_CODEDYNAMIC_QR_CODE
Exemplo:
MANUAL
transactionStatus
enum<string> 
opcional
Status da transferência.
Valores permitidos:
EXECUTEDNOT_EXECUTEDPENDINGREVERSAL_EXECUTED
Exemplo:
EXECUTED
Parâmetros Header
Accept
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
OK
Body
totalItems
integer 
opcional
Total de itens na pesquisa.
Exemplo:
207
previousPage
integer 
opcional
Página anterior.
Exemplo:
1
last
boolean 
opcional
Identifica se é a última.
Exemplo:
false
nextPage
integer 
opcional
Próxima página.
Exemplo:
2
maxItemsPerPage
integer 
opcional
Quantidade máxima de itens por página.
Padrão:
50
Exemplo:
20
totalItemsPage
integer 
opcional
Total de itens por página.
Exemplo:
20
totalPages
integer 
opcional
Total de páginas.
Exemplo:
11
currentPage
integer 
opcional
Página atual.
Exemplo:
1
items
array [object {22}] 
opcional
Informações da pesquisa.
idTransacao
integer <int64>
opcional
Identificador da transação.
Exemplo:
234
idContaEmissor
integer <int32>
opcional
Identificador da conta do emissor.
Exemplo:
345
idAccount
integer 
opcional
Identificador da conta.
>= 1<= 14
Exemplo:
12
idEndToEnd
string 
opcional
Identificador end-to-end.
<= 32 Caracteres
Exemplo:
000000001320230329T1219469887051
transactionDate
string 
opcional
Data da transação.
Exemplo:
2023-03-29T15: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
enum<integer> 
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:
0
amount
number <double>
opcional
Valor da transferência.
<= 10
Exemplo:
0.01
tariffAmount
number <double>
opcional
Valor das taxas.
<= 10
Exemplo:
0
finalAmount
number <double>
opcional
Valor final da transferência.
<= 10
Exemplo:
0.01
idAdjustment
integer 
opcional
Identificador do ajuste.
>= 0
Exemplo:
1283
transactionCode
string 
opcional
Código da transação. Gerado mesmo se o pagamento não for efetuado.
<= 36 Caracteres
Exemplo:
6e5d8275-94e3-4710-8ac8-85f0650141a0
tariffTransactionCode
string 
opcional
Código de transação tarifária
Exemplo:
0
idTx
string 
opcional
Identificador para conciliação do recebedor.
>= 25 Caracteres<= 35 Caracteres
Exemplo:
DOCK202001030000000000001
pixType
enum<string> 
opcional
Tipo da transferência pix.
TRANSFER = Transferência
CHANGE = Troco
WITHDRAWAL = Resgate
Valores permitidos:
TRANSFERCHANGEWITHDRAWAL
Padrão:
TRANSFER
Exemplo:
TRANSFER
name
string 
opcional
Se transactionType = TRANSFER_DEBIT o campo retorna o nome do beneficiário.
Se transactionType = TRANSFER_CREDIT, o campo retorna o nome do pagador.
<= 250 Caracteres
Exemplo:
Mascarado
purchaseAmount
number <double>
opcional
Valor de compra. Exclui descontos, taxas e juros.
Exemplo:
20
changeAmount
number <double>
opcional
Valor disponível para compra.
Exemplo:
0
agentWithdrawalIspb
string 
opcional
Número do Identificador de Sistema de Pagamentos Brasileiro do agente de retirada.
Exemplo:
3456
agentMode
<string>
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
taxIdPaymentInitiator
number <double>
opcional
Identificador da taxa inicial de pagamento.
Exemplo:
0
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Listar status do pix
Próxima página
Listar informações de chave