Cadastrar e Gerenciar Webhooks
Nossa API de BaaS possui o modulo de Gerenciamento de Webhook, com esses serviços você consegue administrar suas rotas de Webhook sem precisar acionar o time da Celcoin, esse modulo contempla os seguintes serviços:
Confira o tutorial desse módulo
Eventos disponíveis.
Onboarding
| Evento | Descrição |
|---|---|
| onboarding-backgroundcheck | Evento que informa o status do processo de Backgroundcheck |
| onboarding-documentscopy | Evento que informa o status do processo de Documentoscopia |
| onboarding-file | Evento que envia a URL que contém os documentos enviados pelo cliente na jornada - Esse evento será enviado após o webhook onboarding-documentscopy com status Processing |
| onboarding-proposal | Evento que informa o resultado da proposta, status Approved ou Reproved. |
| onboarding-create | Evento responsável por receber informações de uma conta nova |
KYC V1 (Descontinuado)
| Evento | Descrição |
|---|---|
| onboarding-create | Evento responsável por receber informações de uma conta nova |
| kyc | Evento responsável por receber informações do resultado do KYC de uma conta |
Transferência entre contas (P2P)
| Evento | Descrição |
|---|---|
| internal-transfer-in | Evento responsável por receber informações de um recebimento de uma Transferência Interna |
| internal-transfer-out | Evento responsável por receber informações de um envio de uma Transferência Interna |
Pix
| Evento | Descrição |
|---|---|
| pix-payment-out | Evento responsável por receber informações de um pix cashout |
| pix-payment-in | Evento responsável por receber informações de um pix cashin |
| pix-reversal-in | Evento responsável por receber informações de um pix reversal-in |
| pix-reversal-out | Evento responsável por receber informações de um pix reversal-out |
Portabilidade e reivindicação de chave Pix
| Evento | Descrição |
|---|---|
| pix-dict-claim-open | Evento responsável por receber informações de status de uma portabilidade de chaves Pix |
| pix-dict-claim-waiting | Evento responsável por receber informações de status de uma portabilidade de chaves Pix |
| pix-dict-claim-confirmed | Evento responsável por receber informações de status de uma portabilidade de chaves Pix |
| pix-dict-claim-cancelled | Evento responsável por receber informações de status de uma portabilidade de chaves Pix |
| pix-dict-claim-completed | Evento responsável por receber informações de status de uma portabilidade de chaves Pix |
TED
| Evento | Descrição |
|---|---|
| spb-transfer-out (TED) | Evento responsável por receber informações de um TED cashout |
| spb-transfer-in (TED) | Evento responsável por receber informações de um TED cashin |
| spb-reversal-in (TED) | Evento responsável por receber informações de um TED reversal-in |
| spb-reversal-out (TED) | Evento responsável por receber informações de um TED reversal-out |
Cobranças Avulsas (Geração de boleto)
| Evento | Descrição |
|---|---|
| charge-in | Evento responsável por receber informações do pagamento de uma cobrança |
| charge-create | Evento responsável por receber informações de criação de uma cobrança |
Pagamento de contas
| Evento | Descrição |
|---|---|
| billpayment | Evento responsável por receber informações de um pagamento de boleto realizado com sucesso |
| billpayment-occurrence | Evento responsável por receber informações de um pagamento de Boleto realizado com Erro |
Recargas
| Evento | Descrição |
|---|---|
| topup | Evento responsável por receber informações de uma efetivação de recarga |
Recebimento de liquidações do arranjo de cartões via SLC (Domicílio Bancario)
| Evento | Descrição |
|---|---|
| slc-payment-in | Evento responsável por receber informações de um recebimento de recebíveis do arranjo de pagamentos de cartões por meio do SLC |
Bloqueios Judiciais
| Evento | Descrição |
|---|---|
| judicial-movement-in | Evento disparado sempre que um valor bloqueado na conta do cliente for liberado |
| judicial-movement-out | Evento disparado sempre que um novo valor for bloqueado na conta do cliente por ordem judicial. |
1. Cadastrar Webhook
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Cadastrar Webhook - [API Reference]
Descrição dos campos da chamada
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| entity | string | Identificador do Evento. |
| webhookUrl | string | webhookUrl. |
| auth | objeto | Dados de autenticação do Webhook. |
| login | string | Login para Webhook. |
| pwd | string | Senha para Webhook. |
| type | string | Tipo de autenticação. Atualmente só está disponível a autenticação basic. |
JSON da chamada
{
"entity": "pix-payment-out",
"webhookUrl": "https://www.celcoin.com.br/baas",
"auth": {
"login": "string",
"pwd": "string",
"type": "basic"
}
}
cURL da Chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas-webhookmanager/v1/webhook/subscription' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"entity": "pix-payment-out",
"webhookUrl": "https://www.celcoin.com.br/baas",
"auth": {
"login": "string",
"pwd": "string",
"type": "basic"
}
}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE205 | Cliente já possui webhook cadastrado com esse evento |
| CBE206 | entity é obrigatório. |
| CBE207 | webhookUrl é obrigatorio e deve ser uma url valida. |
| CBE208 | O evento informado não existe. |
| CBE209 | Esse tipo de autenticação não está disponível no momento. |
| CBE211 | Esse tipo de autenticação não existe. |
| CBE212 | auth.login é obrigatorio. |
| CBE213 | auth.pwd é obrigatorio. |
| CBE214 | Não é permitido cadastrar esse webhook para Virtual BaaS. |
| CBE216 | auth.type é obrigatorio. |
2. Consultar Webhooks cadastrados
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Consultar Webhooks cadastrados - [API Reference]
cURL da Chamada
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas-webhookmanager/v1/webhook/subscription' \
--header 'Authorization: Bearer {{token}}'
Você pode buscar um status especifico utilizando os seguintes parâmetros:
Entity -> Identificador do Evento.
Active -> true ou false
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"entity": "string",
"webhookUrl": "string",
"active": true,
"createDate": "2023-03-06T12:02:48.419Z",
"lastUpdateDate": "2023-03-06T12:02:48.419Z",
"auth": {
"login": "string",
"pwd": "string",
"type": "string"
}
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
3. Atualizar Webhook
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Atualizar Webhook cadastrado - [API Reference]
cURL da Chamada
curl --location --request PUT 'https://sandbox.openfinance.celcoin.dev/baas-webhookmanager/v1/webhook/subscription/pix-payment-out' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"webhookUrl": "string",
"auth": {
"login": "login",
"pwd": "password",
"type": "basic"
},
"active": true,
"subscriptionId": "64a340b7987ab1220a72ab66"
}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
4. Excluir Webhook
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Excluir Webhook cadastrado - [API Reference]
cURL da Chamada
curl --location --request DELETE 'https://sandbox.openfinance.celcoin.dev/baas-webhookmanager/v1/webhook/subscription/pix-payment-out?SubscriptionId=64a340b7987ab1220a72ab66' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Updated 18 days ago