Configurar webhook
curl --request POST \
--url https://sandbox.mx.ntxpay.com/api/webhooks-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/webhooks/mx",
"events": [
"cash_in"
],
"secret": "whsec_abc123"
}
'import requests
url = "https://sandbox.mx.ntxpay.com/api/webhooks-config"
payload = {
"url": "https://example.com/webhooks/mx",
"events": ["cash_in"],
"secret": "whsec_abc123"
}
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://example.com/webhooks/mx',
events: ['cash_in'],
secret: 'whsec_abc123'
})
};
fetch('https://sandbox.mx.ntxpay.com/api/webhooks-config', 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.mx.ntxpay.com/api/webhooks-config",
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://example.com/webhooks/mx',
'events' => [
'cash_in'
],
'secret' => 'whsec_abc123'
]),
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.mx.ntxpay.com/api/webhooks-config"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\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.mx.ntxpay.com/api/webhooks-config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.mx.ntxpay.com/api/webhooks-config")
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://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"url": "https://example.com/webhooks/mx",
"events": [
"cash_in"
],
"isActive": true,
"secret": "whsec_abc123"
}Webhooks Config
Configurar webhook
Requer Bearer JWT. URL HTTPS + exatamente UM evento (array com 1 item) + secret opcional para assinatura HMAC. Se secret for omitido, o NTX Pay gera um automaticamente e retorna na resposta — guarde com segurança.
POST
/
api
/
webhooks-config
Configurar webhook
curl --request POST \
--url https://sandbox.mx.ntxpay.com/api/webhooks-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/webhooks/mx",
"events": [
"cash_in"
],
"secret": "whsec_abc123"
}
'import requests
url = "https://sandbox.mx.ntxpay.com/api/webhooks-config"
payload = {
"url": "https://example.com/webhooks/mx",
"events": ["cash_in"],
"secret": "whsec_abc123"
}
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://example.com/webhooks/mx',
events: ['cash_in'],
secret: 'whsec_abc123'
})
};
fetch('https://sandbox.mx.ntxpay.com/api/webhooks-config', 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.mx.ntxpay.com/api/webhooks-config",
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://example.com/webhooks/mx',
'events' => [
'cash_in'
],
'secret' => 'whsec_abc123'
]),
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.mx.ntxpay.com/api/webhooks-config"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\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.mx.ntxpay.com/api/webhooks-config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.mx.ntxpay.com/api/webhooks-config")
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://example.com/webhooks/mx\",\n \"events\": [\n \"cash_in\"\n ],\n \"secret\": \"whsec_abc123\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"url": "https://example.com/webhooks/mx",
"events": [
"cash_in"
],
"isActive": true,
"secret": "whsec_abc123"
}Autorizações
JWT obtido em POST /api/auth/token
Corpo
application/json
URL HTTPS que receberá os webhooks
Exemplo:
"https://example.com/webhooks/mx"
Um webhook assina exatamente UM evento. O campo é um array por compatibilidade de contrato, mas deve conter um único item. Use all (Geral) para receber todos os eventos em uma única URL.
Required array length:
1 elementOpções disponíveis:
cash_in, cash_out, refund_in, refund_out, internal_transfer, all Exemplo:
["cash_in"]
Secret HMAC para assinatura. Se omitido, o NTX Pay gera automaticamente.
Required string length:
8 - 128Exemplo:
"whsec_abc123"