v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar Webhooks cadastrados.

Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook

get/webhook/subscription

Query parameters

entitystring

Identificador do evento. (pix-payment-in, pix-payment-out, pix-reversal-in, pix-reversal-out)

contextstring

Identificador do produto relacionado ao Webhook (deverá ser REDE,CORP,PIX,BAAS,PAGAMENTOS,ONBOARDING)

activeboolean

Está ativo ou não.

subscriptionIdstring

Identificador único do webhook cadastrado.

Request body

{"stackTrail":"paths:/webhook/subscription:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

versionstring

statusstring

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "subscriptionId": "64a340b7987ab1220a72ab66",
    "entity": "pix-payment-out",
    "context": "PIX",
    "webhookUrl": "https://yourownurl.com.br/payment-out",
    "active": true,
    "createDate": "2024-09-30T17:55:14.680Z",
    "lastUpdateDate": "2024-09-30T17:55:14.680Z",
    "auth": {
      "login": "login",
      "pwd": "password",
      "type": "basic",
      "urlAuth": "login",
      "requestType": "raw",
      "responsePathToken": "access_token",
      "requestAuth": [
        {
          "key": "secret_key",
          "value": "senhaSenha",
          "type": "string"
        }
      ]
    }
  }
}