Skip to main content
GET
Retrieve a cashback balance

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request except GET /v2/legal-entities, which lists the ids a user API key can send here: those of every legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

accountId
string
required

Account id with the sa_group_ prefix.

Response

The account's cashback balance.

Cashback earned on one account's card spend.

accountId
string
required

Account id with the sa_group_ prefix.

Example:

"sa_group_2rj4l7hmrrrcv"

available
Money · object
required

Ready to redeem.

pending
Money · object
required

Earned, but not available yet.

pendingReleases
object[]
required

When pending cashback becomes available, earliest first.

redeemable
boolean
required

false while the account is past due.

Example:

true