Skip to main content
GET
/
v1
/
transactions
Get transactions
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/transactions \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "tx_123456789",
      "provider": "CELCOIN",
      "affiliation_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "provider_transaction_id": "prov_tx_123456",
      "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
        }
      },
      "fee_policy_id": "fee_policy_123",
      "cost_policy_id": "cost_policy_123",
      "approved_amount": 10050,
      "refunded_amount": 0,
      "status": "APPROVED",
      "acquirer_response_code": "00",
      "acquirer_name": "Visa",
      "capture_method": "EMV",
      "installments": 1,
      "payment_method": "PIX",
      "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"
      },
      "soft_descriptor": "MYSTORE",
      "serial_number": "12345678",
      "nsu": "000123",
      "metadata": {},
      "latest_refund_at": "2023-12-01T10:00:00.000Z",
      "provider_created_at": "2023-12-01T09:00:00.000Z",
      "status_reason": "PROVIDER",
      "approved_at": "2023-12-01T10:00:00.000Z",
      "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "company_full_name": "Test Company",
      "company_name": "Test Company",
      "organization_id": "tx_organization_123456",
      "consumer": {
        "full_name": "João Silva",
        "email": "joao@email.com",
        "pix_key": "joao@email.com",
        "document_type": "CPF",
        "document_number": "81146431023",
        "phone": "+5511999999999",
        "birth_date": "15-08-1990",
        "address": {
          "street": "Rua das Flores",
          "street_number": "123",
          "complement": "Apt 101",
          "neighborhood": "Centro",
          "zipcode": "12345678",
          "country": "076",
          "state": "SP",
          "city": "São Paulo"
        }
      },
      "created_at": "2023-12-01T10:00:00.000Z",
      "updated_at": "2023-12-01T10:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:20

Number of transactions per page

Required range: 1 <= x <= 100
​
status
enum<string>[]

Comma-separated list of statuses to filter by (e.g., PROCESSING,APPROVED)

​
provider
enum<string>

Filter by provider (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE
​
id
string

Filter by transaction ID

​
installments
integer

Filter by number of installments

Required range: x >= 1
​
payment_method
enum<string>

Filter by payment method

Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
MONEY,
PIX
​
capture_method
enum<string>

Filter by capture method

Available options:
EMV,
MAGSTRIPE,
ECOMMERCE,
CONTACTLESS_ICC
​
affiliation_id
string

Filter by affiliation ID

​
organization_id
string

Filter by organization transaction ID

​
provider_transaction_id
string

Filter by provider transaction ID

​
request_id
string

Filter by request ID

​
amount
integer

Filter by transaction amount (in cents)

​
amount_from
integer

Minimum amount (inclusive) in cents

​
amount_to
integer

Maximum amount (inclusive) in cents

​
created_at_from
string<date-time>

Start creation datetime (ISO 8601) inclusive

​
created_at_to
string<date-time>

End creation datetime (ISO 8601) inclusive

​
sort
enum<string>[]

Multi-field sort string (e.g., -created_at,amount). Allowed fields: created_at, amount, installments

Response

Paginated list of transactions

​
data
object[]
​
pagination
object