Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
/
statement
Get banking statement for a specific merchant
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/statement \
  --header 'x-api-key: <api-key>'
{
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "CELCOIN",
  "items": [
    {
      "movement_id": "123e4567-e89b-12d3-a456-426614174000",
      "occurred_at": "2025-01-01T10:00:00.000Z",
      "amount": 10000,
      "type": "CREDIT",
      "movement_type": "PIXPAYMENTIN",
      "status_description": "Processed successfully",
      "balance_before": 95000,
      "balance_after": 105000,
      "name_credit": "John Doe",
      "name_debit": "Jane Smith"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total": 150,
  "total_pages": 3,
  "currency": "BRL"
}

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

Query Parameters

​
provider
enum<string>

Banking provider name (accepts lowercase and uppercase, returns uppercase, defaults to CELCOIN)

Available options:
CELCOIN,
RINNE,
CAPPTA
​
date_from
string<date-time>
required

Start datetime (ISO 8601) inclusive

​
date_to
string<date-time>
required

End datetime (ISO 8601) inclusive

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:50

Page size (max 50)

Required range: 1 <= x <= 50
​
order
enum<string>
default:DESC

Sort order by occurrence date

Available options:
ASC,
DESC

Response

Statement retrieved successfully

Banking statement response

​
company_id
string<uuid>
required

Company ID

Example:

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

​
provider
enum<string>
required

Banking provider name

Available options:
CELCOIN,
RINNE,
CAPPTA
Example:

"CELCOIN"

​
items
object[]
required

Statement items

​
page
integer
required

Current page number

Example:

1

​
page_size
integer
required

Page size

Example:

50

​
total
integer
required

Total number of items

Example:

150

​
total_pages
integer
required

Total number of pages

Example:

3

​
currency
enum<string>
required

Currency code

Available options:
BRL
Example:

"BRL"