Cobranças para Pagamento Imediato

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças para Pagamento Imediato

Cobranças Pix com Expiração Variável

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix com Expiração Variável
Gerenciamento de Cobranças em Lote

Cobranças Pix com Vencimento

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix com Vencimento

Boleto Híbrido

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Boletos Híbridos
Gerenciamento de Boletos em Lote

Envio de pagamentos via Pix

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Pagamentos

Cobranças com Pix Saque e Pix Troco

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix Saque e Pix Troco

Serviços transacionais complementares

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Deeplinks
- Lista de links de redirecionamentoget
Gerenciamento de Locations
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çospost
- Atualizar o Token de Acessopost
Gerenciamento de cadastro

Conciliação

Serviços de autenticação
Gerenciamento de intenção de conciliação
Conciliação Pix Qualquer Banco
- Lista de transações Pix conciliadasget
Proxy da API de Pix recebidos
- Proxy API Pix recebidosget

Cobranças para Pagamento Imediato

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças para Pagamento Imediato

Cobranças Pix com Expiração Variável

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix com Expiração Variável
Gerenciamento de Cobranças em Lote

Cobranças Pix com Vencimento

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix com Vencimento

Boleto Híbrido

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Boletos Híbridos
Gerenciamento de Boletos em Lote

Envio de pagamentos via Pix

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Pagamentos

Cobranças com Pix Saque e Pix Troco

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Cobranças Pix Saque e Pix Troco

Serviços transacionais complementares

Serviços de autenticação
- Autenticação para acesso aos serviços transacionaispost
- Atualizar o Token de Acessopost
Gerenciamento de Deeplinks
- Lista de links de redirecionamentoget
Gerenciamento de Locations
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çospost
- Atualizar o Token de Acessopost
Gerenciamento de cadastro

Conciliação

Serviços de autenticação
Gerenciamento de intenção de conciliação
Conciliação Pix Qualquer Banco
- Lista de transações Pix conciliadasget
Proxy da API de Pix recebidos
- Proxy API Pix recebidosget

Lista de contas associadas à loja

get https://apis-staging.shipay.com.br/v1/wallets

Este serviço retorna a lista de contas associadas à loja cadastrada no Painel Shipay.

Pode ser utilizado para selecionar a conta que deseja utilizar para criar a cobrança, tendo a possibilidade de utilizar mais de uma conta por loja..

Headers

authorization

string

required

Token de autorização do serviço de autenticação /pdvauth ou /pdvsysauth.

Responses

Response body

array of objects

object

logo

string

Logo da conta associada.

friendly_name

string

Nome amigável da conta associada.

pix_dict_key

string

Chave Pix da conta bancária cadastrada na Shipay.

wallet_setting_id

string

Identificador da conta associada na Shipay.

active

boolean

Status da conta associada na Shipay.

pix_psp

string

Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança Pix foi gerada.

bb bnb bradesco bs2 itau itau_anybank itau_anybank_v2 mercadopago pagseguro picpay_anybank santander sicredi sicoob tbanks

transaction_type

string

Descrição se a conta é cash-in ou cash-out.

wallet

string

Tipo da conta associada na Shipay. No caso de Pix, o valor desse campo é "pix", independente do provedor de serviço de pagamentos (PSP).

foxbit coinpayments mercadopago pagseguro picpay tecban pix

wallet_setting_name

string

Apelido da conta que foi configurada no Painel Shipay.

minimum_payment

float

Valor mínimo da cobrança para a conta associada.

default

boolean

Se a conta associada estiver como "Pix padrão na loja autenticada, retornará "true".

Response body

object

code

integer

Código de erro.

message

string

Mensagem de erro.

Response body

object

code

integer

Código de erro.

message

string

Mensagem de erro.

Updated about 2 months ago

Atualizar o Token de Acesso

Solicitação de Criação de Pagamento

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apis-staging.shipay.com.br/v1/wallets \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Atualizar o Token de Acesso

Solicitação de Criação de Pagamento

Did this page help you?

Cobranças para Pagamento Imediato
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças para Pagamento Imediato
Realizar devolução do pagamento de uma cobrançadelete
Cancelar uma cobrança pendentedelete
Retornar status da cobrança na Shipayget
Criar uma cobrança para pagamentos imediatospost
Lista de contas associadas à lojaget

Cobranças Pix com Expiração Variável
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix com Expiração Variável
Realizar devolução do pagamento de uma Cobrançadelete
Cancelar uma cobrança pendente.delete
Retornar uma lista de cobrançasget
Retornar status da cobrança na Shipayget
Criar uma Cobrança Pix com Expiração Variávelpost
Lista de contas associadas à lojaget
Gerenciamento de Cobranças em Lote
Retornar um Lote Específicoget
Retornar uma lista de lotesget
Criar Lote de Cobranças com Expiração Variávelpost

Cobranças Pix com Vencimento
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix com Vencimento
Cancelar uma cobrança pendente.patch
Realizar Devolução do pagamento de uma Cobrançadelete
Retornar uma lista de cobrançasget
Retornar status da cobrança na Shipayget
Criar uma Cobrança Pix com Vencimentopost
Lista de contas associadas à lojaget

Boleto Híbrido
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Boletos Híbridos
Alterar dados ou realizar baixa de Boleto Híbridopatch
Retornar Status do Boleto na Shipayget
Retornar uma lista de cobrançasget
Recuperar as informações de Boletos Híbridosget
Registrar um Boleto Híbridopost
Lista de contas associadas à lojaget
Gerenciamento de Boletos em Lote
Retornar um Lote Específicoget
Retornar uma Lista de Lotesget
Criar Lote de Cobranças com Boleto Híbridopost

