API Reference
Create a webhook
Introduction
Core Resources
Additional Resources
API Specification
- API Reference
- GETList all payments
- POSTInitialize a payment
- GETRetrieve a payment
- PUTProcess a payment
- POSTProcess a payment
- DELCancel a payment
- GETList all transfers
- POSTInitiate a transfer
- GETRetrieve a transfer
- GETList all beneficiaries
- POSTCreate a beneficiary
- GETRetrieve a beneficiary
- DELDelete a beneficiary
- GETList all customers
- POSTCreate a customer
- GETRetrieve a customer
- POSTUpdate a customer
- DELDelete a customer
- GETList customer's payment methods
- GETList customer's payments
- POSTBlock a customer
- POSTUnblock a customer
- GETList all webhooks
- POSTCreate a webhook
- GETRetrieve a webhook
- PUTUpdate a webhook
- DELDelete a webhook
- GETRetrieve account balance
- GETList all payment channels
- GETList all countries
- GETList all currencies
- GET
API Reference
Create a webhook
POST
/
webhooks
curl --request POST \
--url https://api.notchpay.co/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks",
"description": "Webhook principal",
"events": [
"payment.created"
]
}'
{
"code": 201,
"status": "Created",
"message": "Webhook endpoint created successfully",
"endpoint": {
"id": "wh_123456789",
"url": "https://example.com/webhooks",
"description": "Webhook principal",
"events": [
"payment.complete"
],
"created_at": "2023-01-01T12:00:00.000Z",
"updated_at": "2023-01-02T12:00:00.000Z"
}
}
Authorizations
Body
application/json
Response
201
application/json
Webhook endpoint created
The response is of type object
.
curl --request POST \
--url https://api.notchpay.co/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks",
"description": "Webhook principal",
"events": [
"payment.created"
]
}'
{
"code": 201,
"status": "Created",
"message": "Webhook endpoint created successfully",
"endpoint": {
"id": "wh_123456789",
"url": "https://example.com/webhooks",
"description": "Webhook principal",
"events": [
"payment.complete"
],
"created_at": "2023-01-01T12:00:00.000Z",
"updated_at": "2023-01-02T12:00:00.000Z"
}
}