List Payment

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/payout/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/payout/payments', 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/v2/payout/payments",
  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/v2/payout/payments"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/payout/payments")

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

{
  "data": [
    {
      "id": 54321,
      "merchant_id": 1234,
      "amount": 10000,
      "currency": "BRL",
      "country": "BR",
      "description": "Payment for services rendered",
      "recipient": {
        "name": "João Silva",
        "email": "joao@example.com",
        "document": {
          "type": "CPF",
          "number": "12345678900"
        },
        "bank_account": {
          "bank_code": "001",
          "branch": "1234",
          "account": "12345678",
          "account_digit": "9",
          "account_type": "checking"
        }
      },
      "status": {
        "id": 3,
        "name": "Paid"
      },
      "external_id": "ORDER-12345",
      "notification_url": "https://your-domain.com/webhook/payout",
      "created_at": "2024-06-13T10:00:00.000000Z",
      "updated_at": "2024-06-13T10:05:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 73
  },
  "links": {
    "first": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=1",
    "last": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=5",
    "prev": null,
    "next": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=2"
  }
}

GET

payout

payments

List Payment

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/payout/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/payout/payments', 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/v2/payout/payments",
  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/v2/payout/payments"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/payout/payments")

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

{
  "data": [
    {
      "id": 54321,
      "merchant_id": 1234,
      "amount": 10000,
      "currency": "BRL",
      "country": "BR",
      "description": "Payment for services rendered",
      "recipient": {
        "name": "João Silva",
        "email": "joao@example.com",
        "document": {
          "type": "CPF",
          "number": "12345678900"
        },
        "bank_account": {
          "bank_code": "001",
          "branch": "1234",
          "account": "12345678",
          "account_digit": "9",
          "account_type": "checking"
        }
      },
      "status": {
        "id": 3,
        "name": "Paid"
      },
      "external_id": "ORDER-12345",
      "notification_url": "https://your-domain.com/webhook/payout",
      "created_at": "2024-06-13T10:00:00.000000Z",
      "updated_at": "2024-06-13T10:05:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 73
  },
  "links": {
    "first": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=1",
    "last": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=5",
    "prev": null,
    "next": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=2"
  }
}

List Payment

List all payout payments with optional filters.

Query Parameters

integer

Filter by merchant ID.Min: 2, Max: 10000

string

Filter by your internal reference ID.Max length: 255 characters

integer

Filter by status ID.

string

Filter payments created after this date. Format: YYYY-MM-DD

string

Filter payments created before this date. Format: YYYY-MM-DD

string

Filter payments updated after this date. Format: YYYY-MM-DD

string

Filter payments updated before this date. Format: YYYY-MM-DD

integer

Page number for pagination.Default: 1

integer

Number of items per page.Default: 15, Max: 100

string

Field to sort by.Allowed values: id, created_at, updated_at, amountDefault: id

string

Sort order.Allowed values: asc, descDefault: desc

Response

Returns an array of payout payment objects with pagination metadata.

array

Array of payout payment objects.

Show Payment Object

integer

WEpayment’s auto generated payout ID.

integer

Merchant ID that created the payout.

integer

Payout amount in cents.

string

Currency code.

string

Country code.

string

Payout description.

object

Recipient information.

object

Payout status.

string

Your internal reference ID.

string

Webhook notification URL.

string

Creation timestamp.

string

Last update timestamp.

object

Pagination metadata.

Show Pagination

integer

Current page number.

integer

First item number on current page.

integer

Last page number.

integer

Items per page.

integer

Last item number on current page.

integer

Total number of items.

object

Pagination links.

Show Links

string

URL to first page.

string

URL to last page.

string

URL to previous page (null if on first page).

string

URL to next page (null if on last page).

Request Example

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v2/payout/payments?page=1&per_page=15' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v2/payout/payments?external_id=ORDER-12345' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

curl --request GET \
  --url '"https://api.sandbox.wepayout.com.br/v2/payout/payments?status_id=3"' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v2/payout/payments?created_at_start=2024-01-01&created_at_end=2024-12-31' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

async function listPayouts(filters = {}) {
  const params = new URLSearchParams({
    page: filters.page || 1,
    per_page: filters.perPage || 15,
    ...filters
  });
  
  const response = await fetch(
    `https://api.sandbox.wepayout.com.br/v2/payout/payments?${params}`,
    {
      method: 'GET',
      headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123'
      }
    }
  );
  
  return await response.json();
}

// Usage examples
// List all payouts
const allPayouts = await listPayouts();

// Filter by status
const paidPayouts = await listPayouts({ status_id: 3 });

// Filter by external ID
const orderPayout = await listPayouts({ external_id: 'ORDER-12345' });

// Filter by date range
const monthPayouts = await listPayouts({
  created_at_start: '2024-01-01',
  created_at_end: '2024-01-31'
});

