Cadastrar e Gerenciar Webhooks
Nossa API 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:
- Cadastrar Webhook
- Consultar Webhooks cadastrados
- Atualizar Webhook
- Excluir Webhook
Eventos disponíveis
| Evento | Descrição |
|---|---|
| account-created | Evento disparado sempre que uma conta for criada. |
| card-created | Evento disparado sempre que um cartão for criado ou reemitdo. |
| transaction-approved | Evento disparado quando uma transação for aprovada. |
| transaction-refusal | Evento disparado quando uma transação for recusada. |
| card-in-transit | Evento disparado quando um cartão está em rota de entrega. |
| card-delivered | Evento disparado quando um cartão foi entregue |
1. Cadastrar Webhook
Passos para integrar
- Realizar autenticação na API - [API Reference]
- Cadastrar o 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. |
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": "account-created",
"webhookUrl": "https://www.suaurldewebhook.com",
"auth": {
"login": "Seu usuario",
"pwd": "sua senha",
"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 3 days ago