Skip to main content
POST
/
v2
/
webhooks
Crear webhook
curl --request POST \
  --url https://sandbox-rampa.mesadepagos.com/api/v2/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://partner.example.com/webhooks/yp",
  "events": {
    "transaction": [
      "completed_transaction",
      "failed_transaction"
    ]
  },
  "description": "Webhook principal",
  "apiKey": "partner-secret",
  "status": "ACTIVE"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://partner.example.com/webhooks/yp",
  "events": [
    "completed_transaction",
    "failed_transaction"
  ],
  "apiKey": null,
  "description": "Webhook principal"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mesadepagos.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT obtenido desde /v2/auth/login

Body

application/json

Datos del webhook a crear.

​
url
string
required

URL HTTPS del partner donde YP enviara notificaciones.

Example:

"https://partner.example.com/webhooks/yp"

​
events
object
required

Eventos suscritos.

​
description
string

Descripcion interna del webhook.

Maximum string length: 255
Example:

"Webhook principal"

​
apiKey
string

API key opcional asociada al webhook.

Example:

"partner-secret"

​
status
enum<string>
default:ACTIVE

Estado del webhook.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

Response

Webhook creado exitosamente.

​
id
string
required

Identificador unico del webhook.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
url
string
required

URL configurada para recibir notificaciones.

Example:

"https://partner.example.com/webhooks/yp"

​
events
enum<string>[]
required

Eventos configurados.

Available options:
pending_transaction,
processing_transaction,
completed_transaction,
reject_transaction,
failed_transaction,
expired_transaction
Example:
[
  "completed_transaction",
  "failed_transaction"
]
​
apiKey
object

API key asociada al webhook, si existe.

Example:

null

​
description
object

Descripcion del webhook.

Example:

"Webhook principal"