Buscar transação por ID

GEThttps://api.monkeypay.app/api/v2/resource/transactions/id/{transactionId}Bearer

Fluxo

Antes de chamar

Chamada
POSTEmitir token bearer
/resource/auth/token
Authorization: Bearer <seu-token>
Você
Tenha o transactionId
Veio na resposta 202 ou no webhook

Esta chamada

GETConsultar por ID

/resource/transactions/id/{transactionId}

Respostas possíveis

200Transação com pix e ledger
Leia data.status
400Identificador fora do formato
Corrija o campo indicado em errors[]; repetir igual falha de novo
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
404Inexistente ou de outra organização
Confira o identificador

Autorização

BearerRequer autenticação Bearer

Parâmetros

transactionIdstringcaminhoobrigatório

Respostas

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

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

methodstringopcional

pix

amountnumberopcional

Valor em reais.

10.5

feeAmountnumberopcional

Tarifa cobrada, em reais.

currencystringopcional

BRL

walletIdstringopcional

organizationIdstringopcional

accountIdstringopcional

errorMessagestringopcional

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

settlementAgentCodestringopcional

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

customerIdstringopcional

Presente quando informado na criação.

servicestringopcional

Presente quando registrado.

createdAtstring (date-time)opcional

pixobjectopcional

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

<pix>

transactionIdstring (uuid)opcional

statusstringopcional

valores: createdpendingprocessingawaiting_paymentcompletedfailedcancelledrefundedpartially_refundedexpiredinfraction

errorMessagestringopcional

pixKeystringopcional

qrCodestringopcional

endToEndstringopcional

senderobjectopcional

receiverobjectopcional

createdAtstring (date-time)opcional

updatedAtstring (date-time)opcional

ledgerobjectopcional

Lançamento principal no ledger da carteira.

idstringopcional

<id>

directionstringopcional

typestringopcional

<type>

amountnumberopcional

assetCodestringopcional

BRL

accountIdstringopcional

walletIdstringopcional

createdAtstring (date-time)opcional

balanceBeforenumberopcional

balanceAfternumberopcional

paginationobjectopcional

Credenciais

Requisição

1curl --request GET \

2 --url 'https://api.monkeypay.app/api/v2/resource/transactions/id/{transactionId}' \

3 --header 'Content-Type: application/json' \

4 --header 'Authorization: Bearer <seu-token>'

Resposta

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}