Crear Webhook
POST /v2/webhooks
{
"url": "https://partner.example.com/webhooks/yp",
"description": "Webhook principal",
"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": "Webhook principal",
"events": ["completed_transaction", "failed_transaction"]
}
Listar 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": "Webhook principal",
"status": "ACTIVE"
}
]
Obtener 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": "Webhook principal",
"status": "ACTIVE"
}
Actualizar Webhook
PATCH /v2/webhooks/{id}
{
"url": "https://partner.example.com/webhooks/yp-v2",
"description": "Webhook actualizado",
"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": "Webhook actualizado",
"events": [
"completed_transaction",
"failed_transaction",
"expired_transaction"
]
}
Payloads de Transacciones
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 se incluye cuando el proveedor blockchain lo informa y puede utilizarse para consultar la operación en el explorador de la red correspondiente.
deposit_express
{
"externalReference": "376e62a0-f586-4fd3-b30f-1fdb39df18cf",
"status": "completed_transaction",
"transactionType": "deposit_express",
"timestamp": "2026-05-22T16:42:27.302Z",
"details": {
"amount": "102.102",
"currency": "BOB",
"message": "Transaction 6d045d9d-398a-481e-9031-11a165dd91c7 updated to status completed_transaction",
"transactionId": "6d045d9d-398a-481e-9031-11a165dd91c7"
}
}
withdrawal_express
{
"externalReference": "5E3zOnTquFtzLJdh4IhNGT",
"status": "completed_transaction",
"transactionType": "withdrawal_express",
"timestamp": "2026-05-22T19:10:19.377Z",
"details": {
"amount": "528.11",
"currency": "BOB",
"message": "Transaction ed27d250-1401-48fb-bf3a-3be276dd9b54 updated to status completed_transaction",
"transactionId": "ed27d250-1401-48fb-bf3a-3be276dd9b54"
}
}
withdrawal_ach
{
"externalReference": "39f76d75-f80b-4d7c-a0b7-5e81a9dbe21a",
"status": "completed_transaction",
"transactionType": "withdrawal_ach",
"timestamp": "2026-08-13T19:31:00.021Z",
"details": {
"amount": "20",
"currency": "BOB",
"message": "Transaction 99b95d27-2a1a-494b-8919-fa95b028db41 updated to status completed_transaction",
"transactionId": "99b95d27-2a1a-494b-8919-fa95b028db41"
}
}
Logs
GET /v2/webhooks/logs
Query Params
| Parámetro | Requerido | Valores |
|---|---|---|
page | No | Número de página |
limit | No | Máximo 100 |
status | No | SUCCESS, ERROR |
webhookId | No | UUID del webhook |
Response
{
"logs": [
{
"id": "550e8400-e29b-41d4-a716-446655440010",
"webhookId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Webhook principal",
"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
}
}
Eventos Soportados
pending_transaction
processing_transaction
completed_transaction
reject_transaction
failed_transaction
expired_transaction