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"
}
'import requests
url = "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks"
payload = {
"url": "https://partner.example.com/webhooks/yp",
"events": { "transaction": ["completed_transaction", "failed_transaction"] },
"description": "Webhook principal",
"apiKey": "partner-secret",
"status": "ACTIVE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://partner.example.com/webhooks/yp',
events: {transaction: ['completed_transaction', 'failed_transaction']},
description: 'Webhook principal',
apiKey: 'partner-secret',
status: 'ACTIVE'
})
};
fetch('https://sandbox-rampa.mesadepagos.com/api/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example.com/webhooks/yp',
'events' => [
'transaction' => [
'completed_transaction',
'failed_transaction'
]
],
'description' => 'Webhook principal',
'apiKey' => 'partner-secret',
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-rampa.mesadepagos.com/api/v2/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-rampa.mesadepagos.com/api/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://partner.example.com/webhooks/yp",
"events": [
"completed_transaction",
"failed_transaction"
],
"apiKey": null,
"description": "Webhook principal"
}{
"statusCode": 400,
"message": "Validation failed",
"error": "Bad Request"
}{
"statusCode": 401,
"message": "Unauthorized"
}Webhooks
Crear webhook
Crea una URL de notificación para eventos de transacciones.
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"
}
'import requests
url = "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks"
payload = {
"url": "https://partner.example.com/webhooks/yp",
"events": { "transaction": ["completed_transaction", "failed_transaction"] },
"description": "Webhook principal",
"apiKey": "partner-secret",
"status": "ACTIVE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://partner.example.com/webhooks/yp',
events: {transaction: ['completed_transaction', 'failed_transaction']},
description: 'Webhook principal',
apiKey: 'partner-secret',
status: 'ACTIVE'
})
};
fetch('https://sandbox-rampa.mesadepagos.com/api/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example.com/webhooks/yp',
'events' => [
'transaction' => [
'completed_transaction',
'failed_transaction'
]
],
'description' => 'Webhook principal',
'apiKey' => 'partner-secret',
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-rampa.mesadepagos.com/api/v2/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-rampa.mesadepagos.com/api/v2/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-rampa.mesadepagos.com/api/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example.com/webhooks/yp\",\n \"events\": {\n \"transaction\": [\n \"completed_transaction\",\n \"failed_transaction\"\n ]\n },\n \"description\": \"Webhook principal\",\n \"apiKey\": \"partner-secret\",\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://partner.example.com/webhooks/yp",
"events": [
"completed_transaction",
"failed_transaction"
],
"apiKey": null,
"description": "Webhook principal"
}{
"statusCode": 400,
"message": "Validation failed",
"error": "Bad Request"
}{
"statusCode": 401,
"message": "Unauthorized"
}Authorizations
JWT obtenido desde /v2/auth/login
Body
application/json
Datos del webhook a crear.
URL HTTPS del partner donde YP enviará notificaciones.
Example:
"https://partner.example.com/webhooks/yp"
Eventos suscritos.
Show child attributes
Show child attributes
Descripción interna del webhook.
Maximum string length:
255Example:
"Webhook principal"
API key opcional asociada al webhook.
Example:
"partner-secret"
Estado del webhook.
Available options:
ACTIVE, INACTIVE, SUSPENDED Example:
"ACTIVE"
Response
Webhook creado exitosamente.
Identificador único del webhook.
Example:
"550e8400-e29b-41d4-a716-446655440000"
URL configurada para recibir notificaciones.
Example:
"https://partner.example.com/webhooks/yp"
Eventos configurados.
Available options:
pending_transaction, processing_transaction, completed_transaction, reject_transaction, failed_transaction, expired_transaction Example:
[
"completed_transaction",
"failed_transaction"
]
API key asociada al webhook, si existe.
Example:
null
Descripción del webhook.
Example:
"Webhook principal"
⌘I