Rinne API Documentation

Get a specific transaction by ID across all merchants

curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId}"

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/transactions/{transactionId}', 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/transactions/{transactionId}",
  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/transactions/{transactionId}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId}")

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

{
  "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",
  "refundability": {
    "refundable": true,
    "refundable_until": "2026-11-26T02:59:00.000Z",
    "blocked_reason": null
  },
  "fee_policy": {
    "id": "fp_123456789",
    "name": "Standard Processing Fee",
    "description": "Standard processing fee for all transactions",
    "created_at": "2023-01-01T00:00:00.000Z",
    "updated_at": "2023-01-01T00:00:00.000Z"
  },
  "three_d_secure_session": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tds_session_id": "tds_visa_e7c2yfa3867c",
    "card_id": "123e4567-e89b-12d3-a456-426614174000",
    "auth_status": "AUTHENTICATED",
    "consumption_status": "NOT_CONSUMED",
    "amount": 10000,
    "currency": "BRL",
    "failure_reason": null,
    "liability_shift": true,
    "authentication_flow": "frictionless",
    "acs_transaction_id": "b0bb6068-8d68-40a1-9606-20fa01ba74de",
    "ds_transaction_id": "cfb8d11b-8129-414e-983a-3e95f0f4f6c6",
    "server_transaction_id": "dc46fbb1-a898-4760-b8a2-56dae36cb0e2",
    "protocol_version": "2.2.0",
    "expires_at": "2026-02-06T20:35:00.000Z",
    "created_at": "2026-02-06T19:35:00.000Z",
    "updated_at": "2026-02-06T19:35:00.000Z"
  },
  "refunds": [
    {
      "id": "ref_123456789",
      "transaction_id": "tx_123456789",
      "request_id": "req_refund_123",
      "amount": 5000,
      "status": "COMPLETED",
      "reason": "CUSTOMER_REQUEST",
      "description": "Customer requested partial refund",
      "provider_refund_identification": "D13935893202307271346SPpDyb4f123",
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z"
    }
  ],
  "ledger_entries": [
    {
      "id": "le_123456789",
      "posting_set_id": "ps_123456789",
      "pair_token": "pair_123456789",
      "event_id": "evt_123456789",
      "owner_type": "COMPANY",
      "owner_id": "comp_123456789",
      "amount": 10050,
      "operation": "CREDIT",
      "type": "TRANSACTION",
      "currency": "BRL",
      "payment_date": "2023-12-01",
      "installment": 1,
      "total_installments": 1,
      "outstanding_amount": 0,
      "settled": true,
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z",
      "settlement_items": [
        {
          "id": "si_123456789",
          "ledger_entry_id": "le_123456789",
          "settled_amount": 10050,
          "settlement_date": "2023-12-01",
          "method": "PIX",
          "status": "PAID",
          "operation_id": "op_123456789",
          "created_at": "2023-12-01T10:00:00.000Z",
          "updated_at": "2023-12-01T10:00:00.000Z",
          "affiliation_bank_account_id": "ba_123456789",
          "settlement_bank_account_id": "sba_123456789"
        }
      ],
      "company_id": "comp_123456789",
      "organization_id": "org_123456789",
      "affiliation_id": "aff_123456789",
      "transaction_id": "tx_123456789",
      "refund_id": "ref_123456789",
      "dispute_id": "dis_123456789",
      "cashout_id": "co_123456789",
      "fully_settled_at": "2023-12-01T10:00:00.000Z",
      "last_clearing_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"
}

{
  "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": "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"
  }
}

GET

merchants

transactions

{transactionId}

Get a specific transaction by ID across all merchants

curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId}"

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/transactions/{transactionId}', 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/transactions/{transactionId}",
  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/transactions/{transactionId}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/{transactionId}")

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

