Documentation Powered by ReDoc

WePayOut API (1.2.1)

Download OpenAPI specification:Download

E-mail: it-support@wepayout.co License: WePayOut Terms of Service

Use this API to access and manage your WePayOut account data

All endpoints are available via https and are located at api.wepayout.com/v1/payout/.

Last update: 2021-12-14

Authentication

Authorization

WePayOut offers an RFC 6750 Bearer Token authentication method

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Data Qualification

Manage your data qualification data The data qualification process has the objectve to validate and qualify bank account data.

Data qualification services available

The data qualification services determine the procedures that will be applied to qualify the bank account. We have five data qualification services available:

  • 1: - Automatic validation: validates the document and bank account digits.
  • 2: - Automatic validation + micro deposit: After the data is validated a micro deposit is made to the account to assure that it's valid.
  • 3: - Automatic validation + micro deposit + manual correction: Same as above plus manual check in case of failures.
  • 4: - Automatic validation + deposit. Same as 2 but you provide the amount to be deposited.
  • 5: - Automatic validation + deposit + manual correction: Same as 3 but you provide the amount to be deposited.
Authorizations:
Authorization

Responses

Register a batch of data qualification orders

You can use this endpoint to create a data qualification batch. In the data attribute you may pass a list of bank account datas to be qualified. You can group your data qualification in batches, to do so use the field batch_code.

Authorizations:
Authorization
Request Body schema: application/json

Data Qualification creation

merchant_id
integer

The Merchant ID, Required when you have access to more than one Merchant

service_id
required
integer [ 1 .. 5 ]

The service ID The avaliable service can be retrived in the endpoint GET /data-qualification/services

required
Array of objects

Responses

Callbacks

Request samples

Content type
application/json
{
  • "merchant_id": 0,
  • "service_id": 1,
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message.",
  • "info": {
    }
}

Callback payload samples

Callback
POST: Receive data qualification status updates.
Content type
application/json
{
  • "id": "1",
  • "step": 0,
  • "status_id": 0,
  • "custom_code": "YOURAPPCODE",
  • "batch_code": "bc101",
  • "message": "",
  • "name": "string",
  • "document": "string",
  • "bank_code": "string",
  • "bank_branch": "string",
  • "bank_branch_digit": "string",
  • "account": "string",
  • "account_digit": "string",
  • "account_type": "string",
  • "pix_key": "string"
}

List all data qualifications

A paginated, filterable and sortable list of DataQualification processes.

Authorizations:
Authorization
query Parameters
per_page
integer >= 0

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

page
integer >= 0

The current page that will be displayed on paginated lists.

order_by
string
Default: "id"
Enum: "id" "data_qualification_service_name" "batch_code" "custom_code" "merchant.name" "description_status" "created_at"

The field that will be used to sort data.

sort
string
Default: "asc"
Enum: "asc" "desc"

The sort type, asc or desc

created_at
string

Created at filter:

  • created_at=2020-01-01
custom_code
string

Filter by custom_code (invoice):

  • custom_code:abc001
document
string

Filter by the beneficiary's document:

  • document:00000000000
data_qualification_service_id
integer

Filter by qualification service You can list the available options in the endpoint GET /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 /data-qualification/status

Responses

Get a data qualification order by ID

Return the informations for an specific data qualification process

Authorizations:
Authorization
path Parameters
id
required
integer

The data qualification id

Responses

Get the statuses available

A list with all status available 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
Authorizations:
Authorization
query Parameters
per_page
integer >= 0

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

page
integer >= 0

The current page that will be displayed on paginated lists.

Responses

Find a data qualification order using custom code

path Parameters
customCode
required
string

Responses

Response samples

Content type
application/json
{
  • "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": "string",
  • "updated_at": "string",
  • "merchant": {
    }
}