Parceiros e API Keys
Definir webhook
Sets the single destination for this partner’s outbound webhooks. This is the official way to register the destination for outbound notifications. - Define o destino único dos webhooks de saída deste parceiro.
POST
/
api
/
v1
/
partners
/
me
/
webhook-config
Set webhook config
curl --request POST \
--url https://sandbox.brlp.io/api/v1/partners/me/webhook-config \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"events": [],
"headers": {}
}
'import requests
url = "https://sandbox.brlp.io/api/v1/partners/me/webhook-config"
payload = {
"url": "<string>",
"events": [],
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', events: [], headers: {}})
};
fetch('https://sandbox.brlp.io/api/v1/partners/me/webhook-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.brlp.io/api/v1/partners/me/webhook-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' => '<string>',
'events' => [
],
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.brlp.io/api/v1/partners/me/webhook-config"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.brlp.io/api/v1/partners/me/webhook-config")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brlp.io/api/v1/partners/me/webhook-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": null,
"data": {}
}Autorizações
partnerApiKeyhmacAuth
Bearer API key (recommended). Format: Bearer sk_live_<hex>. Send the key directly - no signature, nonce or timestamp. Create/revoke keys in the dashboard or via /partners/me/api-keys. Accepted on the same routes as the HMAC scheme. - API key Bearer (recomendada), aceita nas mesmas rotas que o esquema HMAC.
Corpo
application/json
Single HTTPS destination that will receive all webhook notifications for this partner. - Destino HTTPS único que receberá todas as notificações de webhook deste parceiro.
Required string length:
8 - 500Pattern:
^https://Optional subscription filter. Absent or empty = receives all events. - Filtro opcional de eventos assinados. Ausente ou vazio = recebe todos os eventos.
Maximum array length:
15Opções disponíveis:
INTENT_CONFIRMED, INTENT_COMPLETED, INTENT_FAILED, CASHIN_COMPLETED, CASHIN_FAILED, WITHDRAW_COMPLETED, WITHDRAW_FAILED, KYC_PENDING, KYC_IN_PROGRESS, KYC_APPROVED, KYC_REJECTED, KYC_EXPIRED, SETTLEMENT_CONFIRMED, SETTLEMENT_FAILED, SETTLEMENT_UPDATED Custom HTTP headers sent on every delivery (e.g. an Authorization for your endpoint). The API signature/event headers cannot be overwritten. - Cabeçalhos HTTP personalizados enviados em cada entrega; os cabeçalhos de assinatura/evento da API não podem ser sobrescritos.
Show child attributes
Show child attributes
Resposta
200 - application/json
Success
The response is of type object.
⌘I
Set webhook config
curl --request POST \
--url https://sandbox.brlp.io/api/v1/partners/me/webhook-config \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"events": [],
"headers": {}
}
'import requests
url = "https://sandbox.brlp.io/api/v1/partners/me/webhook-config"
payload = {
"url": "<string>",
"events": [],
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', events: [], headers: {}})
};
fetch('https://sandbox.brlp.io/api/v1/partners/me/webhook-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.brlp.io/api/v1/partners/me/webhook-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' => '<string>',
'events' => [
],
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.brlp.io/api/v1/partners/me/webhook-config"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.brlp.io/api/v1/partners/me/webhook-config")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brlp.io/api/v1/partners/me/webhook-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"events\": [],\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": null,
"data": {}
}