- Payouts Overview
- Payouts Sign Up
- Payout Methods
- Payout API Response Codes
- Payouts Integration Steps
- Encrypting and Decrypting Payload
- Payouts Status Codes
- Get Authentication Token
- Beneficiary Apis
- Transfer Apis
- Payout Account Apis
- Webhook Data Apis
Create Webhook Data
POST
/api/v0/webhook-data
Webhook Data Apis
Request
Body Params application/json
headers
object
optional
Additional properties
string
optional
webhookUrl
string
required
sslCertificate
string
optional
events
array[string]
required
Allowed values:
PAYOUT_SUCCESSPAYOUT_PENDINGPAYOUT_FAILEDUTILITY_BILLPAY_SUCCESSUTILITY_BILLPAY_FAILEDUTILITY_BILLPAY_PENDING
enabled
boolean
optional
companyId
string
optional
Match pattern:
^CEK[A-Z0-9]{7}$
Example
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/webhook-data' \
--header 'Content-Type: application/json' \
--data-raw ''Responses
🟢200OK
*/*
Body
response_code
integer <int32>
optional
response_message
string
optional
payload
object (WebhookDataResponse)
optional
companyId
string
optional
headers
object
optional
webhookUrl
string
optional
sslCertificate
string
optional
events
array[string]
optional
Allowed values:
PAYOUT_SUCCESSPAYOUT_PENDINGPAYOUT_FAILEDUTILITY_BILLPAY_SUCCESSUTILITY_BILLPAY_FAILEDUTILITY_BILLPAY_PENDING
enabled
boolean
optional
Example
{
"response_code": 0,
"response_message": "string",
"payload": {
"companyId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"webhookUrl": "string",
"sslCertificate": "string",
"events": [
"PAYOUT_SUCCESS"
],
"enabled": true
}
}Modified at 2024-10-10 08:30:40