Rinne API Documentation

curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "request_id": "req_123456789",
  "origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
  "amount": 10000,
  "method": "PIX"
}
'

{
  "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_bank_account_nickname": "Main operations account",
  "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"
}

POST

merchants

{merchantId}

cashouts

curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/cashouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "request_id": "req_123456789",
  "origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
  "amount": 10000,
  "method": "PIX"
}
'

{
  "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_bank_account_nickname": "Main operations account",
  "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"
}

Authorizations

x-api-key

string

header

required

Company API key for authentication

Path Parameters

merchantId

string

required

The merchant ID

Body

application/json

Schema for creating a new cashout request.

Exactly one destination must be provided, either by reference to a destination the company already registered — destination_bank_account_id or destination_pix_key_id — or inline — destination_bank_account or destination_pix_key — in which case the destination is registered (or matched to an existing one) as part of the cashout. Inline destinations are the recommended way to pay to a key or account the company has not registered yet: the cashout response carries the resulting destination_pix_key_id or destination_bank_account_id.

request_id

string

required

Client-generated request ID for tracking

Example:

"req_123456789"

origin_bank_account_id

string<uuid>

required

ID of the bank account to debit from

Example:

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

amount

integer

required

Amount to transfer in cents

Required range: x >= 1

Example:

10000

method

enum<string>

required

Cashout method

Available options:

PIX

Example:

"PIX"

destination_bank_account_id

string<uuid>

ID of a registered company bank account to credit (omit when using another destination field)

Example:

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

destination_pix_key_id

string<uuid>

ID of a registered company PIX key to pay to (omit when using another destination field)

Example:

"223e4567-e89b-12d3-a456-426614174002"

destination_bank_account

object

Bank account to credit, given inline (omit when using another destination field)

Show child attributes

destination_pix_key

object

PIX key to pay to, given inline (omit when using another destination field)

Show child attributes

currency

enum<string>

default:BRL

Currency code (defaults to BRL if not provided)

Available options:

BRL

Example:

"BRL"

metadata

object

Optional metadata object for storing custom key-value pairs

Example:

{
  "custom_field": "value",
  "order_id": "order_123"
}

Response

Cashout created successfully

Cashout response

string<uuid>

required

Internal cashout ID

Example:

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

request_id

string

required

Client-generated request ID

Example:

"req_123456789"

external_request_id

string<uuid>

required

External provider request ID

Example:

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

company_id

string<uuid>

required

Company ID

Example:

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

origin_bank_account_id

string<uuid>

required

ID of the bank account to debit from

Example:

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

amount

integer

required

Amount to transfer in cents

Example:

10000

currency

enum<string>

required

Currency code

Available options:

BRL

Example:

"BRL"

method

enum<string>

required

Cashout method

Available options:

PIX

Example:

"PIX"

status

enum<string>

required

Cashout status

Available options:

PENDING,

PROCESSING,

COMPLETED,

PARTIALLY_RETURNED,

RETURNED,

FAILED

Example:

"PROCESSING"

created_at

string<date-time>

required

Creation timestamp

Example:

"2025-01-01T10:00:00.000Z"

updated_at

string<date-time>

required

Last update timestamp

Example:

"2025-01-01T10:05:00.000Z"

destination_bank_account_id

string<uuid> | null

ID of the bank account to credit to (null when destination is a PIX key)

Example:

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

destination_bank_account_nickname

string | null

Current nickname of the destination bank account (null when the destination is a PIX key or the account has no nickname)

Example:

"Main operations account"

destination_pix_key_id

string<uuid> | null

ID of the company PIX key paid to (null when destination is a bank account)

Example:

"223e4567-e89b-12d3-a456-426614174002"

fee

integer

Total fee in cents charged on the cashout

Example:

150

cost

integer

Total cost in cents for this cashout

Example:

100

fee_policy_id

string<uuid> | null

ID of the fee policy used for pricing this cashout

Example:

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

cost_policy_id

string<uuid> | null

ID of the cost policy used for pricing this cashout

Example:

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

error_message

string | null

Error message if cashout failed

Example:

"Insufficient funds"

returned_amount

integer | null

Total amount returned in cents (sum of all returns)

Example:

5000

latest_return_at

string<date-time> | null

Timestamp of the latest return

Example:

"2025-01-01T11:00:00.000Z"

returns

object[]

List of returns

Show child attributes

metadata

object | null

Metadata object for storing custom key-value pairs

Example:

{
  "custom_field": "value",
  "order_id": "order_123"
}

end_to_end_id

string | null

End to End ID from the payment provider (PIX transaction identifier)

Example:

"E12345678202501271234567890123456"

Introduction

Merchants

Pricing

Tap-on-Phone

Webhooks

Organization Management

User Management

System

Create a cashout request for a specific merchant

Authorizations

Path Parameters

Body

Response