Carteiras

Buscar wallet por id

Detalhe da carteira. accPixIn e accPixOut são as contas usadas no recebimento e no envio; accPixOut é o accountId exigido pela consulta ao DICT.

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

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 carteira

/resource/wallets/{walletId}

Respostas possíveis

Depois do sucesso

  1. Chamada

    POSTConsultar chave no DICT

    /payment/pix/dict

    accountId = accPixOut

Autorização

BearerRequer autenticação Bearer

Parâmetros

walletIdstringcaminhoobrigatório
Tamanho1 ≤ tamanho
<walletId>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "identification": "<identification>",
7 "status": "active",
8 "organizationId": "<organization-id>",
9 "organization": {
10 "id": "<id>",
11 "name": "<name>",
12 "document": "<document>",
13 "status": "<status>"
14 },
15 "accPixIn": "<acc-pix-in>",
16 "accPixOut": "<acc-pix-out>",
17 "accountIn": {
18 "id": "<id>",
19 "name": "<name>",
20 "bankName": "<bank-name>",
21 "agency": "<agency>",
22 "accountNumber": "<account-number>"
23 },
24 "accountOut": {
25 "id": "<id>",
26 "name": "<name>",
27 "bankName": "<bank-name>",
28 "agency": "<agency>",
29 "accountNumber": "<account-number>"
30 },
31 "pixKeyId": "<pix-key-id>",
32 "pixKey": {
33 "id": "<id>",
34 "key": "<key>",
35 "type": "<type>"
36 },
37 "fees": {
38 "pixIn": 1,
39 "pixOut": 1,
40 "card": 1,
41 "pixInPercentage": 1,
42 "pixOutPercentage": 1,
43 "cardPercentage": 1
44 },
45 "balance": {
46 "available": 1,
47 "onHold": 1,
48 "blocked": 1,
49 "assetCode": "BRL"
50 },
51 "ledgerBalance": 1,
52 "feesCharged": {
53 "count": 1,
54 "total": 1
55 },
56 "pixOut": {
57 "blocked": true,
58 "reason": "<reason>",
59 "blockedUntil": "<blocked-until>",
60 "retryAfterSeconds": 1
61 },
62 "transactions": {
63 "total": {
64 "count": 1,
65 "amount": 1,
66 "feesEarnedAmount": 1
67 },
68 "in": {
69 "count": 1,
70 "amount": 1
71 },
72 "out": {
73 "count": 1,
74 "amount": 1
75 },
76 "byStatus": {}
77 },
78 "createdAt": "<created-at>",
79 "updatedAt": "<updated-at>"
80 }
81}

Campos da resposta

errorbooleanopcional
<error>
messagestringopcional
<message>
dataobjectopcional
<data>
idstringopcional
<id>
identificationstringopcional
<identification>
statusstringopcional

valores: activeinactivesuspendedblocked

<status>
organizationIdstringopcional
<organizationId>
organizationobjectopcional
<organization>
idstringopcional
<id>
namestringopcional
<name>
documentstringopcional
<document>
statusstringopcional
<status>
accPixInstringopcional
<accPixIn>
accPixOutstringopcional
<accPixOut>
accountInobjectopcional
<accountIn>
idstringopcional
<id>
namestringopcional
<name>
bankNamestringopcional
<bankName>
agencystringopcional
<agency>
accountNumberstringopcional
<accountNumber>
accountOutobjectopcional
<accountOut>
idstringopcional
<id>
namestringopcional
<name>
bankNamestringopcional
<bankName>
agencystringopcional
<agency>
accountNumberstringopcional
<accountNumber>
pixKeyIdstringopcional
<pixKeyId>
pixKeyobjectopcional
<pixKey>
idstringopcional
<id>
keystringopcional
<key>
typestringopcional
<type>
feesobjectopcional
<fees>
pixInnumberopcional
<pixIn>
pixOutnumberopcional
<pixOut>
cardnumberopcional
<card>
pixInPercentagenumberopcional
<pixInPercentage>
pixOutPercentagenumberopcional
<pixOutPercentage>
cardPercentagenumberopcional
<cardPercentage>
balanceobjectopcional

Saldo em BRL, em reais; zerado quando a carteira ainda não tem saldo.

<balance>
availablenumberopcional
<available>
onHoldnumberopcional
<onHold>
blockednumberopcional
<blocked>
assetCodestringopcional
BRL
ledgerBalancenumberopcional

Saldo líquido do ledger da carteira, em reais.

<ledgerBalance>
feesChargedobjectopcional

Tarifas da plataforma lançadas no ledger da carteira.

<feesCharged>
countintegeropcional
<count>
totalnumberopcional
<total>
pixOutobjectopcional

Bloqueio de Pix Out. `blocked` indica que alguma chave favorecida desta carteira está travada; os demais campos são do bloqueio que vence por último.

<pixOut>
blockedbooleanopcional
<blocked>
reasonstringopcional
<reason>
blockedUntilstring (date-time)opcional
<blockedUntil>
retryAfterSecondsintegeropcional
<retryAfterSeconds>
transactionsobjectopcional
<transactions>
totalobjectopcional
<total>
inobjectopcional
<in>
outobjectopcional
<out>
byStatusobjectopcional
<byStatus>
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
Credenciais

Requisição

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

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "identification": "<identification>",
7 "status": "active",
8 "organizationId": "<organization-id>",
9 "organization": {
10 "id": "<id>",
11 "name": "<name>",
12 "document": "<document>",
13 "status": "<status>"
14 },
15 "accPixIn": "<acc-pix-in>",
16 "accPixOut": "<acc-pix-out>",
17 "accountIn": {
18 "id": "<id>",
19 "name": "<name>",
20 "bankName": "<bank-name>",
21 "agency": "<agency>",
22 "accountNumber": "<account-number>"
23 },
24 "accountOut": {
25 "id": "<id>",
26 "name": "<name>",
27 "bankName": "<bank-name>",
28 "agency": "<agency>",
29 "accountNumber": "<account-number>"
30 },
31 "pixKeyId": "<pix-key-id>",
32 "pixKey": {
33 "id": "<id>",
34 "key": "<key>",
35 "type": "<type>"
36 },
37 "fees": {
38 "pixIn": 1,
39 "pixOut": 1,
40 "card": 1,
41 "pixInPercentage": 1,
42 "pixOutPercentage": 1,
43 "cardPercentage": 1
44 },
45 "balance": {
46 "available": 1,
47 "onHold": 1,
48 "blocked": 1,
49 "assetCode": "BRL"
50 },
51 "ledgerBalance": 1,
52 "feesCharged": {
53 "count": 1,
54 "total": 1
55 },
56 "pixOut": {
57 "blocked": true,
58 "reason": "<reason>",
59 "blockedUntil": "<blocked-until>",
60 "retryAfterSeconds": 1
61 },
62 "transactions": {
63 "total": {
64 "count": 1,
65 "amount": 1,
66 "feesEarnedAmount": 1
67 },
68 "in": {
69 "count": 1,
70 "amount": 1
71 },
72 "out": {
73 "count": 1,
74 "amount": 1
75 },
76 "byStatus": {}
77 },
78 "createdAt": "<created-at>",
79 "updatedAt": "<updated-at>"
80 }
81}