Query
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/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://api.sandbox.wepayout.com.br/v2/register/companies/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"account_id": 1234,
"events": ["onboarding"],
"url": "https://my-url.requestcatcher.com/test",
"secret": null
},
{
"account_id": 1234,
"events": ["payin", "payout", "kyc"],
"url": "https://my-url.requestcatcher.com/transactions",
"secret": "whsec_9f8e7d6c5b4a3210"
},
{
"account_id": 4521,
"events": ["payin"],
"url": "https://subaccount.requestcatcher.com/payin",
"secret": null
}
]
{
"error_code": "validation",
"error_description": "Validation error",
"fields": {
"account_id": ["The account does not exist or is not linked to your merchant."]
},
"field_errors": [
{
"field": "account_id",
"code": "invalid_account",
"params": [],
"message": "The account does not exist or is not linked to your merchant."
}
]
}
Webhook
Query
Query the registered webhook URLs
GET
/
v2
/
register
/
companies
/
webhooks
Query
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/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://api.sandbox.wepayout.com.br/v2/register/companies/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"account_id": 1234,
"events": ["onboarding"],
"url": "https://my-url.requestcatcher.com/test",
"secret": null
},
{
"account_id": 1234,
"events": ["payin", "payout", "kyc"],
"url": "https://my-url.requestcatcher.com/transactions",
"secret": "whsec_9f8e7d6c5b4a3210"
},
{
"account_id": 4521,
"events": ["payin"],
"url": "https://subaccount.requestcatcher.com/payin",
"secret": null
}
]
{
"error_code": "validation",
"error_description": "Validation error",
"fields": {
"account_id": ["The account does not exist or is not linked to your merchant."]
},
"field_errors": [
{
"field": "account_id",
"code": "invalid_account",
"params": [],
"message": "The account does not exist or is not linked to your merchant."
}
]
}
Query
This endpoint allows querying the registered webhook URLs and the events each one receives. Filtering can only be done by account.- If
account_idis provided, only the webhooks of that account will be returned - If
account_idis omitted, the webhooks of your merchant and of all its subaccounts will be returned, ordered by account
Query Parameters
integer
ID of the account whose webhooks will be returned: your own merchant or one of its subaccounts.When omitted, the response includes the webhooks of your merchant and of every subaccount you have access to.If the account does not exist or is not linked to your merchant, the request fails with
422 and the invalid_account code.Example: 4521Response
Returns an array of webhook objects.Only the webhooks registered on each account are listed. A subaccount without its own webhook for an event uses the main account’s webhook for that event, which appears only under the main account. See Subaccounts without a webhook.
array
Array of webhook objects
Show Webhook Object
Show Webhook Object
integer
ID of the account the webhook belongs to: your merchant or one of its subaccountsExample:
1234string[]
Events the webhook receivesExample:
["payin", "payout"]string
HTTPS endpoint URL that receives the notifications of every event in
eventsExample: https://my-url.requestcatcher.com/teststring
Secret used to sign the webhooks delivered to this URL with HMAC-SHA256, or
null if none is setExample: whsec_9f8e7d6c5b4a3210Request Example
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
const response = await fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks', {
method: 'GET',
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer YOUR_TOKEN'
}
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks'
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer YOUR_TOKEN'
}
response = requests.get(url, headers=headers)
print(response.json())
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks?account_id=4521' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
[
{
"account_id": 1234,
"events": ["onboarding"],
"url": "https://my-url.requestcatcher.com/test",
"secret": null
},
{
"account_id": 1234,
"events": ["payin", "payout", "kyc"],
"url": "https://my-url.requestcatcher.com/transactions",
"secret": "whsec_9f8e7d6c5b4a3210"
},
{
"account_id": 4521,
"events": ["payin"],
"url": "https://subaccount.requestcatcher.com/payin",
"secret": null
}
]
{
"error_code": "validation",
"error_description": "Validation error",
"fields": {
"account_id": ["The account does not exist or is not linked to your merchant."]
},
"field_errors": [
{
"field": "account_id",
"code": "invalid_account",
"params": [],
"message": "The account does not exist or is not linked to your merchant."
}
]
}
Was this page helpful?

