Get Data Qualification Statuses

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status"

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/status', 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/status",
  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/status"

	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/status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status")

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": 1,
    "name": "received"
  },
  {
    "id": 5,
    "name": "valid_data"
  },
  {
    "id": 6,
    "name": "invalid_data"
  },
  {
    "id": 7,
    "name": "validation_not_possible"
  },
  {
    "id": 9,
    "name": "awaiting"
  },
  {
    "id": 999,
    "name": "processing"
  }
]

GET

payout

data-qualification

status

Get Data Qualification Statuses

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status"

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/status', 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/status",
  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/status"

	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/status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status")

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": 1,
    "name": "received"
  },
  {
    "id": 5,
    "name": "valid_data"
  },
  {
    "id": 6,
    "name": "invalid_data"
  },
  {
    "id": 7,
    "name": "validation_not_possible"
  },
  {
    "id": 9,
    "name": "awaiting"
  },
  {
    "id": 999,
    "name": "processing"
  }
]

Status Descriptions

1 - Received: Payment received and stored in our database
5 - Valid data: The account data is valid
6 - Invalid data: Payment rejected by the bank
7 - Validation not possible on this step: The account data provided can not be validated
9 - Awaiting: Awaiting balance to be processed
999 - Processing: Payment sent for processing

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

Response

array

Array of status objects.

Show Status Object

integer

Status ID.Example: 1

name

string

Status name.Example: received

Request Example

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

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification/status?page=1&per_page=10' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {token}'

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

const statuses = await getDataQualificationStatuses();
console.log('Available statuses:', statuses);

import requests

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

statuses = get_data_qualification_statuses()
print('Available statuses:', statuses)

[
  {
    "id": 1,
    "name": "received"
  },
  {
    "id": 5,
    "name": "valid_data"
  },
  {
    "id": 6,
    "name": "invalid_data"
  },
  {
    "id": 7,
    "name": "validation_not_possible"
  },
  {
    "id": 9,
    "name": "awaiting"
  },
  {
    "id": 999,
    "name": "processing"
  }
]

Get Data Qualification By ID Get Data Qualification By Custom Code

Account

Banks

Payin

Payout

KYC

Markup

Get Data Qualification Statuses

Status Descriptions

Query Parameters

Response

Request Example

​Status Descriptions

​Query Parameters

​Response

​Request Example

Status Descriptions

Query Parameters

Response

Request Example