List Data Qualifications
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v1/payout/data-qualification"
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/v1/payout/data-qualification', 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/v1/payout/data-qualification",
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/v1/payout/data-qualification"
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/v1/payout/data-qualification")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v1/payout/data-qualification")
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[
{
"id": 123,
"batch_code": "abc101",
"custom_code": "cc102",
"data_qualification_service_name": "Data validation",
"status_flow_data_qualification_id": 1,
"data_qualification_status_flow_name": "Processing",
"description_status": "Processando",
"name": "Maria Jose",
"document": "12345678909",
"bank_code": "104",
"bank_branch": "0123",
"bank_branch_digit": "0",
"account": "123456",
"account_digit": "1",
"account_type_name": "Checking account",
"amount": 1.1,
"created_at": "2024-01-15 10:30:00",
"updated_at": "2024-01-15 10:35:00",
"merchant": {
"id": "1",
"name": "My Merchant"
}
}
]
Data Qualification
List Data Qualifications
Retrieve a paginated, filterable and sortable list of data qualification processes
GET
/
v1
/
payout
/
data-qualification
List Data Qualifications
curl --request GET \
--url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wepayout.com.br/v1/payout/data-qualification"
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/v1/payout/data-qualification', 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/v1/payout/data-qualification",
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/v1/payout/data-qualification"
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/v1/payout/data-qualification")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wepayout.com.br/v1/payout/data-qualification")
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[
{
"id": 123,
"batch_code": "abc101",
"custom_code": "cc102",
"data_qualification_service_name": "Data validation",
"status_flow_data_qualification_id": 1,
"data_qualification_status_flow_name": "Processing",
"description_status": "Processando",
"name": "Maria Jose",
"document": "12345678909",
"bank_code": "104",
"bank_branch": "0123",
"bank_branch_digit": "0",
"account": "123456",
"account_digit": "1",
"account_type_name": "Checking account",
"amount": 1.1,
"created_at": "2024-01-15 10:30:00",
"updated_at": "2024-01-15 10:35:00",
"merchant": {
"id": "1",
"name": "My Merchant"
}
}
]
A paginated, filterable and sortable list of data qualification processes.
Query Parameters
integer
The number of items that will be displayed per page on paginated lists.Min:
0integer
The current page that will be displayed on paginated lists.Min:
0string
The field that will be used to sort data.Allowed values:
id, data_qualification_service_name, batch_code, custom_code, merchant.name, description_status, created_atDefault: idstring
The sort type.Allowed values:
asc, descDefault: ascstring
Created at filter.Example:
2020-01-01string
Filter by custom_code (invoice).Example:
abc001string
Filter by the beneficiary’s document.Example:
00000000000integer
Filter by qualification service. You can list the available options in the endpoint GET /v1/payout/data-qualification/services.
integer
Filter by merchant_id.
string
Filter by status. You can list the available options in the endpoint GET /v1/payout/data-qualification/status.
Response
array
Array of data qualification records.
Show Data Qualification Object
Show Data Qualification Object
integer
Our ID.Example:
123string
Batch code.Example:
abc101string
Your ID in our database, must be unique.Example:
cc102string
Service name.Example:
Data validationinteger
Data qualification status ID.Example:
1string
Data qualification status name.Example:
Processingstring
Data qualification status description.Example:
Processandostring
Beneficiary name.Example:
Maria Josestring
Beneficiary document.Example:
12345678909string
Bank code.Example:
104string
Bank branch.Example:
0123string
Bank branch digit.Example:
0string
Bank account.Example:
123456string
Bank account digit.Example:
1string
Account type.Example:
Checking accountnumber
Source amount.Example:
1.1string
Creation timestamp.Format:
YYYY-MM-DD HH:mm:ssstring
Last update timestamp.Format:
YYYY-MM-DD HH:mm:ssRequest Example
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification?page=1&per_page=10&order_by=created_at&sort=desc&status_flow_data_qualification_id=1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification?document=12345678909' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
async function listDataQualifications(filters = {}) {
const params = new URLSearchParams(filters);
const response = await fetch(
`https://api.sandbox.wepayout.com.br/v1/payout/data-qualification?${params}`,
{
method: 'GET',
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer {token}'
}
}
);
if (!response.ok) {
throw new Error(`Failed to fetch data qualifications: ${response.statusText}`);
}
return await response.json();
}
const qualifications = await listDataQualifications({
page: 1,
per_page: 10,
order_by: 'created_at',
sort: 'desc'
});
console.log('Data qualifications:', qualifications);
import requests
def list_data_qualifications(filters=None):
url = 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification'
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {token}'
}
response = requests.get(url, headers=headers, params=filters)
response.raise_for_status()
return response.json()
qualifications = list_data_qualifications({
'page': 1,
'per_page': 10,
'order_by': 'created_at',
'sort': 'desc'
})
print('Data qualifications:', qualifications)
[
{
"id": 123,
"batch_code": "abc101",
"custom_code": "cc102",
"data_qualification_service_name": "Data validation",
"status_flow_data_qualification_id": 1,
"data_qualification_status_flow_name": "Processing",
"description_status": "Processando",
"name": "Maria Jose",
"document": "12345678909",
"bank_code": "104",
"bank_branch": "0123",
"bank_branch_digit": "0",
"account": "123456",
"account_digit": "1",
"account_type_name": "Checking account",
"amount": 1.1,
"created_at": "2024-01-15 10:30:00",
"updated_at": "2024-01-15 10:35:00",
"merchant": {
"id": "1",
"name": "My Merchant"
}
}
]
Was this page helpful?
⌘I