Skip to main content

Create a Webhook [POST]

Create a webhook request by simply submitting the type of event (array of strings) you would like to subscribe to: pending, authorising, sent, confirmed, cancelled, underpaid or failed.

Endpoints​

Staging environment

  • Staging URL: https://staging.sylq.io/api/v1/webhooks

Production/Live environment

  • Production/Live URL: https://app.sylq.io/api/v1/webhooks

Status​

  • pending:, when the bank or crypto payment is created,
  • sent:, when crypto payment is 'confirming' by the blockchain network,
  • confirmed:, when the bank or crypto payment is completed (paid),
  • failed:, when the bank or crypto payment is failed,
  • cancelled:, when the bank or crypto payment is cancelled,
  • underpaid: when the crypto payment is underpaid (the payer has sent less money than the amount indicated).

Schema​

{
  "url": "string",
  "statuses": [
    "pending"
  ]
}

Examples of returns​

Success response (201)​

{
  "url": "http://example.com/callback",
  "statuses": [
    "pending",
    "confirmed",
    "failed"
  ]
}

Error response (422)​

{
  "errors": {
    "statuses": [
      "is required"
    ]
  }
}