Skip to main content
GET
/
v1
/
payout
/
data-qualification
/
custom-code
/
{customCode}
Get Data Qualification By Custom Code
curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/{customCode} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/{customCode}"

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/custom-code/{customCode}', 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/custom-code/{customCode}",
  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/custom-code/{customCode}"

	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/custom-code/{customCode}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/{customCode}")

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": "DQ001",
  "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"
  }
}

​
Path Parameters

​
customCode
string
required
The custom code (invoice) used when creating the data qualification.

​
Response

​
id
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.

​
Request Example

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/DQ001' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {token}'

async function getDataQualificationByCustomCode(customCode) {
  const response = await fetch(
    `https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/${customCode}`,
    {
      method: 'GET',
      headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer {token}'
      }
    }
  );
  
  if (!response.ok) {
    throw new Error(`Failed to fetch data qualification: ${response.statusText}`);
  }
  
  return await response.json();
}

const qualification = await getDataQualificationByCustomCode('DQ001');
console.log('Data qualification:', qualification);

import requests

def get_data_qualification_by_custom_code(custom_code):
    url = f'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/custom-code/{custom_code}'
    headers = {
        'Accept': 'application/json',
        'Authorization': 'Bearer {token}'
    }
    
    response = requests.get(url, headers=headers)
    response.raise_for_status()
    
    return response.json()

qualification = get_data_qualification_by_custom_code('DQ001')
print('Data qualification:', qualification)

{
  "id": 123,
  "batch_code": "abc101",
  "custom_code": "DQ001",
  "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"
  }
}