Skip to main content
POST
/
v1
/
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"
  }
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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

​
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

Optional metadata object for storing custom key-value pairs

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