Banking API
Search…
DICT
Nesta seção estão descritas as APIs que gerenciam o ciclo de vida do produto Pix - DICT de banking.

A rota da API para sandbox é: https://apigw-sandbox.zoop.ws/v2

Não se deve usar o 2FA em sandbox.
As Funcionalidades de Pix estão liberadas em sandbox. Todos os endpoints citados abaixo são para fim de teste e documentação.
Para uso em produção, é obrigatório o uso da 2FA.

DICT

O Diretório de Identificadores de Contas Transacionais (DICT) é o componente do Pix que armazenará as informações das chaves ou apelidos que servem para identificar as contas transacionais dos usuários recebedores de maneira intuitiva e simplificada, permitindo que o usuário pagador utilize informações que ele já possui sobre o usuário recebedor para iniciar o pagamento.
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries
Criar chave de endereçamento
{
"value":"[email protected]",
"type":"EMAIL"
}
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries/:entry_id/ownership
Confirmar propriedade de chave de endereçamento
{
"code":"4040"
}
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries/:entry_id/ownership/resend
Reenviar código de verificação de propriedade de chave de endereçamento
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries/:entry_id
Buscar vinculo com chave de endereçamento
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:accounts_id/entries
Listar vínculos com chaves de endereçamento
put
https://api.zoop.ws
/v3/marketplaces/:marketplace_id:/banking/dict/holders/:holder_id:/accounts/:account_id/entries/:entry_id
Alterar vínculo da chave de endereçamento
delete
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries/:entry_id
Excluir vínculo com chave de endereçamento

Reivindicação

Nessa seção será listada os endpoints que controlam a reivindicação da chave do Pix.
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/claims
Criar reivindicação
{
"claim_type":"ownership",
"key":{
"value":"[email protected]",
"type":"EMAIL"
}
}
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/entries/:entry_id/claims/
Criar reivindicação a partir de uma entry
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/claims/:claim_id/cancel
Cancelar reivindicação
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/claims/:claim_id/confirm
Confirmar reivindicação
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/claims/:claim_id
Buscar reivindicação
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/dict/holders/:holder_id/accounts/:account_id/claims
Listar reivindicações