Carteiras

Consultar saldo da wallet

Devolve o saldo por ativo da carteira. available é o que pode ser enviado agora; onHold está reservado para operações em andamento e blocked, bloqueado. Valores em reais.

GEThttps://api.monkeypay.app/api/v2/resource/wallets/{walletId}/balanceBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    GETListar carteiras

    /resource/wallets

    walletId

Esta chamada

GETConsultar saldo

/resource/wallets/{walletId}/balance

Respostas possíveis

  • 200Saldo por ativo

    Use data.balances[].available, em reais

  • 401Token ausente ou expirado

    Emita outro token e repita uma única vez

  • 403Credencial sem a permissão exigida

    Não repita; leia o detail e peça o acesso

  • 404Carteira inexistente ou de outra organização

    Confira o identificador

Depois do sucesso

  1. Chamada

    POSTEnviar Pix

    /payment/pix/send

    Se available cobrir amount mais a tarifa

Autorização

BearerRequer autenticação Bearer

Parâmetros

walletIdstringcaminhoobrigatório
Tamanho1 ≤ tamanho
<walletId>
assetCodestringqueryopcional

Restringe a um ativo (ex. `BRL`). Sem ele, vêm todos os ativos da carteira.

Tamanho1 ≤ tamanho
<assetCode>

Respostas

1{
2 "error": false,
3 "message": "Wallet balance fetched successfully",
4 "data": {
5 "walletId": "<wallet-id>",
6 "balances": [
7 {
8 "id": "<id>",
9 "assetCode": "BRL",
10 "available": 1520.75,
11 "onHold": 10.5,
12 "blocked": 0,
13 "total": 1531.25
14 }
15 ]
16 },
17 "pagination": null
18}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
Wallet balance fetched successfully
dataobjectopcional
<data>
walletIdstringopcional
<walletId>
balancesarrayopcional
<balances>
idstringopcional
<id>
assetCodestringopcional
BRL
availablenumberopcional

Disponível para envio, em reais.

1520.75
onHoldnumberopcional

Reservado para operações em andamento.

10.5
blockednumberopcional
0
totalnumberopcional
1531.25
paginationobjectopcional
<pagination>
Credenciais

Requisição

1curl --request GET \
2 --url 'https://api.monkeypay.app/api/v2/resource/wallets/{walletId}/balance' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": false,
3 "message": "Wallet balance fetched successfully",
4 "data": {
5 "walletId": "<wallet-id>",
6 "balances": [
7 {
8 "id": "<id>",
9 "assetCode": "BRL",
10 "available": 1520.75,
11 "onHold": 10.5,
12 "blocked": 0,
13 "total": 1531.25
14 }
15 ]
16 },
17 "pagination": null
18}