Transações

Buscar transação por ID externo

Consulta pelo externalId que você enviou ao criar a cobrança ou o pagamento. É a forma recomendada de conciliar e de verificar o resultado depois de um timeout.

GEThttps://api.monkeypay.app/api/v2/resource/transactions/external-id/{externalId}Bearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Você

    Tenha o seu externalId

    O mesmo enviado na cobrança ou no envio

Esta chamada

GETConsultar por ID externo

/resource/transactions/external-id/{externalId}

Respostas possíveis

Autorização

BearerRequer autenticação Bearer

Parâmetros

externalIdstringcaminhoobrigatório
Tamanho1 ≤ tamanho
<externalId>

Respostas

1{
2 "error": false,
3 "message": "Transaction fetched successfully",
4 "data": {
5 "id": "<id>",
6 "externalId": "<external-id>",
7 "type": "pix_in",
8 "status": "created",
9 "method": "pix",
10 "amount": 10.5,
11 "feeAmount": 1,
12 "currency": "BRL",
13 "walletId": "<wallet-id>",
14 "organizationId": "<organization-id>",
15 "accountId": "<account-id>",
16 "errorMessage": "<error-message>",
17 "settlementAgentCode": "<settlement-agent-code>",
18 "customerId": "<customer-id>",
19 "service": "<service>",
20 "createdAt": "<created-at>",
21 "pix": {
22 "transactionId": "<transaction-id>",
23 "status": "created",
24 "errorMessage": "<error-message>",
25 "pixKey": "<pix-key>",
26 "qrCode": "<qr-code>",
27 "endToEnd": "<end-to-end>",
28 "sender": {
29 "account": "<account>",
30 "agency": "<agency>",
31 "document": "<document>",
32 "name": "<name>",
33 "bankIspb": "<bank-ispb>",
34 "bankName": "<bank-name>"
35 },
36 "receiver": {
37 "account": "<account>",
38 "agency": "<agency>",
39 "document": "<document>",
40 "name": "<name>",
41 "bankIspb": "<bank-ispb>",
42 "bankName": "<bank-name>"
43 },
44 "createdAt": "<created-at>",
45 "updatedAt": "<updated-at>"
46 },
47 "ledger": {
48 "id": "<id>",
49 "direction": "<direction>",
50 "type": "<type>",
51 "amount": 1,
52 "assetCode": "BRL",
53 "accountId": "<account-id>",
54 "walletId": "<wallet-id>",
55 "createdAt": "<created-at>",
56 "balanceBefore": 1,
57 "balanceAfter": 1
58 }
59 },
60 "pagination": null
61}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
Transaction fetched successfully
dataobjectopcional
<data>
idstring (uuid)opcional
<id>
externalIdstringopcional
<externalId>
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>
methodstringopcional
pix
amountnumberopcional

Valor em reais.

10.5
feeAmountnumberopcional

Tarifa cobrada, em reais.

<feeAmount>
currencystringopcional
BRL
walletIdstringopcional
<walletId>
organizationIdstringopcional
<organizationId>
accountIdstringopcional
<accountId>
errorMessagestringopcional

Presente só quando a transação falhou com motivo registrado.

<errorMessage>
settlementAgentCodestringopcional

Código do liquidante; vazio quando não registrado.

<settlementAgentCode>
customerIdstringopcional

Presente quando informado na criação.

<customerId>
servicestringopcional

Presente quando registrado.

<service>
createdAtstring (date-time)opcional
<createdAt>
pixobjectopcional

Dados Pix da transação; objeto vazio quando não há registro Pix.

<pix>
transactionIdstring (uuid)opcional
<transactionId>
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>
errorMessagestringopcional
<errorMessage>
pixKeystringopcional
<pixKey>
qrCodestringopcional
<qrCode>
endToEndstringopcional
<endToEnd>
senderobjectopcional
<sender>
receiverobjectopcional
<receiver>
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
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>
Credenciais

Requisição

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

Resposta

1{
2 "error": false,
3 "message": "Transaction fetched successfully",
4 "data": {
5 "id": "<id>",
6 "externalId": "<external-id>",
7 "type": "pix_in",
8 "status": "created",
9 "method": "pix",
10 "amount": 10.5,
11 "feeAmount": 1,
12 "currency": "BRL",
13 "walletId": "<wallet-id>",
14 "organizationId": "<organization-id>",
15 "accountId": "<account-id>",
16 "errorMessage": "<error-message>",
17 "settlementAgentCode": "<settlement-agent-code>",
18 "customerId": "<customer-id>",
19 "service": "<service>",
20 "createdAt": "<created-at>",
21 "pix": {
22 "transactionId": "<transaction-id>",
23 "status": "created",
24 "errorMessage": "<error-message>",
25 "pixKey": "<pix-key>",
26 "qrCode": "<qr-code>",
27 "endToEnd": "<end-to-end>",
28 "sender": {
29 "account": "<account>",
30 "agency": "<agency>",
31 "document": "<document>",
32 "name": "<name>",
33 "bankIspb": "<bank-ispb>",
34 "bankName": "<bank-name>"
35 },
36 "receiver": {
37 "account": "<account>",
38 "agency": "<agency>",
39 "document": "<document>",
40 "name": "<name>",
41 "bankIspb": "<bank-ispb>",
42 "bankName": "<bank-name>"
43 },
44 "createdAt": "<created-at>",
45 "updatedAt": "<updated-at>"
46 },
47 "ledger": {
48 "id": "<id>",
49 "direction": "<direction>",
50 "type": "<type>",
51 "amount": 1,
52 "assetCode": "BRL",
53 "accountId": "<account-id>",
54 "walletId": "<wallet-id>",
55 "createdAt": "<created-at>",
56 "balanceBefore": 1,
57 "balanceAfter": 1
58 }
59 },
60 "pagination": null
61}