List cashouts for a specific merchant
curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts', 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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "req_123456789",
"external_request_id": "123e4567-e89b-12d3-a456-426614174000",
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PROCESSING",
"created_at": "2025-01-01T10:00:00.000Z",
"updated_at": "2025-01-01T10:05:00.000Z",
"destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"fee": 150,
"cost": 100,
"fee_policy_id": "123e4567-e89b-12d3-a456-426614174002",
"cost_policy_id": "123e4567-e89b-12d3-a456-426614174003",
"error_message": "Insufficient funds",
"returned_amount": 5000,
"latest_return_at": "2025-01-01T11:00:00.000Z",
"returns": [
{
"id": "123e4567-e89b-12d3-a456-426614174004",
"cashout_id": "123e4567-e89b-12d3-a456-426614174000",
"provider_return_id": "b94150c9-7dad-4b21-8183-50c83f4c5dd8",
"amount": 1000,
"reason": "CUSTOMER_REQUEST",
"return_identification": "return_123456789",
"original_end_to_end_id": "E12345678202501011100000000001",
"original_id": "tx_123456789",
"created_at": "2025-01-01T11:00:00.000Z",
"updated_at": "2025-01-01T11:00:00.000Z"
}
],
"metadata": {
"custom_field": "value",
"order_id": "order_123"
},
"end_to_end_id": "E12345678202501271234567890123456"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 50,
"totalPages": 3,
"hasNext": true,
"hasPrev": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"status": 400,
"details": {
"issues": [
{
"field": "email",
"type": "REQUIRED",
"message": "Field 'email' is required",
"value": "invalid_value",
"constraints": {
"min": 18,
"max": 120
}
}
]
},
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "AUTHENTICATION_ERROR",
"message": "Authentication required to access this resource",
"status": 401,
"details": {
"reason": "Invalid API key"
},
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Company with ID '123' not found",
"status": 404,
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Cashouts
List cashouts for a specific merchant
Returns paginated list of cashouts for a merchant that belongs to the authenticated organization
GET
/
v1
/
merchants
/
{merchantId}
/
cashouts
List cashouts for a specific merchant
curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts', 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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.rinne.com.br/core/v1/merchants/{merchantId}/cashouts")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "req_123456789",
"external_request_id": "123e4567-e89b-12d3-a456-426614174000",
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PROCESSING",
"created_at": "2025-01-01T10:00:00.000Z",
"updated_at": "2025-01-01T10:05:00.000Z",
"destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"fee": 150,
"cost": 100,
"fee_policy_id": "123e4567-e89b-12d3-a456-426614174002",
"cost_policy_id": "123e4567-e89b-12d3-a456-426614174003",
"error_message": "Insufficient funds",
"returned_amount": 5000,
"latest_return_at": "2025-01-01T11:00:00.000Z",
"returns": [
{
"id": "123e4567-e89b-12d3-a456-426614174004",
"cashout_id": "123e4567-e89b-12d3-a456-426614174000",
"provider_return_id": "b94150c9-7dad-4b21-8183-50c83f4c5dd8",
"amount": 1000,
"reason": "CUSTOMER_REQUEST",
"return_identification": "return_123456789",
"original_end_to_end_id": "E12345678202501011100000000001",
"original_id": "tx_123456789",
"created_at": "2025-01-01T11:00:00.000Z",
"updated_at": "2025-01-01T11:00:00.000Z"
}
],
"metadata": {
"custom_field": "value",
"order_id": "order_123"
},
"end_to_end_id": "E12345678202501271234567890123456"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 50,
"totalPages": 3,
"hasNext": true,
"hasPrev": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"status": 400,
"details": {
"issues": [
{
"field": "email",
"type": "REQUIRED",
"message": "Field 'email' is required",
"value": "invalid_value",
"constraints": {
"min": 18,
"max": 120
}
}
]
},
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "AUTHENTICATION_ERROR",
"message": "Authentication required to access this resource",
"status": 401,
"details": {
"reason": "Invalid API key"
},
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Company with ID '123' not found",
"status": 404,
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Authorizations
Company API key for authentication
Path Parameters
The merchant ID
Query Parameters
Page number
Required range:
x >= 1Number of items per page
Required range:
1 <= x <= 100Filter by cashout status
Available options:
PENDING, PROCESSING, COMPLETED, FAILED, PARTIALLY_RETURNED, RETURNED Filter by cashout method
Available options:
PIX Filter cashouts from this date (inclusive)
Filter cashouts to this date (inclusive)
Filter by request ID
Filter by origin bank account ID
Filter by destination bank account ID
Sort by field
Available options:
created_at, amount, status ⌘I

