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"
    }
  }
]

GET

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

per_page

integer

The number of items that will be displayed per page on paginated lists.Min: 0

page

integer

The current page that will be displayed on paginated lists.Min: 0

order_by

string

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: id

sort

string

The sort type.Allowed values: asc, descDefault: asc

created_at

string

Created at filter.Example: 2020-01-01

custom_code

string

Filter by custom_code (invoice).Example: abc001

document

string

Filter by the beneficiary’s document.Example: 00000000000

data_qualification_service_id

integer

Filter by qualification service. You can list the available options in the endpoint GET /v1/payout/data-qualification/services.

merchant_id

integer

Filter by merchant_id.

status_flow_data_qualification_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

integer

Our ID.Example: 123

batch_code

string

Batch code.Example: abc101

custom_code

string

Your ID in our database, must be unique.Example: cc102

data_qualification_service_name

string

Service name.Example: Data validation

status_flow_data_qualification_id

integer

Data qualification status ID.Example: 1

data_qualification_status_flow_name

string

Data qualification status name.Example: Processing

description_status

string

Data qualification status description.Example: Processando

name

string

Beneficiary name.Example: Maria Jose

document

string

Beneficiary document.Example: 12345678909

bank_code

string

Bank code.Example: 104

bank_branch

string

Bank branch.Example: 0123

bank_branch_digit

string

Bank branch digit.Example: 0

account

string

Bank account.Example: 123456

account_digit

string

Bank account digit.Example: 1

account_type_name

string

Account type.Example: Checking account

amount

number

Source amount.Example: 1.1

created_at

string

Creation timestamp.Format: YYYY-MM-DD HH:mm:ss

updated_at

string

Last update timestamp.Format: YYYY-MM-DD HH:mm:ss

merchant

object

Merchant information.

Show Merchant Object

string

Merchant ID.

name

string

Merchant name.

Request 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"
    }
  }
]

Create Data Qualification Get Data Qualification By ID

Account

Banks

Payin

Payout

KYC

Markup

List Data Qualifications

Query Parameters

Response

Request Example

​Query Parameters

​Response

​Request Example

Query Parameters

Response

Request Example