Skip to main content
GET
Saldo do afiliado: pendente, aprovado não pago, estornos e projeção do próximo payout

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

affiliateId
string
required
Pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

Default Response

affiliateId
string
required

Identificador do afiliado a que o saldo se refere.

Example:

"aff_01J9Z3K8QXY4M2N6P7R0S1T2V3"

currency
string
required

Moeda dos valores do saldo (ISO 4217).

Example:

"BRL"

pendingCents
integer
required

Total de comissões pendentes (ainda em hold), em centavos.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

12500

approvedCents
integer
required

Total de comissões aprovadas e elegíveis a payout, em centavos.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

8900

underReviewCents
integer
required

Total de comissões retidas em revisão, em centavos.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

0

clawbackCents
integer
required

Total de estornos (clawback) acumulados, em centavos (valor negativo abate o saldo).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

-298

nextPayoutProjectionCents
integer
required

Projeção do valor líquido do próximo payout, em centavos (aprovado menos clawbacks).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

8602