console.log(`Total payouts: ${allPayouts.meta.total}`);
console.log(`Current page: ${allPayouts.meta.current_page} of ${allPayouts.meta.last_page}`);

import requests

def list_payouts(filters=None):
    url = 'https://api.sandbox.wepayout.com.br/v2/payout/payments'
    headers = {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123'
    }
    
    params = {
        'page': 1,
        'per_page': 15
    }
    
    if filters:
        params.update(filters)
    
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Usage examples
# List all payouts
all_payouts = list_payouts()

# Filter by status
paid_payouts = list_payouts({'status_id': 3})

# Filter by external ID
order_payout = list_payouts({'external_id': 'ORDER-12345'})

# Filter by date range
month_payouts = list_payouts({
    'created_at_start': '2024-01-01',
    'created_at_end': '2024-01-31'
})

print(f"Total payouts: {all_payouts['meta']['total']}")
print(f"Current page: {all_payouts['meta']['current_page']} of {all_payouts['meta']['last_page']}")

{
  "data": [
    {
      "id": 54321,
      "merchant_id": 1234,
      "amount": 10000,
      "currency": "BRL",
      "country": "BR",
      "description": "Payment for services rendered",
      "recipient": {
        "name": "João Silva",
        "email": "joao@example.com",
        "document": {
          "type": "CPF",
          "number": "12345678900"
        },
        "bank_account": {
          "bank_code": "001",
          "branch": "1234",
          "account": "12345678",
          "account_digit": "9",
          "account_type": "checking"
        }
      },
      "status": {
        "id": 3,
        "name": "Paid"
      },
      "external_id": "ORDER-12345",
      "notification_url": "https://your-domain.com/webhook/payout",
      "created_at": "2024-06-13T10:00:00.000000Z",
      "updated_at": "2024-06-13T10:05:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 73
  },
  "links": {
    "first": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=1",
    "last": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=5",
    "prev": null,
    "next": "https://api.sandbox.wepayout.com.br/v2/payout/payments?page=2"
  }
}

Use Cases

List All Payouts

Retrieve all payouts with pagination:

async function getAllPayouts(page = 1, perPage = 15) {
  const response = await listPayouts({ page, perPage });
  return response;
}

Filter by Status

Get payouts by specific status:

async function getPayoutsByStatus(statusId) {
  const response = await listPayouts({ status_id: statusId });
  return response.data;
}

// Get paid payouts (status_id = 3)
const paidPayouts = await getPayoutsByStatus(3);

Search by External ID

Find a specific payout by your internal reference:

async function findPayoutByExternalId(externalId) {
  const response = await listPayouts({ external_id: externalId });
  return response.data[0]; // Return first match
}

Date Range Report

Generate a report for a specific date range:

async function getPayoutsReport(startDate, endDate) {
  const response = await listPayouts({
    created_at_start: startDate,
    created_at_end: endDate,
    per_page: 100,
    sort_by: 'created_at',
    sort_order: 'asc'
  });
  
  return response;
}

// Get payouts from January 2024
const report = await getPayoutsReport('2024-01-01', '2024-01-31');

Pagination Handler

Handle pagination to retrieve all payouts:

async function getAllPayoutsWithPagination() {
  let allPayouts = [];
  let currentPage = 1;
  let hasMorePages = true;
  
  while (hasMorePages) {
    const response = await listPayouts({
      page: currentPage,
      per_page: 100
    });
    
    allPayouts = allPayouts.concat(response.data);
    
    hasMorePages = response.meta.current_page < response.meta.last_page;
    currentPage++;
  }
  
  return allPayouts;
}

Status IDs

Common payout status IDs for filtering:

ID	Status Name	Description
1	Created	Payout has been created
2	Processing	Payout is being processed
3	Paid	Payout has been paid successfully
4	Failed	Payout failed
5	Rejected	Payout rejected by compliance
6	Cancelled	Payout was cancelled

Best Practices

Pagination: Always use pagination when listing payouts to avoid performance issues. The default page size is 15, with a maximum of 100 items per page.

Date Filters: When using date range filters, ensure the range is not too large to avoid timeouts. For large date ranges, consider breaking them into smaller chunks.

Caching: Consider caching the results for frequently accessed pages to reduce API calls and improve performance.

Create Payment

Create a new payout payment

Callback Payment

Receive payout status updates

Get Balance

Check your wallet balance

Get Statement

View account statement

Account

Banks

Payin

Payout

KYC

Markup

List Payment

List Payment

Query Parameters

Response

Request Example

Use Cases

Status IDs

Best Practices

Create Payment

Callback Payment

Get Balance

Get Statement

​List Payment

​Query Parameters

​Response

​Request Example

​Use Cases

​Status IDs

​Best Practices

​Related Resources

Create Payment

Callback Payment

Get Balance

Get Statement

List Payment

Query Parameters

Response

Request Example

Use Cases

Status IDs

Best Practices

Related Resources