curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/transactions \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/transactions"
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/transactions', 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/transactions",
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/transactions"
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/transactions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/transactions")
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": "tx_123456789",
"provider": "CELCOIN",
"affiliation_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
"request_id": "request-123",
"mcc": "5411",
"amount": 10050,
"currency": "BRL",
"pricing": {
"fee": {
"percentage": 2.5,
"flat": 50,
"minimum_price": 100
},
"cost": {
"percentage": 2.5,
"flat": 50,
"minimum_price": 100
}
},
"status": "APPROVED",
"capture_method": "EMV",
"installments": 1,
"payment_method": "PIX",
"automatic_anticipation": false,
"anticipation_days": 1,
"origin": "INTERNAL",
"company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
"company_document_type": "CNPJ",
"company_document_number": "12345678000195",
"pix_payer": {
"account_holder_name": "Maria Silva",
"account_holder_document_number": "12345678901",
"ispb": "18236120"
},
"created_at": "2023-12-01T10:00:00.000Z",
"fee_policy_id": "fee_policy_123",
"cost_policy_id": "cost_policy_123",
"approved_amount": 10050,
"refunded_amount": 0,
"three_d_secure_session_id": "550e8400-e29b-41d4-a716-446655440000",
"acquirer_response_code": "00",
"pix_data": {
"pix_key_id": "pix_key_123",
"description": "Payment for order #123",
"qr_code": "00020126580014br.gov.bcb.pix0136a3dbd0c2-9f79-4f86-8caa-47779b3f2793520400005303986540510.005802BR5913Test Company6008São Paulo62070503***6304E2CA",
"expires_at": "2023-12-02T10:00:00.000Z",
"identification": "order_123",
"expiration_in_seconds": 86400,
"end_to_end_id": "E12345678202312101234567890123456",
"pix_payment_id": "27bff30a-3470-4e8e-a4f5-a16cf25be0e3",
"due_date": "2025-12-31",
"expiration_in_days_after_due_date": 30,
"interest": {
"modality": "PERCENTAGE_PER_MONTH",
"amount": 1000,
"percentage": 10.5
},
"fine": {
"modality": "PERCENTAGE",
"amount": 2000,
"percentage": 2.5
},
"discount": {
"modality": "PERCENTAGE_UNTIL_DATE",
"amount": 2,
"percentage": 50,
"discount_dates_config": [
{
"until_date": "2025-12-15",
"percentage": 10
},
{
"until_date": "2025-12-20",
"percentage": 5
}
]
},
"abatement": {
"modality": "FIXED",
"amount": 5000,
"percentage": 5
}
},
"bolepix_data": {
"pix_key_id": "pix_key_123",
"external_request_id": "ext-req-123",
"due_date": "2025-12-31",
"expiration_in_days_after_due_date": 30,
"boleto_transaction_id": "boleto-123",
"bank_issuer": "Banco do Brasil",
"bank_code": "001",
"bank_branch": "1234",
"bank_account_number": "12345-6",
"bar_code": "00190000090299993600000000000000185830000010000",
"bank_line": "00190.00009 02999.936001 00000.000001 8 58300000010000",
"bank_assignor": "Company Name",
"pix_transaction_id": "pix-123",
"pix_identification": "txid123456789",
"pix_emv": "00020126580014br.gov.bcb.pix...",
"paid_via": "PIX",
"paid_amount": 50000,
"paid_at": "2025-12-20T10:00:00.000Z",
"discount": {
"amount": 5000,
"percentage": 10,
"modality": "FIXED",
"until_date": "2025-12-25"
},
"fine_percentage": 2,
"monthly_interest_percentage": 1
},
"card_data": {
"last_digits": "1111",
"expiry_month": "12",
"expiry_year": "2028",
"brand": "VISA",
"device_id": "device-123",
"cardholder_name": "John Doe",
"country": "BR",
"wallet_type": "APPLE_PAY",
"display_name": "Visa •••• 1111",
"authentication_type": "3DS"
},
"soft_descriptor": "MYSTORE",
"serial_number": "12345678",
"nsu": "000123",
"metadata": "<unknown>",
"latest_refund_at": "2023-12-01T10:00:00.000Z",
"status_reason": "PROVIDER",
"approved_at": "2023-12-01T10:00:00.000Z",
"company_full_name": "Test Company",
"company_name": "Test Company",
"organization_id": "tx_organization_123456",
"consumer": {
"document_type": "CPF",
"full_name": "João Silva",
"email": "[email protected]",
"pix_key": "[email protected]",
"document_number": "81146431023",
"phone": "+5511999999999",
"birth_date": "15-08-1990",
"address": {
"street": "Rua das Flores",
"neighborhood": "Centro",
"zipcode": "12345678",
"country": "076",
"state": "SP",
"city": "São Paulo",
"street_number": "123",
"complement": "Apt 101"
}
},
"updated_at": "2023-12-01T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 50,
"totalPages": 3,
"hasNext": true,
"hasPrev": false
}
}{
"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": "AUTHORIZATION_ERROR",
"message": "You need 'admin' permissions to access this resource",
"status": 403,
"path": "/companies",
"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"
}
}Get transactions
Returns a paginated list of transactions for the authenticated company with optional filters. Requires the transaction.list permission.
Pagination: pagination.total and pagination.totalPages are estimates while
further pages exist, and exact once the caller reaches the last page that has rows
on it; a page past the end reports an estimate capped at the requested offset.
hasNext and hasPrev are always exact, so page through with hasNext.
curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/transactions \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/transactions"
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/transactions', 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/transactions",
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/transactions"
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/transactions")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/transactions")
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": "tx_123456789",
"provider": "CELCOIN",
"affiliation_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
"request_id": "request-123",
"mcc": "5411",
"amount": 10050,
"currency": "BRL",
"pricing": {
"fee": {
"percentage": 2.5,
"flat": 50,
"minimum_price": 100
},
"cost": {
"percentage": 2.5,
"flat": 50,
"minimum_price": 100
}
},
"status": "APPROVED",
"capture_method": "EMV",
"installments": 1,
"payment_method": "PIX",
"automatic_anticipation": false,
"anticipation_days": 1,
"origin": "INTERNAL",
"company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
"company_document_type": "CNPJ",
"company_document_number": "12345678000195",
"pix_payer": {
"account_holder_name": "Maria Silva",
"account_holder_document_number": "12345678901",
"ispb": "18236120"
},
"created_at": "2023-12-01T10:00:00.000Z",
"fee_policy_id": "fee_policy_123",
"cost_policy_id": "cost_policy_123",
"approved_amount": 10050,
"refunded_amount": 0,
"three_d_secure_session_id": "550e8400-e29b-41d4-a716-446655440000",
"acquirer_response_code": "00",
"pix_data": {
"pix_key_id": "pix_key_123",
"description": "Payment for order #123",
"qr_code": "00020126580014br.gov.bcb.pix0136a3dbd0c2-9f79-4f86-8caa-47779b3f2793520400005303986540510.005802BR5913Test Company6008São Paulo62070503***6304E2CA",
"expires_at": "2023-12-02T10:00:00.000Z",
"identification": "order_123",
"expiration_in_seconds": 86400,
"end_to_end_id": "E12345678202312101234567890123456",
"pix_payment_id": "27bff30a-3470-4e8e-a4f5-a16cf25be0e3",
"due_date": "2025-12-31",
"expiration_in_days_after_due_date": 30,
"interest": {
"modality": "PERCENTAGE_PER_MONTH",
"amount": 1000,
"percentage": 10.5
},
"fine": {
"modality": "PERCENTAGE",
"amount": 2000,
"percentage": 2.5
},
"discount": {
"modality": "PERCENTAGE_UNTIL_DATE",
"amount": 2,
"percentage": 50,
"discount_dates_config": [
{
"until_date": "2025-12-15",
"percentage": 10
},
{
"until_date": "2025-12-20",
"percentage": 5
}
]
},
"abatement": {
"modality": "FIXED",
"amount": 5000,
"percentage": 5
}
},
"bolepix_data": {
"pix_key_id": "pix_key_123",
"external_request_id": "ext-req-123",
"due_date": "2025-12-31",
"expiration_in_days_after_due_date": 30,
"boleto_transaction_id": "boleto-123",
"bank_issuer": "Banco do Brasil",
"bank_code": "001",
"bank_branch": "1234",
"bank_account_number": "12345-6",
"bar_code": "00190000090299993600000000000000185830000010000",
"bank_line": "00190.00009 02999.936001 00000.000001 8 58300000010000",
"bank_assignor": "Company Name",
"pix_transaction_id": "pix-123",
"pix_identification": "txid123456789",
"pix_emv": "00020126580014br.gov.bcb.pix...",
"paid_via": "PIX",
"paid_amount": 50000,
"paid_at": "2025-12-20T10:00:00.000Z",
"discount": {
"amount": 5000,
"percentage": 10,
"modality": "FIXED",
"until_date": "2025-12-25"
},
"fine_percentage": 2,
"monthly_interest_percentage": 1
},
"card_data": {
"last_digits": "1111",
"expiry_month": "12",
"expiry_year": "2028",
"brand": "VISA",
"device_id": "device-123",
"cardholder_name": "John Doe",
"country": "BR",
"wallet_type": "APPLE_PAY",
"display_name": "Visa •••• 1111",
"authentication_type": "3DS"
},
"soft_descriptor": "MYSTORE",
"serial_number": "12345678",
"nsu": "000123",
"metadata": "<unknown>",
"latest_refund_at": "2023-12-01T10:00:00.000Z",
"status_reason": "PROVIDER",
"approved_at": "2023-12-01T10:00:00.000Z",
"company_full_name": "Test Company",
"company_name": "Test Company",
"organization_id": "tx_organization_123456",
"consumer": {
"document_type": "CPF",
"full_name": "João Silva",
"email": "[email protected]",
"pix_key": "[email protected]",
"document_number": "81146431023",
"phone": "+5511999999999",
"birth_date": "15-08-1990",
"address": {
"street": "Rua das Flores",
"neighborhood": "Centro",
"zipcode": "12345678",
"country": "076",
"state": "SP",
"city": "São Paulo",
"street_number": "123",
"complement": "Apt 101"
}
},
"updated_at": "2023-12-01T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 50,
"totalPages": 3,
"hasNext": true,
"hasPrev": false
}
}{
"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": "AUTHORIZATION_ERROR",
"message": "You need 'admin' permissions to access this resource",
"status": 403,
"path": "/companies",
"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
Query Parameters
Page number for pagination
x >= 1Number of transactions per page
1 <= x <= 100Comma-separated list of statuses to filter by (e.g., PROCESSING,APPROVED)
PROCESSING, AUTHORIZED, APPROVED, REFUNDED, PARTIALLY_REFUNDED, PENDING_REFUND, CHARGEDBACK, WAITING_PAYMENT, AWAITING_3DS, RISK_ANALYSIS, REFUSED, FAILED, EXPIRED, PENDING_CANCELLATION, CANCELLED Filter by provider (accepts lowercase and uppercase, returns uppercase)
CELCOIN, RINNE, CAPPTA Filter by transaction ID
Filter by number of installments (1-21)
1 <= x <= 21Filter by payment method
CREDIT_CARD, DEBIT_CARD, PIX, BOLEPIX Filter by capture method
EMV, MAGSTRIPE, ECOMMERCE, CONTACTLESS_ICC Filter by affiliation ID
Filter by organization transaction ID
Filter by provider transaction ID
Filter by request ID
Filter by transaction amount (in cents)
Minimum amount (inclusive) in cents
Maximum amount (inclusive) in cents
Start creation datetime (ISO 8601) inclusive
End creation datetime (ISO 8601) inclusive
Multi-field sort string (e.g., -created_at,amount). Allowed fields: created_at, amount, installments
created_at, amount, installments, -created_at, -amount, -installments 
