Rinne API Documentation

Create a new internal transfer request

curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers \
  --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_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
  "amount": 10000,
  "metadata": {
    "custom_field": "value",
    "transfer_reason": "settlement"
  }
}
'

import requests

url = "https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers"

payload = {
    "request_id": "req_123456789",
    "origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount": 10000,
    "metadata": {
        "custom_field": "value",
        "transfer_reason": "settlement"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    request_id: 'req_123456789',
    origin_bank_account_id: '123e4567-e89b-12d3-a456-426614174000',
    destination_bank_account_id: '123e4567-e89b-12d3-a456-426614174001',
    amount: 10000,
    metadata: {custom_field: 'value', transfer_reason: 'settlement'}
  })
};

fetch('https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers', 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/banking/internal-transfers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'request_id' => 'req_123456789',
    'origin_bank_account_id' => '123e4567-e89b-12d3-a456-426614174000',
    'destination_bank_account_id' => '123e4567-e89b-12d3-a456-426614174001',
    'amount' => 10000,
    'metadata' => [
        'custom_field' => 'value',
        'transfer_reason' => 'settlement'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers"

	payload := strings.NewReader("{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
  "amount": 10000,
  "status": "PENDING",
  "provider_transfer_id": "provider_tx_123456",
  "error_message": "Insufficient funds",
  "created_at": "2023-01-01T00:00:00.000Z",
  "updated_at": "2023-01-01T00:00:00.000Z",
  "metadata": {
    "custom_field": "value",
    "transfer_reason": "settlement"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation error",
    "status": 400,
    "details": {
      "issues": [
        {
          "field": "email",
          "type": "REQUIRED",
          "message": "Field 'email' is required",
          "value": "invalid_value",
          "constraints": {
            "min": 18,
            "max": 120
          }
        }
      ]
    },
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}

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

POST

banking

internal-transfers

Create a new internal transfer request

curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers \
  --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_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
  "amount": 10000,
  "metadata": {
    "custom_field": "value",
    "transfer_reason": "settlement"
  }
}
'

import requests

url = "https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers"

payload = {
    "request_id": "req_123456789",
    "origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount": 10000,
    "metadata": {
        "custom_field": "value",
        "transfer_reason": "settlement"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    request_id: 'req_123456789',
    origin_bank_account_id: '123e4567-e89b-12d3-a456-426614174000',
    destination_bank_account_id: '123e4567-e89b-12d3-a456-426614174001',
    amount: 10000,
    metadata: {custom_field: 'value', transfer_reason: 'settlement'}
  })
};

fetch('https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers', 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/banking/internal-transfers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'request_id' => 'req_123456789',
    'origin_bank_account_id' => '123e4567-e89b-12d3-a456-426614174000',
    'destination_bank_account_id' => '123e4567-e89b-12d3-a456-426614174001',
    'amount' => 10000,
    'metadata' => [
        'custom_field' => 'value',
        'transfer_reason' => 'settlement'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers"

	payload := strings.NewReader("{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"request_id\": \"req_123456789\",\n  \"origin_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"destination_bank_account_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"amount\": 10000,\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"transfer_reason\": \"settlement\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
  "amount": 10000,
  "status": "PENDING",
  "provider_transfer_id": "provider_tx_123456",
  "error_message": "Insufficient funds",
  "created_at": "2023-01-01T00:00:00.000Z",
  "updated_at": "2023-01-01T00:00:00.000Z",
  "metadata": {
    "custom_field": "value",
    "transfer_reason": "settlement"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation error",
    "status": 400,
    "details": {
      "issues": [
        {
          "field": "email",
          "type": "REQUIRED",
          "message": "Field 'email' is required",
          "value": "invalid_value",
          "constraints": {
            "min": 18,
            "max": 120
          }
        }
      ]
    },
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}

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

x-api-key

string

header

required

Company API key for authentication

Body

application/json

Schema for creating a new internal transfer

request_id

string

required

Client-generated request ID

Example:

"req_123456789"

origin_bank_account_id

string<uuid>

required

ID of the bank account to debit from

Example:

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

destination_bank_account_id

string<uuid>

required

ID of the bank account to credit to

Example:

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

amount

integer

required

Amount to transfer in cents

Required range: x >= 1

Example:

10000

metadata

object

Optional metadata object for storing custom key-value pairs

Example:

{
  "custom_field": "value",
  "transfer_reason": "settlement"
}

Response

Internal transfer created successfully

Internal transfer response

string<uuid>

required

Internal transfer 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"

destination_bank_account_id

string<uuid>

required

ID of the bank account to credit to

Example:

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

amount

integer

required

Amount to transfer in cents

Example:

10000

status

enum<string>

required

Transfer status

Available options:

PENDING,

PROCESSING,

COMPLETED,

FAILED

Example:

"PENDING"

provider_transfer_id

string | null

required

Provider-specific transfer ID

Example:

"provider_tx_123456"

error_message

string | null

required

Error message if transfer failed

Example:

"Insufficient funds"

created_at

string<date-time>

required

Creation timestamp

Example:

"2023-01-01T00:00:00.000Z"

updated_at

string<date-time>

required

Last update timestamp

Example:

"2023-01-01T00:00:00.000Z"

metadata

object | null

Metadata object for storing custom key-value pairs

Example:

{
  "custom_field": "value",
  "transfer_reason": "settlement"
}

Delete a PIX key for a specific merchant List internal transfers for authenticated company

⌘I

Introduction

Merchants

Pricing

Webhooks

Organization Management

User Management

System

Create a new internal transfer request

Authorizations

Body

Response