Transações

Listar transações

Lista as transações da organização do token, da mais recente para a mais antiga. Valores em reais. Filtros de lista (status, type) aceitam o parâmetro repetido: ?status=completed&status=failed.

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

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Você

    Monte os filtros

    walletId, status, type, valores e período

Esta chamada

GETListar transações

/resource/transactions

Respostas possíveis

Depois do sucesso

  1. Você

    Concilie com o seu sistema

    Pelo externalId de cada transação

  2. Chamada

    GETConsultar por ID

    /resource/transactions/id/{transactionId}

    Detalhe de uma transação

BearerRequer autenticação Bearer
pageintegerqueryopcional
Intervalo1 ≤ valor
1
limitintegerqueryopcional
Intervalo1 ≤ valor ≤ 100
20
idstringqueryopcional
<id>
externalIdstringqueryopcional
<externalId>
endToEndstringqueryopcional
<endToEnd>
pixKeystringqueryopcional
<pixKey>
walletIdstringqueryopcional
<walletId>
customerIdstringqueryopcional
<customerId>
organizationIdstringqueryopcional
<organizationId>
statusarrayqueryopcional
<status>
typearrayqueryopcional
<type>
minAmountnumberqueryopcional
<minAmount>
maxAmountnumberqueryopcional
<maxAmount>
x-timezonestringcabeçalhoopcional

Fuso usado para interpretar os filtros de data. `startDate=2026-08-07` vira 00:00:00.000 e `endDate=2026-08-07` vira 23:59:59.999 **nesse fuso**. Datas enviadas com `Z` ou offset explícito ignoram o header. Ausente, assume `America/Sao_Paulo`. Aceita também `x-time-zone`.

valores: America/Sao_PauloAmerica/ManausAmerica/CuiabaAmerica/Porto_VelhoAmerica/Boa_VistaAmerica/Rio_BrancoAmerica/FortalezaAmerica/RecifeAmerica/BahiaAmerica/BelemAmerica/MaceioAmerica/NoronhaAmerica/New_YorkAmerica/ChicagoAmerica/DenverAmerica/Los_AngelesAmerica/PhoenixAmerica/AnchoragePacific/HonoluluAsia/ShanghaiUTC

America/Sao_Paulo
startDatestringqueryopcional
<startDate>
endDatestringqueryopcional
<endDate>
1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "id": "<id>",
7 "date": "<date>",
8 "type": "pix_in",
9 "status": "created",
10 "externalId": "<external-id>",
11 "endToEnd": "<end-to-end>",
12 "amount": 10.5,
13 "feeAmount": 1,
14 "balanceBefore": 1,
15 "balanceAfter": 1,
16 "walletId": "<wallet-id>",
17 "organizationId": "<organization-id>",
18 "organization": {
19 "id": "<id>",
20 "legalName": "<legal-name>",
21 "parentOrganizationId": "<parent-organization-id>"
22 },
23 "payer": {
24 "name": "<name>",
25 "document": "<document>",
26 "bankIspb": "<bank-ispb>",
27 "bankName": "<bank-name>"
28 },
29 "receiver": {
30 "name": "<name>",
31 "document": "<document>",
32 "bankIspb": "<bank-ispb>",
33 "bankName": "<bank-name>"
34 },
35 "ledger": {
36 "id": "<id>",
37 "direction": "<direction>",
38 "type": "<type>",
39 "amount": 1,
40 "assetCode": "BRL",
41 "accountId": "<account-id>",
42 "walletId": "<wallet-id>",
43 "createdAt": "<created-at>",
44 "balanceBefore": 1,
45 "balanceAfter": 1
46 }
47 }
48 ],
49 "pagination": {
50 "page": 1,
51 "limit": 20,
52 "total": 57,
53 "totalPages": 3
54 }
55}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
<message>
dataarrayopcional
<data>
idstring (uuid)opcional
<id>
datestring (date-time)opcional

Data de criação da transação.

<date>
typestringopcional

valores: pix_inpix_outrefund

<type>
statusstringopcional

`awaiting_payment` (QR gerado, aguardando pagamento) e `processing` (envio aceito) são estados intermediários. Só trate como final `completed`, `failed`, `cancelled`, `expired`, `refunded` e `partially_refunded`.

valores: createdpendingprocessingawaiting_paymentcompletedfailedcancelledrefundedpartially_refundedexpiredinfraction

<status>
externalIdstringopcional
<externalId>
endToEndstringopcional
<endToEnd>
amountnumberopcional

Valor em reais.

10.5
feeAmountnumberopcional

Tarifa cobrada, em reais.

<feeAmount>
balanceBeforenumberopcional
<balanceBefore>
balanceAfternumberopcional
<balanceAfter>
walletIdstringopcional

Carteira que registra a transação.

<walletId>
organizationIdstringopcional

Organização que registra a transação.

<organizationId>
organizationobjectopcional

Organização que registra a transação. Não traz dados da organização-pai, que pode estar fora do escopo do token.

<organization>
idstring (uuid)opcional
<id>
legalNamestringopcional
<legalName>
parentOrganizationIdstring (uuid)opcional

Preenchido quando a organização é subempresa.

<parentOrganizationId>
payerobjectopcional
<payer>
namestringopcional
<name>
documentstringopcional
<document>
bankIspbstringopcional
<bankIspb>
bankNamestringopcional
<bankName>
receiverobjectopcional
<receiver>
namestringopcional
<name>
documentstringopcional
<document>
bankIspbstringopcional
<bankIspb>
bankNamestringopcional
<bankName>
ledgerobjectopcional

Lançamento principal no ledger da carteira.

<ledger>
idstringopcional
<id>
directionstringopcional
<direction>
typestringopcional
<type>
amountnumberopcional
<amount>
assetCodestringopcional
BRL
accountIdstringopcional
<accountId>
walletIdstringopcional
<walletId>
createdAtstring (date-time)opcional
<createdAt>
balanceBeforenumberopcional
<balanceBefore>
balanceAfternumberopcional
<balanceAfter>
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/transactions?page=1&limit=20' \
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 "date": "<date>",
8 "type": "pix_in",
9 "status": "created",
10 "externalId": "<external-id>",
11 "endToEnd": "<end-to-end>",
12 "amount": 10.5,
13 "feeAmount": 1,
14 "balanceBefore": 1,
15 "balanceAfter": 1,
16 "walletId": "<wallet-id>",
17 "organizationId": "<organization-id>",
18 "organization": {
19 "id": "<id>",
20 "legalName": "<legal-name>",
21 "parentOrganizationId": "<parent-organization-id>"
22 },
23 "payer": {
24 "name": "<name>",
25 "document": "<document>",
26 "bankIspb": "<bank-ispb>",
27 "bankName": "<bank-name>"
28 },
29 "receiver": {
30 "name": "<name>",
31 "document": "<document>",
32 "bankIspb": "<bank-ispb>",
33 "bankName": "<bank-name>"
34 },
35 "ledger": {
36 "id": "<id>",
37 "direction": "<direction>",
38 "type": "<type>",
39 "amount": 1,
40 "assetCode": "BRL",
41 "accountId": "<account-id>",
42 "walletId": "<wallet-id>",
43 "createdAt": "<created-at>",
44 "balanceBefore": 1,
45 "balanceAfter": 1
46 }
47 }
48 ],
49 "pagination": {
50 "page": 1,
51 "limit": 20,
52 "total": 57,
53 "totalPages": 3
54 }
55}