Cadastrar Webhooks de Chargeback

Para receber informações das contestações realizadas pelos clientes, é necessário cadastrar um webhook. Dessa forma, você passa a receber as atualizações referentes ao chargeback.

Para cadastrar um webhook, é necessário realizar uma chamada na api Cadastrar Webhook Chargeback utilizando o método PUT, onde precisa ser preenchido algumas informações, como URL e o evento relacionado. Os dados necessários estão no quadro "Parâmetros do Body"

Modelo de requisição:

curl --location --request PUT 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/webhooks' \
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://website.com.br/webhook-celcoin-sub",
    "events": [
        "chargeback.update"
    ]
}
'

Parâmetros do Body:

Campo

Descrição

Tipo

url

URL do Webhook.

String (255)

events

Array de eventos a serem ativados. Valores possíveis:

  • chargeback.update Será enviado quando uma abertura de disputa for criada no sistema. Vai conter todos os dados da entidade Chargeback, além de conter alguns dados da entidade Transaction e PaymentBill.

Array String

Modelo de retorno: necessário validar retorno de sucesso

{
    "type": true,
    "confirmHash": "19b3e0a42152d126cbe1512022714a8b",
    "events": [
        "chargeback.update"
    ]
}

Note que essa api é síncrona, sendo assim, a Celcoin irá retornar para você o resultado final da solicitação de cadastro da empresa.

Tabela descritiva dos campos retornados

CampoDescriçãoTipo
typeRetorna se simulação foi realizada com sucesso. Valores possíveis: True ou FalseBool
confirmHashHash de confirmação de segurança do webhook.String (255)
eventsArray de eventos que foram ativados.Array String