Rinne API Documentation

Authorizations

x-api-key

string

header

required

Company API key for authentication

Body

application/json

Schema for creating a new transaction.

provider

enum<string>

required

Payment provider identifier

Available options:

CELCOIN

Example:

"CELCOIN"

request_id

string

required

Unique request ID for this transaction (used for idempotency)

Minimum string length: 1

Example:

"request-123"

amount

integer

required

Transaction amount in cents (e.g., 10050 = R$ 100,50)

Required range: 1 <= x <= 1500000000

Example:

10050

capture_method

enum<string>

required

Transaction capture method:

EMV: Chip card
MAGSTRIPE: Magnetic stripe
ECOMMERCE: Online transaction
CONTACTLESS_ICC: Contactless payment

Available options:

EMV,

MAGSTRIPE,

ECOMMERCE,

CONTACTLESS_ICC

Example:

"ECOMMERCE"

payment_method

enum<string>

required

Payment method:

CREDIT_CARD: Credit card payment
DEBIT_CARD: Debit card payment
PIX: Instant payment
BOLEPIX: Hybrid Boleto + PIX payment

Available options:

CREDIT_CARD,

DEBIT_CARD,

PIX,

BOLEPIX

Example:

"PIX"

currency

enum<string>

default:BRL

Transaction currency (defaults to BRL)

Available options:

BRL

Example:

"BRL"

installments

integer

default:1

Number of installments (1-18). Defaults to 1 if not sent. Must be 1 when payment_method is PIX or BOLEPIX.

Required range: 1 <= x <= 18

Example:

1

pix_data

object

PIX-specific data. Required when payment_method is PIX. When due_date is provided: consumer is required (full_name, document_number, document_type) and use expiration_in_days_after_due_date (do not send expiration_in_seconds). When due_date is NOT provided: use expiration_in_seconds (do not send expiration_in_days_after_due_date).

Show child attributes

Example:

{
  "pix_key_id": "pix_key_123",
  "description": "Payment for order #123",
  "expiration_in_seconds": 3600,
  "due_date": "2025-12-31",
  "expiration_in_days_after_due_date": 30,
  "interest": {
    "percentage": 1,
    "modality": "PERCENTAGE_PER_MONTH"
  },
  "fine": { "percentage": 2, "modality": "PERCENTAGE" },
  "discount": {
    "modality": "PERCENTAGE_UNTIL_DATE",
    "discount_dates_config": [
      {
        "until_date": "2025-12-15",
        "percentage": 10
      },
      {
        "until_date": "2025-12-20",
        "percentage": 5
      }
    ]
  }
}

bolepix_data

object

BOLEPIX-specific data. Required when payment_method is BOLEPIX. When payment_method is BOLEPIX, consumer is required with full_name, document_type, document_number, and full address including address.street_number.

Show child attributes

Example:

{
  "due_date": "2025-12-31",
  "expiration_in_days_after_due_date": 30,
  "discount": {
    "amount": 5000,
    "modality": "FIXED",
    "until_date": "2025-12-25"
  },
  "fine_percentage": 2,
  "monthly_interest_percentage": 1
}

card_data

object

Card payment data. Required for CREDIT_CARD and DEBIT_CARD payment methods.

Option 1
Option 2

Show child attributes

Example:

{
  "network_token": "ev:encrypted:...",
  "cryptogram": "1234567890123456",
  "expiry_month": "12",
  "expiry_year": "2025",
  "authentication_type": "3DS",
  "wallet_type": "APPLE_PAY",
  "display_name": "Visa •••• 1111"
}

three_d_secure_session_id

string<uuid>

ID of an authenticated 3DS session to use for this transaction (session-first flow). When provided, the cryptogram and ECI from the session are injected into the card data. The session must be authenticated (auth_status=AUTHENTICATED), not expired, not already consumed, and match the transaction's company, amount, and currency.

Example:

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

require_3ds

boolean

Card transactions only. When true, the transaction is created directly in AWAITING_3DS and is not sent to the provider until /authenticate is called with an authenticated 3DS session.

Example:

true

refuse_on_challenge

boolean

Card transactions only. When true, challenge-triggered paths are refused (REFUSED) instead of transitioning to AWAITING_3DS. Cannot be true together with require_3ds.

Example:

false

consumer

object

Optional consumer/customer information. Required with full_name, document_number, and document_type when pix_data.due_date is provided. When payment_method is BOLEPIX, consumer is required and must include full_name, document_type, document_number, and full address including address.street_number.

Show child attributes

Example:

{
  "full_name": "João Silva",
  "email": "[email protected]",
  "pix_key": "[email protected]",
  "document_type": "CPF",
  "document_number": "81146431023",
  "phone": "+5511999999999",
  "birth_date": "15-08-1990"
}

metadata

object

Optional additional metadata (key-value pairs)

Example:

{
  "order_id": "order-123",
  "customer_id": "cust-456"
}

split_rules

object[]

Optional split rules for transaction revenue sharing.

Important rules:

Cannot mix amount and percentage in same transaction
If using amounts: sum must equal transaction amount
If using percentages: sum must equal 100%

Show child attributes

Example:

[
  {
    "company_id": "company-1",
    "amount": 5000,
    "charge_processing_cost": true
  },
  {
    "company_id": "company-2",
    "amount": 5050,
    "charge_processing_cost": false
  }
]

soft_descriptor

string

Optional text shown on cardholder statement (max 13 chars)

Maximum string length: 13

Example:

"MYSTORE"

serial_number

string

Optional terminal serial number

Example:

"12345678"

nsu

string

Optional Network Sequential Number

Example:

"000123"

fee_policy_id

string

Optional fee policy ID to use for this transaction. If provided, this takes priority over the company's default fee policy. The fee policy must belong to the same organization as the company.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Transaction created successfully

Transaction data returned by the API

string

required

Transaction unique identifier

Example:

"tx_123456789"

provider

enum<string>

required

Payment provider

Available options:

CELCOIN,

RINNE

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,

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"

company_id

string

required

Company ID that owns this transaction

Example:

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

created_at

string<date-time>

required

Transaction creation timestamp

Example:

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

provider_transaction_id

string | null

Transaction ID in provider system

Example:

"prov_tx_123456"

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

acquirer_response_code

string | null

Acquirer response code

Example:

"00"

acquirer_name

string | null

Acquirer name

Example:

"Visa"

pix_data

object

PIX-specific data (present if payment_method is PIX)

Show child attributes

bolepix_data

object

Bolepix-specific data (present if payment_method is BOLEPIX)

Show child attributes

soft_descriptor

string | null

Soft descriptor shown on cardholder statement

Example:

"MYSTORE"

serial_number

string | null

Terminal serial number

Example:

"12345678"

nsu

string | null

Network Sequential Number

Example:

"000123"

metadata

object

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"

provider_created_at

string<date-time> | null

Creation timestamp in provider system

Example:

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

status_reason

enum<string> | null

Status reason details

Available options:

PROVIDER,

ACQUIRER,

ANTIFRAUD,

INTERNAL_ERROR,

NO_ACQUIRER,

ACQUIRER_TIMEOUT,

CHALLENGE_NOT_ALLOWED

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

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

Webhooks

Organization Management

User Management

System

Create a new transaction

Authorizations

Body

Response