Skip to main content
POST
/
v1
/
merchants
/
{merchantId}
/
bank-accounts
Registers a new external bank account for a merchant
curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "branch_number": "0001",
  "account_number": "12345678",
  "account_type": "CHECKING",
  "account_holder_name": "John Doe Silva",
  "account_holder_document_number": "12345678901",
  "ispb": "12345678"
}
'
import requests

url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/bank-accounts"

payload = {
"branch_number": "0001",
"account_number": "12345678",
"account_type": "CHECKING",
"account_holder_name": "John Doe Silva",
"account_holder_document_number": "12345678901",
"ispb": "12345678"
}
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({
branch_number: '0001',
account_number: '12345678',
account_type: 'CHECKING',
account_holder_name: 'John Doe Silva',
account_holder_document_number: '12345678901',
ispb: '12345678'
})
};

fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/bank-accounts', 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/merchants/{merchantId}/bank-accounts",
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([
'branch_number' => '0001',
'account_number' => '12345678',
'account_type' => 'CHECKING',
'account_holder_name' => 'John Doe Silva',
'account_holder_document_number' => '12345678901',
'ispb' => '12345678'
]),
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/merchants/{merchantId}/bank-accounts"

payload := strings.NewReader("{\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_type\": \"CHECKING\",\n \"account_holder_name\": \"John Doe Silva\",\n \"account_holder_document_number\": \"12345678901\",\n \"ispb\": \"12345678\"\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/merchants/{merchantId}/bank-accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_type\": \"CHECKING\",\n \"account_holder_name\": \"John Doe Silva\",\n \"account_holder_document_number\": \"12345678901\",\n \"ispb\": \"12345678\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/bank-accounts")

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 \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_type\": \"CHECKING\",\n \"account_holder_name\": \"John Doe Silva\",\n \"account_holder_document_number\": \"12345678901\",\n \"ispb\": \"12345678\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "b941fcaf-d77e-448c-9bdd-e7effd269fb7",
  "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "account_holder_name": "John Doe Silva",
  "account_holder_document_number": "12345678901",
  "branch_number": "0001",
  "account_number": "12345678",
  "account_type": "CHECKING",
  "ispb": "12345678",
  "status": "ACTIVE",
  "deleted_at": null,
  "primary": false,
  "created_at": "2025-01-01T10:00:00.000Z",
  "updated_at": "2025-01-01T10:00:00.000Z"
}
{
"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": "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

merchantId
string
required

The merchant ID

Body

application/json

Schema for creating a new company bank account

branch_number
string
required

Branch number (digits only)

Pattern: ^\d+$
Example:

"0001"

account_number
string
required

Account number (digits only)

Pattern: ^\d+$
Example:

"12345678"

account_type
enum<string>
required

Account type

Available options:
CHECKING,
SAVINGS,
SALARY,
PAYMENT
Example:

"CHECKING"

account_holder_name
string
required

Account holder full name

Example:

"John Doe Silva"

account_holder_document_number
string
required

Account holder document number (CPF or CNPJ)

Example:

"12345678901"

ispb
string
required

ISPB (Brazilian Payment System Identifier)

Example:

"12345678"

Response

Bank account created successfully

Company bank account response

id
string<uuid>
required

Bank account ID

Example:

"b941fcaf-d77e-448c-9bdd-e7effd269fb7"

company_id
string<uuid>
required

Company ID

Example:

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

account_holder_name
string
required

Account holder full name

Example:

"John Doe Silva"

account_holder_document_number
string
required

Account holder document number

Example:

"12345678901"

branch_number
string
required

Branch number (digits only)

Pattern: ^\d+$
Example:

"0001"

account_number
string
required

Account number (digits only)

Pattern: ^\d+$
Example:

"12345678"

account_type
enum<string>
required

Account type

Available options:
CHECKING,
SAVINGS,
SALARY,
PAYMENT
Example:

"CHECKING"

ispb
string
required

ISPB (Brazilian Payment System Identifier)

Example:

"12345678"

status
enum<string>
required

Account status

Available options:
ACTIVE,
DELETED
Example:

"ACTIVE"

deleted_at
string<date-time> | null
required

Deletion timestamp (null if not deleted)

Example:

null

primary
boolean
required

Whether this is the primary bank account

Example:

false

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:00:00.000Z"