{
  "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",
  "refundability": {
    "refundable": true,
    "refundable_until": "2026-11-26T02:59:00.000Z",
    "blocked_reason": null
  },
  "fee_policy": {
    "id": "fp_123456789",
    "name": "Standard Processing Fee",
    "description": "Standard processing fee for all transactions",
    "created_at": "2023-01-01T00:00:00.000Z",
    "updated_at": "2023-01-01T00:00:00.000Z"
  },
  "three_d_secure_session": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tds_session_id": "tds_visa_e7c2yfa3867c",
    "card_id": "123e4567-e89b-12d3-a456-426614174000",
    "auth_status": "AUTHENTICATED",
    "consumption_status": "NOT_CONSUMED",
    "amount": 10000,
    "currency": "BRL",
    "failure_reason": null,
    "liability_shift": true,
    "authentication_flow": "frictionless",
    "acs_transaction_id": "b0bb6068-8d68-40a1-9606-20fa01ba74de",
    "ds_transaction_id": "cfb8d11b-8129-414e-983a-3e95f0f4f6c6",
    "server_transaction_id": "dc46fbb1-a898-4760-b8a2-56dae36cb0e2",
    "protocol_version": "2.2.0",
    "expires_at": "2026-02-06T20:35:00.000Z",
    "created_at": "2026-02-06T19:35:00.000Z",
    "updated_at": "2026-02-06T19:35:00.000Z"
  },
  "refunds": [
    {
      "id": "ref_123456789",
      "transaction_id": "tx_123456789",
      "request_id": "req_refund_123",
      "amount": 5000,
      "status": "COMPLETED",
      "reason": "CUSTOMER_REQUEST",
      "description": "Customer requested partial refund",
      "provider_refund_identification": "D13935893202307271346SPpDyb4f123",
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z"
    }
  ],
  "ledger_entries": [
    {
      "id": "le_123456789",
      "posting_set_id": "ps_123456789",
      "pair_token": "pair_123456789",
      "event_id": "evt_123456789",
      "owner_type": "COMPANY",
      "owner_id": "comp_123456789",
      "amount": 10050,
      "operation": "CREDIT",
      "type": "TRANSACTION",
      "currency": "BRL",
      "payment_date": "2023-12-01",
      "installment": 1,
      "total_installments": 1,
      "outstanding_amount": 0,
      "settled": true,
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z",
      "settlement_items": [
        {
          "id": "si_123456789",
          "ledger_entry_id": "le_123456789",
          "settled_amount": 10050,
          "settlement_date": "2023-12-01",
          "method": "PIX",
          "status": "PAID",
          "operation_id": "op_123456789",
          "created_at": "2023-12-01T10:00:00.000Z",
          "updated_at": "2023-12-01T10:00:00.000Z",
          "affiliation_bank_account_id": "ba_123456789",
          "settlement_bank_account_id": "sba_123456789"
        }
      ],
      "company_id": "comp_123456789",
      "organization_id": "org_123456789",
      "affiliation_id": "aff_123456789",
      "transaction_id": "tx_123456789",
      "refund_id": "ref_123456789",
      "dispute_id": "dis_123456789",
      "cashout_id": "co_123456789",
      "fully_settled_at": "2023-12-01T10:00:00.000Z",
      "last_clearing_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"
}

{
  "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": "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

x-api-key

string

header

required

Company API key for authentication

Path Parameters

transactionId

string

required

The transaction ID

Response

Transaction retrieved successfully

Transaction data with full relations including refunds, ledger entries, and settlement items

string

required

Transaction unique identifier

Example:

"tx_123456789"

provider

enum<string>

required

Payment provider

Available options:

CELCOIN,

RINNE,

CAPPTA

Example:

"CELCOIN"

affiliation_id

string

required

Affiliation ID for this transaction

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

request_id

string

required

Unique request ID for this transaction used for idempotency

Example:

"request-123"

mcc

string

required

Merchant Category Code

Example:

"5411"

amount

integer

required

Transaction amount in cents

Example:

10050

currency

enum<string>

required

Transaction currency

Available options:

BRL

Example:

"BRL"

pricing

object

required

Transaction pricing information

Show child attributes

status

enum<string>

required

Transaction status

Available options:

PROCESSING,

AUTHORIZED,

APPROVED,

REFUNDED,

PARTIALLY_REFUNDED,

PENDING_REFUND,

CHARGEDBACK,

WAITING_PAYMENT,

AWAITING_3DS,

RISK_ANALYSIS,

REFUSED,

FAILED,

EXPIRED,

PENDING_CANCELLATION,

CANCELLED

Example:

"APPROVED"

capture_method

enum<string>

required

Transaction capture method

Available options:

EMV,

MAGSTRIPE,

ECOMMERCE,

CONTACTLESS_ICC

Example:

"EMV"

installments

integer | null

required

Number of installments

Example:

1

payment_method

enum<string>

required

Payment method

Available options:

CREDIT_CARD,

DEBIT_CARD,

PIX,

BOLEPIX

Example:

"PIX"

automatic_anticipation

boolean

required

Whether this transaction was automatically anticipated at creation time. Set to true when the affiliation's anticipation_type is AUTOMATIC; false otherwise.

Example:

false

anticipation_days

integer

required

Automatic-anticipation horizon in days (D+N), copied from the affiliation at creation and immutable after. 0 when automatic_anticipation is false. Available to fee and cost policy rule conditions as transaction.anticipation_days. A transaction created before this field existed reports the affiliation's current horizon when automatic_anticipation is true and 0 otherwise, until a one-time backfill stores its value; its card refund window is the next-business-day one until then.

Required range: x >= 0

Example:

1

origin

enum<string>

required

Where the transaction originated. INTERNAL: created through the Rinne API. EXTERNAL: originated outside the platform and registered from a provider event, such as an inbound Pix sent directly to a Pix key or a POS (card machine) transaction.

Available options:

INTERNAL,

EXTERNAL

Example:

"INTERNAL"

company_id

string

required

Company ID that owns this transaction

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

company_document_type

enum<string>

required

Document type of the company that owns this transaction (the receiver).

Available options:

CPF,

CNPJ

Example:

"CNPJ"

company_document_number

string

required

Document number of the company that owns this transaction (the receiver), without formatting: CPF (11 digits) or CNPJ (14 characters, alphanumeric CNPJ supported).

Example:

"12345678000195"

pix_payer

object | null

required

The account holder who actually paid a PIX transaction, as reported by the payment provider when the payment is received. May differ from consumer, which is what the integrator sent at creation. null until the payment is received, and for every other payment method. A PIX received on a Pix key without a charge carries it from creation.

Show child attributes

created_at

string<date-time>

required

Transaction creation timestamp

Example:

"2023-12-01T10:00:00.000Z"

refundability

object

required

Whether a refund can be requested on this transaction now, and until when, answered from the same rules the refund endpoint applies, so a client can leave out or date its refund action instead of meeting a rejection. It covers a refund of some amount: the rules that depend on the amount asked for (the amount left to refund, partial refunds) are checked on the refund request. The answer reflects the moment of the read; a window can close before a refund request arrives, which is then refused with REFUND_NOT_ALLOWED.

Show child attributes

fee_policy

object | null

required

Fee policy details

Show child attributes

three_d_secure_session

object | null

required

The 3DS session linked to this transaction (newest, when more than one was ever linked), or null when the transaction did not use a 3DS session. Only returned on single-transaction endpoints; list endpoints carry just three_d_secure_session_id.

Show child attributes

refunds

object[]

required

Refunds associated with this transaction

Show child attributes

ledger_entries

object[] | null

required

Ledger entries associated with this transaction

Show child attributes

fee_policy_id

string | null

Fee policy ID applied to this transaction

Example:

"fee_policy_123"

cost_policy_id

string | null

Cost policy ID applied to this transaction

Example:

"cost_policy_123"

approved_amount

integer | null

Approved amount in cents

Example:

10050

refunded_amount

integer | null

Total amount refunded in cents (sum of completed refunds)

Example:

0

three_d_secure_session_id

string<uuid> | null

ID of the 3DS session linked to this transaction, if any. Set when the transaction was created with a 3DS session (session-first flow) or authenticated via the /authenticate endpoint (transaction-first flow).

Example:

"550e8400-e29b-41d4-a716-446655440000"

acquirer_response_code

string | null

Acquirer response code

Example:

"00"

pix_data

object | null

PIX-specific data (present if payment_method is PIX)

Show child attributes

bolepix_data

object | null

Bolepix-specific data (present if payment_method is BOLEPIX)

Show child attributes

card_data

object | null

Card-specific data (present if payment_method is CREDIT_CARD or DEBIT_CARD)

Show child attributes

soft_descriptor

string | null

The soft_descriptor sent with the create request, as sent. Null when the request had none.

Example:

"MYSTORE"

serial_number

string | null

Terminal serial number

Example:

"12345678"

nsu

string | null

Network Sequential Number

Example:

"000123"

metadata

object | null

Additional metadata

latest_refund_at

string<date-time> | null

Latest refund timestamp (for the most recent completed refund)

Example:

"2023-12-01T10:00:00.000Z"

status_reason

enum<string> | null

Status reason details. REVERSED indicates a failed card transaction whose charge was later found at the acquirer and reversed by reconciliation.

Available options:

PROVIDER,

ACQUIRER,

ANTIFRAUD,

INTERNAL_ERROR,

NO_ACQUIRER,

ACQUIRER_TIMEOUT,

CHALLENGE_NOT_ALLOWED,

REVERSED

Example:

"PROVIDER"

approved_at

string | null

Transaction approval timestamp

Example:

"2023-12-01T10:00:00.000Z"

company_full_name

string

Company full name

Example:

"Test Company"

company_name

string | null

Company name

Example:

"Test Company"

organization_id

string | null

Organization transaction ID (for refunds/chargebacks)

Example:

"tx_organization_123456"

consumer

object | null

Consumer information

Show child attributes

updated_at

string<date-time> | null

Transaction last update timestamp

Example:

"2023-12-01T10:00:00.000Z"

Introduction

Merchants

Pricing

Tap-on-Phone

Webhooks

Organization Management

User Management

System

Get a specific transaction by ID across all merchants

Authorizations

Path Parameters

Response