CardsGet cashback balance

Get cashback balance

Returns the consolidated cashback balance for the authenticated company.

The companyId is obtained from the authenticated server context (req.user.companyId) and is not sent by the client.

curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/cashback" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "remainingAmount": 1280.55,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "expiresAt": "2025-01-31T00:00:00.000Z"
}
GET
/credit-cards/v1/cashback
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN

Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN

Responses

remainingAmountnumber
Required

Consolidated remaining cashback balance in BRL.

updatedAtstring
Required

Date of the most recent cashback movement (last withdrawal/deposit), in ISO 8601.

expiresAtstring
Required

Date of the nearest cashback expiration in ISO 8601. Returns null when nothing is expiring soon.