Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Consulta de Saldo da Cobrança.
All
Pages
Start typing to search…
JUMP TO
Cobranças para Pagamento Imediato
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Cobranças para Pagamento Imediato
Lista de contas associadas à loja
get
Criar uma cobrança para pagamentos imediatos
post
Retornar status da cobrança na Shipay
get
Cancelar uma cobrança pendente
del
Realizar devolução do pagamento de uma cobrança
del
Cobranças Pix com Expiração Variável
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Cobranças Pix com Expiração Variável
Lista de contas associadas à loja
get
Criar uma Cobrança Pix com Expiração Variável
post
Retornar status da cobrança na Shipay
get
Retornar uma lista de cobranças
get
Cancelar uma cobrança pendente.
del
Realizar devolução do pagamento de uma Cobrança
del
Gerenciamento de Cobranças em Lote
Criar Lote de Cobranças com Expiração Variável
post
Retornar uma lista de lotes
get
Retornar um Lote Específico
get
Pix Automático para pagamentos Recorrentes
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de autorizações para pagamentos recorrentes
Criação de autorização
post
Consulta de autorização específica
get
Atualização de dados da autorização
patch
Cancelamento de autorização
del
Consulta de autorizações em lista
get
Serviços complementares
Retornar edições de uma autorização.
get
Retornar uma lista de Cobranças Recorrentes
get
Cancelamento em lista para cobranças futuras
del
Atualização de dados de cobrança recorrente
patch
Cancelamento de Cobrança recorrente
del
Retorna autorizações atualizadas recentemente
get
Cobranças Pix com Vencimento
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Gerenciamento de Cobranças Pix com Vencimento
Lista de contas associadas à loja
get
Criar uma Cobrança Pix com Vencimento
post
Retornar status da cobrança na Shipay
get
Retornar uma lista de cobranças
get
Realizar Devolução do pagamento de uma Cobrança
del
Cancelar uma cobrança pendente.
patch
Boleto Híbrido
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Boletos Híbridos
Lista de contas associadas à loja
get
Registrar um Boleto Híbrido
post
Recuperar as informações de Boletos Híbridos
get
Retornar uma lista de cobranças
get
Retornar Status do Boleto na Shipay
get
Alterar dados ou realizar baixa de Boleto Híbrido
patch
Gerenciamento de Boletos em Lote
Criar Lote de Cobranças com Boleto Híbrido
post
Retornar uma Lista de Lotes
get
Retornar um Lote Específico
get
Envio de pagamentos via Pix
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Pagamentos
Lista de contas associadas à loja
get
Solicitação de Criação de Pagamento
post
Consulta de Status de Criação de Pagamento
get
Consulta de Saldo da Cobrança.
get
Cobranças com Pix Saque e Pix Troco
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Cobranças Pix Saque e Pix Troco
Lista de contas associadas à loja
get
Criar uma Cobrança com Pix Saque e Pix Troco
post
Retornar status da cobrança na Shipay
get
Realizar Devolução de Troco
del
Realizar Devolução de Saque
del
Realizar devolução de produtos ou serviços
del
Serviços transacionais complementares
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Atualizar o Token de Acesso
post
Gerenciamento de Deeplinks
Lista de links de redirecionamento
get
Gerenciamento de Locations
Criar uma nova location
post
Consultar lista de locations
get
Consultar uma location específica
get
Desassociar cobrança de uma location
patch
Comparador de dados transacionais
Comparar dados do devedor e pagador.
get
Cadastro
Serviços de autenticação
Autenticação por sistema para acesso aos serviços
post
Atualizar o Token de Acesso
post
Gerenciamento de cadastro
Consultar Termos e Condições
get
Consultar Cidades
get
Consultar Unidades Federativas
get
Realizar Cadastro via API
post
Criar uma nova Loja via API
post
Criar um novo Caixa via API
post
Consultar Lojas por Cliente
get
Consultar Caixas por Loja
get
Conciliação
Serviços de autenticação
Autenticação para acesso aos serviços transacionais
post
Autenticação por sistema para acesso aos serviços
post
Atualizar o Token de Acesso
post
Gerenciamento de intenção de conciliação
Criar intenção de concilição
post
Consulta de informações da intenção
get
Inativar intenção de conciliação
del
Conciliação Pix Qualquer Banco
Lista de transações Pix conciliadas
get
Proxy da API de Pix recebidos
Proxy API Pix recebidos
get
Powered by
Consulta de Saldo da Cobrança.
Ask AI
get
https://apis-staging.shipay.com.br/v1/balance
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
