Dashboard

Use this endpoint to get the dashboard indicators.

Available Environments

Production

https://api.gateway.com.br/core

Endpoint

• Method: GET
• Endpoint: /dashboard/user
• Authentication: Bearer token

Query Params

ℹ️ Dates in ISO

The startDate and endDate fields must be sent as an ISO date string with time.

Example:

• 2026-03-06T12:00:00.000Z

Name	Type	Required	Description	Validations
startDate	string	No	Start date of the filter	Must be an ISO date string with time
endDate	string	No	End date of the filter	Must be an ISO date string with time
timezone	string	No	Time zone used in the filter	Must be a valid timezone

Request Example

cURL

curl --request GET \
--url https://api.gateway.com.br/core/dashboard/user?startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z&timezone=America%2FSao_Paulo \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z',
  timezone: 'America/Sao_Paulo'
});

const response = await fetch(`https://api.gateway.com.br/core/dashboard/user?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

Success Response

ℹ️ It varies by account type

The response depends on the user's AccountTypeEnum, taken from the token.

• SELLER: Seller Account
• ACCOUNT_MANAGER: Account Manager Account
• GATEWAY: Gateway Account
• IGAMING: Transactional Account

⚠️ Important: Amounts in Cents

Every monetary amount is returned in cents. The balance is calculated with five decimal places, because of how fees are applied, so in cents it can come with a fraction: a balance of R$ 8,488.15900 returns 848815.9.

Seller Account

Field	Type	Required	Description
transactionValue	number	Yes	Total amount of transactions
balance	number	Yes	Available balance
reserve	number	Yes	Amount held in reserve
toReceive	number	Yes	Amount to receive
transactionVolume	number	Yes	Number of paid transactions
transactionCreatedVolume	number	Yes	Number of created transactions
middleTicketValue	number	Yes	Average ticket
refundedVolume	number	Yes	Number of refunded transactions
refundedPercentage	number	Yes	Refunded percentage
withdrawalRefundedValue	number	Yes	Total amount of refunded withdrawals
withdrawalRefundedVolume	number	Yes	Total number of refunded withdrawals
withdrawalRefundedValueOnCreatedDate	number	Yes	Amount of withdrawals refunded on the creation date
withdrawalRefundedVolumeOnCreatedDate	number	Yes	Number of withdrawals refunded on the creation date
frozenValue	number	No	Frozen amount
pendingDebits	number	Yes	Pending debits
paymentMethods	object	Yes	Amounts by payment method (see Sub-Object PaymentMethods)
indexes	object	Yes	Indicators for the period (see Sub-Object Indexes)
orders	array	Yes	Totals by date (see Sub-Object TotalsByDate)

Account Manager Account

Field	Type	Required	Description
transactionValue	number	Yes	Total amount of transactions
balance	number	Yes	Available balance
reserve	number	Yes	Amount held in reserve
toReceive	number	Yes	Amount to receive
transactionVolume	number	Yes	Number of paid transactions
transactionCreatedVolume	number	Yes	Number of created transactions
middleTicketValue	number	Yes	Average ticket
refundedVolume	number	Yes	Number of refunded transactions
refundedPercentage	number	Yes	Refunded percentage
withdrawalRefundedValue	number	Yes	Total amount of refunded withdrawals
withdrawalRefundedVolume	number	Yes	Total number of refunded withdrawals
withdrawalRefundedValueOnCreatedDate	number	Yes	Amount of withdrawals refunded on the creation date
withdrawalRefundedVolumeOnCreatedDate	number	Yes	Number of withdrawals refunded on the creation date
frozenValue	number	No	Frozen amount
pendingDebits	number	Yes	Pending debits
paymentMethods	object	Yes	Amounts by payment method (see Sub-Object PaymentMethods)
indexes	object	Yes	Indicators for the period (see Sub-Object Indexes)
orders	array	Yes	Totals by date (see Sub-Object TotalsByDate)

Gateway Account

Field	Type	Required	Description
transactionValue	number	Yes	Total amount of transactions
balance	number	Yes	Available balance
reserve	number	Yes	Amount held in reserve
transactionVolume	number	Yes	Number of paid transactions
transactionCreatedVolume	number	Yes	Number of created transactions
middleTicketValue	number	Yes	Average ticket
withdrawalRefundedValue	number	Yes	Total amount of refunded withdrawals
withdrawalRefundedVolume	number	Yes	Total number of refunded withdrawals
withdrawalRefundedValueOnCreatedDate	number	Yes	Amount of withdrawals refunded on the creation date
withdrawalRefundedVolumeOnCreatedDate	number	Yes	Number of withdrawals refunded on the creation date
pendingDebits	number	Yes	Pending debits
frozenValue	number	No	Frozen amount
orders	array	Yes	Totals by date (see Sub-Object TotalsByDate)

Transactional Account

Field	Type	Required	Description
revenue	array	Yes	Revenue by date (see Sub-Object TotalsByDate)
expense	array	Yes	Expenses by date (see Sub-Object TotalsByDate)
transactionVolume	number	Yes	Number of paid transactions
transactionCreatedVolume	number	Yes	Number of created transactions
middleTicketValue	number	Yes	Average ticket
deposit	number	Yes	Total amount of deposits
withdrawals	number	Yes	Total amount of withdrawals
balance	number	Yes	Available balance
averageDeposit	number	Yes	Average deposit
withdrawalRefundedValue	number	Yes	Total amount of refunded withdrawals
withdrawalRefundedVolume	number	Yes	Total number of refunded withdrawals
withdrawalRefundedValueOnCreatedDate	number	Yes	Amount of withdrawals refunded on the creation date
withdrawalRefundedVolumeOnCreatedDate	number	Yes	Number of withdrawals refunded on the creation date
frozenValue	number	Yes	Frozen amount
pendingDebits	number	Yes	Pending debits

Sub-Objects

PaymentMethods

Field	Type	Required	Description
pixPaidValue	number	Yes	Amount paid through PIX
pixGeneratedValue	number	Yes	Amount generated through PIX
pixPercentage	number	Yes	Percentage through PIX
cardsPaidValue	number	Yes	Amount paid through cards
cardsGeneratedValue	number	Yes	Amount generated through cards
cardsPercentage	number	Yes	Percentage through cards
billetPaidValue	number	Yes	Amount paid through bank slips
billetGeneratedValue	number	Yes	Amount generated through bank slips
billetPercentage	number	Yes	Percentage through bank slips

Indexes

Field	Type	Required	Description
pixConversion	number	Yes	PIX conversion
billetConversion	number	Yes	Bank slip conversion
creditCardConversion	number	Yes	Credit card conversion
preChargebackVolume	number	Yes	Number of pre-chargebacks
preChargebackPercentage	number	Yes	Pre-chargeback percentage
chargebackVolume	number	Yes	Number of chargebacks
chargebackPercentage	number	Yes	Chargeback percentage
creditCardsRefusedVolume	number	Yes	Number of refused cards
creditCardsRefusedPercentage	number	Yes	Percentage of refused cards
medVolume	number	No	Number of MEDs
medPercentage	number	No	MED percentage

TotalsByDate

Field	Type	Required	Description
date	string (ISO)	Yes	Reference date
total	number	Yes	Total of the day

Response Example (Seller)

{
  "transactionValue": 150000,
  "balance": 50000,
  "reserve": 10000,
  "toReceive": 90000,
  "transactionVolume": 30,
  "transactionCreatedVolume": 40,
  "middleTicketValue": 5000,
  "refundedVolume": 1,
  "refundedPercentage": 3.3,
  "withdrawalRefundedValue": 1200,
  "withdrawalRefundedVolume": 3,
  "withdrawalRefundedValueOnCreatedDate": 800,
  "withdrawalRefundedVolumeOnCreatedDate": 2,
  "frozenValue": 2000,
  "pendingDebits": 1000,
  "paymentMethods": {
    "pixPaidValue": 60000,
    "pixGeneratedValue": 65000,
    "pixPercentage": 40,
    "cardsPaidValue": 70000,
    "cardsGeneratedValue": 75000,
    "cardsPercentage": 47,
    "billetPaidValue": 20000,
    "billetGeneratedValue": 25000,
    "billetPercentage": 13
  },
  "indexes": {
    "pixConversion": 92,
    "billetConversion": 65,
    "creditCardConversion": 78,
    "preChargebackVolume": 1200,
    "preChargebackPercentage": 0.8,
    "chargebackVolume": 500,
    "chargebackPercentage": 0.3,
    "creditCardsRefusedVolume": 3000,
    "creditCardsRefusedPercentage": 2.0,
    "medVolume": 200,
    "medPercentage": 0.1
  },
  "orders": [
    {
      "date": "2026-03-06",
      "total": 50000
    },
    {
      "date": "2026-03-07",
      "total": 100000
    }
  ]
}

Response Example (Gateway)

{
  "transactionValue": 120000,
  "balance": 40000,
  "reserve": 8000,
  "transactionVolume": 20,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 6000,
  "withdrawalRefundedValue": 900,
  "withdrawalRefundedVolume": 2,
  "withdrawalRefundedValueOnCreatedDate": 500,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "pendingDebits": 900,
  "frozenValue": 1500,
  "orders": [
    {
      "date": "2026-03-06",
      "total": 45000
    },
    {
      "date": "2026-03-07",
      "total": 75000
    }
  ]
}

Response Example (Transactional Account)

{
  "revenue": [
    {
      "date": "2026-03-06",
      "total": 90000
    },
    {
      "date": "2026-03-07",
      "total": 110000
    }
  ],
  "expense": [
    {
      "date": "2026-03-06",
      "total": 30000
    },
    {
      "date": "2026-03-07",
      "total": 35000
    }
  ],
  "transactionVolume": 18,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 8000,
  "deposit": 200000,
  "withdrawals": 80000,
  "balance": 120000,
  "averageDeposit": 10000,
  "withdrawalRefundedValue": 700,
  "withdrawalRefundedVolume": 1,
  "withdrawalRefundedValueOnCreatedDate": 700,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "frozenValue": 5000,
  "pendingDebits": 2500
}

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your credentials
403	No permission/authorization	Contact support
422	Invalid or missing data	Check the format of the data
422	Validations	Contact support
500	Internal error	Contact support