DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Cadastrar e Gerenciar Webhooks

Suggest Edits

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.

EventoDescrição
onboarding-createEvento responsável por receber informações de uma conta nova
pix-payment-outEvento responsável por receber informações de um pix cashout
pix-payment-inEvento responsável por receber informações de um pix cashin
pix-reversal-inEvento responsável por receber informações de um pix reversal-in
pix-reversal-outEvento responsável por receber informações de um pix reversal-out
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
internal-transfer-inEvento responsável por receber informações de um recebimento de uma Transferência Interna
internal-transfer-outEvento responsável por receber informações de um envio de uma Transferência Interna
charge-inEvento responsável por receber informações do pagamento de uma cobrança
charge-createEvento responsável por receber informações de criação de uma cobrança
kycEvento responsável por receber informações do resultado do KYC de uma conta
pix-dict-claim-openEvento responsável por receber informações de status de uma portabilidade de chaves Pix
pix-dict-claim-waitingEvento responsável por receber informações de status de uma portabilidade de chaves Pix
pix-dict-claim-confirmedEvento responsável por receber informações de status de uma portabilidade de chaves Pix
pix-dict-claim-cancelledEvento responsável por receber informações de status de uma portabilidade de chaves Pix
pix-dict-claim-completedEvento responsável por receber informações de status de uma portabilidade de chaves Pix
billpaymentEvento responsável por receber informações de um pagamento de boleto realizado com sucesso
billpayment-occurrenceEvento responsável por receber informações de um pagamento de Boleto realizado com Erro

1. Cadastrar Webhook

Passos para integrar

  1. Realizar autenticação na API - [API Reference]
  2. Cadastrar Webhook - [API Reference]

Descrição dos campos da chamada

Nome do CampoTipoDescrição
entitystringIdentificador do Evento.
webhookUrlstringwebhookUrl.
authobjetoDados de autenticação do Webhook.
loginstringLogin para Webhook.
pwdstringSenha para Webhook.
typestringTipo 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

CodeMessage
CBE205Cliente já possui webhook cadastrado com esse evento
CBE206entity é obrigatório.
CBE207webhookUrl é obrigatorio e deve ser uma url valida.
CBE208O evento informado não existe.
CBE209Esse tipo de autenticação não está disponível no momento.
CBE211Esse tipo de autenticação não existe.
CBE212auth.login é obrigatorio.
CBE213auth.pwd é obrigatorio.
CBE214Não é permitido cadastrar esse webhook para Virtual BaaS.
CBE216auth.type é obrigatorio.

2. Consultar Webhooks cadastrados

Passos para integrar

  1. Realizar autenticação na API - [API Reference]
  2. 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

  1. Realizar autenticação na API - [API Reference]
  2. 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

  1. Realizar autenticação na API - [API Reference]
  2. 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 about 2 months ago