Carteiras

Listar wallets

Lista as carteiras da organização do token (e das suborganizações que ela enxerga). Use o id retornado como walletId nas operações Pix e o accPixOut como accountId na consulta ao DICT.

GEThttps://api.monkeypay.app/api/v2/resource/walletsBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

Esta chamada

GETListar carteiras

/resource/wallets

Respostas possíveis

  • 200Carteiras paginadas

    Guarde o id de cada carteira (walletId)

  • 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

Depois do sucesso

  1. Chamada

    GETConsultar carteira

    /resource/wallets/{walletId}

    Detalhes e conta de saída

  2. Chamada

    GETConsultar saldo

    /resource/wallets/{walletId}/balance

    Saldo disponível

Autorização

BearerRequer autenticação Bearer

Parâmetros

pageintegerqueryopcional
Intervalo1 ≤ valor
1
limitintegerqueryopcional
Intervalo1 ≤ valor ≤ 100
10
searchstringqueryopcional
organizationIdstringqueryopcional

Filtra por uma organização dentro do escopo do token.

<organizationId>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "id": "<id>",
7 "organizationId": "<organization-id>",
8 "identification": "<identification>",
9 "status": "active",
10 "accPixIn": "<acc-pix-in>",
11 "accPixOut": "<acc-pix-out>",
12 "pixKeyId": "<pix-key-id>",
13 "organization": {
14 "id": "<id>",
15 "legalName": "<legal-name>"
16 },
17 "balance": {
18 "available": 1520.75,
19 "onHold": 10.5,
20 "blocked": 0,
21 "assetCode": "BRL"
22 },
23 "createdAt": "<created-at>",
24 "updatedAt": "<updated-at>"
25 }
26 ],
27 "pagination": {
28 "page": 1,
29 "limit": 20,
30 "total": 57,
31 "totalPages": 3
32 }
33}

Campos da resposta

errorbooleanopcional
<error>
messagestringopcional
<message>
dataarrayopcional
<data>
idstringopcional
<id>
organizationIdstringopcional
<organizationId>
identificationstringopcional
<identification>
statusstringopcional

valores: activeinactivesuspendedblocked

<status>
accPixInstringopcional

Conta de recebimento (Pix In).

<accPixIn>
accPixOutstringopcional

Conta de envio (Pix Out); é o `accountId` da consulta ao DICT.

<accPixOut>
pixKeyIdstringopcional
<pixKeyId>
organizationobjectopcional
<organization>
idstringopcional
<id>
legalNamestringopcional
<legalName>
balanceobjectopcional

Saldo em BRL, em reais. Na listagem vem `null` quando a carteira ainda não tem saldo em BRL.

<balance>
availablenumberopcional
1520.75
onHoldnumberopcional
10.5
blockednumberopcional
0
assetCodestringopcional
BRL
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
paginationobjectopcional
<pagination>
pageintegeropcional
1
limitintegeropcional
20
totalintegeropcional

Total de itens que atendem ao filtro.

57
totalPagesintegeropcional

Nunca é menor que 1, mesmo com a lista vazia.

3
Credenciais

Requisição

1curl --request GET \
2 --url 'https://api.monkeypay.app/api/v2/resource/wallets?page=1&limit=10' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "id": "<id>",
7 "organizationId": "<organization-id>",
8 "identification": "<identification>",
9 "status": "active",
10 "accPixIn": "<acc-pix-in>",
11 "accPixOut": "<acc-pix-out>",
12 "pixKeyId": "<pix-key-id>",
13 "organization": {
14 "id": "<id>",
15 "legalName": "<legal-name>"
16 },
17 "balance": {
18 "available": 1520.75,
19 "onHold": 10.5,
20 "blocked": 0,
21 "assetCode": "BRL"
22 },
23 "createdAt": "<created-at>",
24 "updatedAt": "<updated-at>"
25 }
26 ],
27 "pagination": {
28 "page": 1,
29 "limit": 20,
30 "total": 57,
31 "totalPages": 3
32 }
33}