Criar Webhook

Criar Webhook

post

Este endpoint permite que um comerciante registre um novo webhook para receber notificações em tempo real sobre eventos específicos (ex.: transações, saques).

scope: webhooks.write

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Body

application/json

bank_account_idstring · uuidRequired

urlstring · uriRequired

eventsstring[]Required

Responses

201

Sucesso

application/json

403

Proibido

application/json

422

Validation

application/json

500

Erro Interno do Servidor

application/json

post

HTTPcURLJavaScriptPython

POST /banking/v1/webhooks HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "bank_account_id": "01976540-f21b-72b2-acf0-f0005d032d6f",
  "url": "https://www.youtube.com/watch?v=amazLyuDbTA",
  "events": [
    "transaction.created",
    "transaction.updated"
  ]
}

{
  "data": {
    "id": "0197b7fc-c8f1-73d8-b475-a01a03be9638",
    "merchant_id": "0197a8b8-cbed-7316-aa6f-df1a22a2e754",
    "url": "https://www.youtube.com/watch?v=amazLyuDbT",
    "events": [
      "transaction.created",
      "transaction.updated"
    ],
    "created_at": "2025-06-28T19:21:26.000000Z",
    "updated_at": "2025-06-28T19:21:26.000000Z"
  }
}