Skip to main content
GET
/
v1
/
banking
/
internal-transfers
/
{id}
Get a specific internal transfer by ID
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers/{id} \
  --header 'x-api-key: <api-key>'
import requests

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

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/banking/internal-transfers/{id}', 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/{id}",
  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/banking/internal-transfers/{id}"

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

}
HttpResponse<String> response = Unirest.get("https://api-sandbox.rinne.com.br/core/v1/banking/internal-transfers/{id}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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

id
string
required

Internal transfer ID

Response

Internal transfer retrieved successfully

Internal transfer response

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