Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
/
bank-accounts
List all bank accounts for a merchant
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/bank-accounts \
  --header 'x-api-key: <api-key>'
[
  {
    "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"
  }
]

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

Path Parameters

​
merchantId
string
required

The merchant ID

Response

Bank accounts retrieved successfully

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