Consultar saldo - TroqPay API

{ "livemode": false, "currency": "BRL", "grossAmount": "5430.00", "feeAmount": "108.60", "pendingAmount": "129.90", "availableAmount": "5191.50", "reservedAmount": "0.00", "blockedAmount": "0.00" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Request-Id

string

Identificador opcional fornecido pelo cliente para correlação. A API aceita também X-Request-Id. O valor é ecoado de volta no header de resposta Request-Id. Se nenhum dos dois é enviado, a API gera req_<24 hex>.

Example:

"req_4a8b3c1d5e6f2a9b0c1d2e3f"

Response

Saldo retornado.

Saldo agregado da conta. Todos os valores monetários são strings decimais em BRL.

livemode

boolean

required

true para chaves trq_live_; false para trq_test_.

Example:

false

currency

enum<string>

required

Available options:

BRL

Example:

"BRL"

grossAmount

string

required

Total bruto recebido (antes das taxas).

Example:

"5430.00"

feeAmount

string

required

Total de taxas cobradas pela TroqPay.

Example:

"108.60"

pendingAmount

string

required

Valores ainda em liquidação.

Example:

"129.90"

availableAmount

string

required

Disponível para saque agora.

Example:

"5191.50"

reservedAmount

string

required

Reservado para saques já solicitados.

Example:

"0.00"

blockedAmount

string

required

Retido por bloqueio operacional ou disputa.

Example:

"0.00"