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>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

Use this file to discover all available pages before exploring further.

​
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}'

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