Envio de pagamentos via Pix
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Pagamentos
Consulta de Saldo da Cobrança.get
Consulta de Status de Criação de Pagamentoget
Solicitação de Criação de Pagamentopost
Lista de contas associadas à lojaget

Cobranças com Pix Saque e Pix Troco
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix Saque e Pix Troco
Realizar devolução de produtos ou serviçosdelete
Realizar Devolução de Saquedelete
Realizar Devolução de Trocodelete
Retornar status da cobrança na Shipayget
Criar uma Cobrança com Pix Saque e Pix Trocopost
Lista de contas associadas à lojaget

Serviços transacionais complementares
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Deeplinks
Lista de links de redirecionamentoget
Gerenciamento de Locations
Desassociar cobrança de uma locationpatch
Consultar uma location específicaget
Consultar lista de locationsget
Criar uma nova locationpost
Comparador de dados transacionais
Comparar dados do devedor e pagador.get

Cadastro
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação por sistema para acesso aos serviçospost
Gerenciamento de cadastro
Consultar Caixas por Lojaget
Consultar Lojas por Clienteget
Criar um novo Caixa via APIpost
Criar uma nova Loja via APIpost
Realizar Cadastro via APIpost
Consultar Unidades Federativasget
Consultar Cidadesget
Consultar Termos e Condiçõesget

Conciliação
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação por sistema para acesso aos serviçospost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de intenção de conciliação
Inativar intenção de conciliaçãodelete
Consulta de informações da intençãoget
Criar intenção de conciliçãopost
Conciliação Pix Qualquer Banco
Lista de transações Pix conciliadasget
Proxy da API de Pix recebidos
Proxy API Pix recebidosget

Cobranças para Pagamento Imediato
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças para Pagamento Imediato
Realizar devolução do pagamento de uma cobrançadelete
Cancelar uma cobrança pendentedelete
Retornar status da cobrança na Shipayget
Criar uma cobrança para pagamentos imediatospost
Lista de contas associadas à lojaget

Cobranças Pix com Expiração Variável
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix com Expiração Variável
Realizar devolução do pagamento de uma Cobrançadelete
Cancelar uma cobrança pendente.delete
Retornar uma lista de cobrançasget
Retornar status da cobrança na Shipayget
Criar uma Cobrança Pix com Expiração Variávelpost
Lista de contas associadas à lojaget
Gerenciamento de Cobranças em Lote
Retornar um Lote Específicoget
Retornar uma lista de lotesget
Criar Lote de Cobranças com Expiração Variávelpost

Cobranças Pix com Vencimento
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix com Vencimento
Cancelar uma cobrança pendente.patch
Realizar Devolução do pagamento de uma Cobrançadelete
Retornar uma lista de cobrançasget
Retornar status da cobrança na Shipayget
Criar uma Cobrança Pix com Vencimentopost
Lista de contas associadas à lojaget

Boleto Híbrido
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Boletos Híbridos
Alterar dados ou realizar baixa de Boleto Híbridopatch
Retornar Status do Boleto na Shipayget
Retornar uma lista de cobrançasget
Recuperar as informações de Boletos Híbridosget
Registrar um Boleto Híbridopost
Lista de contas associadas à lojaget
Gerenciamento de Boletos em Lote
Retornar um Lote Específicoget
Retornar uma Lista de Lotesget
Criar Lote de Cobranças com Boleto Híbridopost

Envio de pagamentos via Pix
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Pagamentos
Consulta de Saldo da Cobrança.get
Consulta de Status de Criação de Pagamentoget
Solicitação de Criação de Pagamentopost
Lista de contas associadas à lojaget

Cobranças com Pix Saque e Pix Troco
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Cobranças Pix Saque e Pix Troco
Realizar devolução de produtos ou serviçosdelete
Realizar Devolução de Saquedelete
Realizar Devolução de Trocodelete
Retornar status da cobrança na Shipayget
Criar uma Cobrança com Pix Saque e Pix Trocopost
Lista de contas associadas à lojaget

Serviços transacionais complementares
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de Deeplinks
Lista de links de redirecionamentoget
Gerenciamento de Locations
Desassociar cobrança de uma locationpatch
Consultar uma location específicaget
Consultar lista de locationsget
Criar uma nova locationpost
Comparador de dados transacionais
Comparar dados do devedor e pagador.get

Cadastro
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação por sistema para acesso aos serviçospost
Gerenciamento de cadastro
Consultar Caixas por Lojaget
Consultar Lojas por Clienteget
Criar um novo Caixa via APIpost
Criar uma nova Loja via APIpost
Realizar Cadastro via APIpost
Consultar Unidades Federativasget
Consultar Cidadesget
Consultar Termos e Condiçõesget

Conciliação
Serviços de autenticação
Atualizar o Token de Acessopost
Autenticação por sistema para acesso aos serviçospost
Autenticação para acesso aos serviços transacionaispost
Gerenciamento de intenção de conciliação
Inativar intenção de conciliaçãodelete
Consulta de informações da intençãoget
Criar intenção de conciliçãopost
Conciliação Pix Qualquer Banco
Lista de transações Pix conciliadasget
Proxy da API de Pix recebidos
Proxy API Pix recebidosget

200Order Refunded.

401Unauthorized.

500Error creating the order.