Skip to main content
POST
/
v1
/
payout
/
data-qualification
Create Data Qualification
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v1/payout/data-qualification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": 123,
  "service_id": 123,
  "data": [
    {
      "amount": 123,
      "custom_code": "<string>",
      "batch_code": "<string>",
      "notification_url": "<string>",
      "beneficiary": {
        "name": "<string>",
        "bank_code": "<string>",
        "bank_branch": "<string>",
        "bank_branch_digit": "<string>",
        "account": "<string>",
        "account_digit": "<string>",
        "account_type": "<string>",
        "document": "<string>",
        "document_type": "<string>",
        "birthdate": "<string>",
        "phone": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "province_code": "<string>",
        "address": "<string>"
      }
    }
  ]
}
'
{
  "message": "All records processed successfully"
}
You can use this endpoint to create a data qualification batch. In the data attribute you may pass a list of bank account data to be qualified. You can group your data qualification in batches using the batch_code field.

​
Request Body

​
merchant_id
integer
The Merchant ID. Required when you have access to more than one Merchant.
​
service_id
integer
required
The service ID. The available services can be retrieved in the endpoint GET /v1/payout/data-qualification/services.Allowed values: 1, 2, 3, 4, 5
​
data
array
required
Array of data qualification records.

​
Webhook Callback

When you provide a notification_url, we will send HTTP POST requests to your endpoint when the data qualification status changes.
Webhook Signature: All data qualification webhooks are signed with an sha256 hash provided in the Authorization header. The hash is sent as a Bearer token. eg.: Bearer {hash}To validate the signature you must concatenate the request body and your APIKey used to create the payments and hash this string using the sha256 algorithm. For example: {JSON_BODY...}APIKEY

​
Webhook Payload

​
id
string
Our ID.Example: 1
​
step
integer
An integer value that indicates the step that the data-qualification process is.
  • 1 - Processing - Intermediary step
  • 2 - Valid data - Final step
  • 3 - Invalid data - Final step
​
status_id
integer
An integer value that indicates the current data-qualification status.
  • 1 - Received - The data qualification is received and will be processed soon
  • 5 - Valid data - Final status
  • 6 - Invalid data - Final status
  • 7 - No Process - The account can not be validated - Final status
​
custom_code
string
Your Custom Code.Example: YOURAPPCODE
​
batch_code
string
The data qualification batch code.Example: bc101
​
message
string
The description of the data qualification update.
​
name
string
Beneficiary name.
​
document
string
Beneficiary document.
​
bank_code
string
Bank code.
​
bank_branch
string
Bank branch.
​
bank_branch_digit
string
Bank branch digit.
​
account
string
Account number.
​
account_digit
string
Account digit.
​
account_type
string
Account type: c for Checking accounts, s for Savings accounts.
​
pix_key
string
PIX key if applicable.

​
Response

​
200
object
All data qualification records provided have been successfully processed.
​
400
object
When some of the records provided in the data list have errors during processing.

​
Request Example

curl --request POST \
  --url 'https://api.sandbox.wepayout.com.br/v1/payout/data-qualification' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service_id": 2,
    "data": [
      {
        "custom_code": "DQ001",
        "batch_code": "BATCH001",
        "notification_url": "https://your.endpoint.to.update",
        "beneficiary": {
          "name": "Maria Jose",
          "bank_code": "147",
          "bank_branch": "0000",
          "bank_branch_digit": "1",
          "account": "1030000",
          "account_digit": "1",
          "account_type": "CHECKING",
          "document": "12533009091",
          "document_type": "cpf",
          "birthdate": "1970-01-01",
          "phone": "5541987456321",
          "city": "Curitiba",
          "postal_code": "80200-100",
          "province_code": "PR",
          "address": "Rua a Número 10"
        }
      }
    ]
  }'

{
  "message": "All records processed successfully"
}