Create a Webhook
POST /v2/webhooks
{
"url": "https://partner.example.com/webhooks/yp",
"description": "Primary webhook",
"apiKey": "partner-secret",
"status": "ACTIVE",
"events": {
"transaction": ["completed_transaction", "failed_transaction"]
}
}
Response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://partner.example.com/webhooks/yp",
"apiKey": "partner-secret",
"description": "Primary webhook",
"events": ["completed_transaction", "failed_transaction"]
}
List Webhooks
GET /v2/webhooks
Response
[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"callbalckUrl": "https://partner.example.com/webhooks/yp",
"events": {
"transaction": ["completed_transaction", "failed_transaction"]
},
"createdAt": "2026-05-12T12:00:00.000Z",
"updatedAt": "2026-05-12T12:00:00.000Z",
"description": "Primary webhook",
"status": "ACTIVE"
}
]
Retrieve a Webhook
GET /v2/webhooks/{id}
Response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"callbalckUrl": "https://partner.example.com/webhooks/yp",
"events": {
"transaction": ["completed_transaction", "failed_transaction"]
},
"createdAt": "2026-05-12T12:00:00.000Z",
"updatedAt": "2026-05-12T12:00:00.000Z",
"description": "Primary webhook",
"status": "ACTIVE"
}
Update a Webhook
PATCH /v2/webhooks/{id}
{
"url": "https://partner.example.com/webhooks/yp-v2",
"description": "Updated webhook",
"apiKey": "partner-secret",
"status": "ACTIVE",
"events": {
"transaction": [
"completed_transaction",
"failed_transaction",
"expired_transaction"
]
}
}
Response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://partner.example.com/webhooks/yp-v2",
"apiKey": "partner-secret",
"description": "Updated webhook",
"events": [
"completed_transaction",
"failed_transaction",
"expired_transaction"
]
}
Crypto Transaction Payloads
withdrawal_crypto
{
"externalReference": "9dd9614e-5059-4cb5-826c-ef092fd99cb9",
"status": "completed_transaction",
"transactionType": "withdrawal_crypto",
"timestamp": "2026-06-29T20:30:52.828Z",
"details": {
"amount": "100",
"asset": "USDC",
"blockchain": "Polygon",
"transactionHash": "0x8f2a7d8dd74c53d68d7f8cfa6529370aa322f1b02a7d68cce8485b571735a9b1",
"message": "Transaction 48942363-dc5f-47ec-baae-5628d814ccf6 updated to status completed_transaction",
"transactionId": "48942363-dc5f-47ec-baae-5628d814ccf6"
}
}
deposit_crypto
{
"status": "completed_transaction",
"transactionType": "deposit_crypto",
"timestamp": "2026-06-29T20:30:52.828Z",
"details": {
"walletId": "550e8400-e29b-41d4-a716-446655440001",
"amount": "100",
"asset": "USDC",
"blockchain": "Polygon",
"transactionHash": "0x8f2a7d8dd74c53d68d7f8cfa6529370aa322f1b02a7d68cce8485b571735a9b1",
"message": "Transaction 48942363-dc5f-47ec-baae-5628d814ccf6 updated to status completed_transaction",
"transactionId": "48942363-dc5f-47ec-baae-5628d814ccf6"
}
}
transactionHash is included when the blockchain provider supplies it and can be used to look up the operation in the corresponding network explorer.
Logs
GET /v2/webhooks/logs
Query Parameters
| Parameter | Required | Values |
|---|---|---|
page | No | Page number |
limit | No | Maximum 100 |
status | No | SUCCESS, ERROR |
webhookId | No | Webhook UUID |
Response
{
"logs": [
{
"id": "550e8400-e29b-41d4-a716-446655440010",
"webhookId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Primary webhook",
"webhookUrl": "https://partner.example.com/webhooks/yp",
"status": "SUCCESS",
"payload": {
"event": "completed_transaction"
},
"statusCode": 200,
"duration": 120,
"retries": 0,
"createdAt": "2026-05-12T12:00:00.000Z",
"updatedAt": "2026-05-12T12:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}
Supported Events
pending_transaction
processing_transaction
completed_transaction
reject_transaction
failed_transaction
expired_transaction