API Reference

Get Transaction

Endpoint para buscar detalhes de uma transação PIX pelo ID.

Retorno da requisição

{
  "message": "Transação encontrada com sucesso.",
  "status": 200,
  "data": {
    "transactionId": "29eef544-2764-4e7d-8bfe-6a3fcd12bf85",
    "value": 1.99,
    "description": "Transação realizada com sucesso.",
    "valueLiquid": 1.99,
    "endToEndId": "E31872495202402282310w42Nv7613X6",
    "txId": "hdGnDGyibehdGgioVSWf1jbN2spYnZ",
    "descriptionError": "Transação não encontrada.",
    "createdAt": "2020-10-30T00:00:00.000Z",
    "updatedAt": "2020-10-30T00:00:00.000Z",
    "completionDate": "2020-10-30T00:00:00.000Z",
    "costumer": {
      "fullName": "Fulano de Tal",
      "document": "12345678901"
    },
    "costumerPayed": {
      "fullName": "Fulano de Tal",
      "document": "12345678901"
    },
    "status": "PAGO",
    "currency": "BRL",
    "paymentMethod": "PIX",
    "pixCopyPaste": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/d7d150cf-c2d0-47b6-9a9d-e94440f3296c520400005303986540537.005802BR5921PAPELARIA LEITE CUNHA6008BRASILIA62070503***63046D5C",
    "tags": ["#TAG1","#TAG2"]
  }
}

Respostas esperadas

Status CodeDescrição
200 - OKRequisição bem sucedida.
400 - Bad RequestRequisição inválida. Geralmente acontece por envio de parâmetros inválidos ou falta de dados para a operação.
Language
Credentials
Click Try It! to start a request and see the response here!