Consultando Pagamento PIX

Consultar pagamento PIX

Esse endpoint existe para buscar os dados de um pix.

HEADERS

authorization string Bearer Token

User-Agent string Nome da sua aplicacão GET

https://sandbox.codetech.one/v2/api/pix/list/confirmation/id/{id}

RESPONSE 200 OK
{
  "account_id": "a5997beb-44ef-438a-ab15-506eaa7fda7e",
  "amount": 28309,
  "approved_at": "2023-06-25T17:46:56Z",
  "approved_by": "user:8c8a97a5-18f3-46fe-94ae-6341d718da8f",
  "confirmed_at": "2023-06-25T17:46:56Z",
  "confirmed_by": "user:65b30ef8-fb55-4ebb-b48a-b01199792b08",
  "created_at": "2023-06-25T17:46:56Z",
  "created_by": "user:8c8a97a5-18f3-46fe-94ae-6341d718da8f",
  "description": "description",
  "end_to_end_id": "E165015552021062517465eeb40dd2f6",
  "failed_at": null,
  "failure_reason_code": null,
  "failure_reason_description": null,
  "fee": 0,
  "id": "e59c23d8-eb3a-4a67-8687-ebfe163211a8",
  "key": null,
  "money_reserved_at": "2023-06-25T17:46:56Z",
  "refunded_amount": 869707,
  "request_id": "aafa7eed-4349-46c2-91ae-7ab4337935cc",
  "settled_at": "2023-06-25T17:46:56Z",
  "source": {
    "account": {
      "account_code": "598461372",
      "account_type": "PG",
      "branch_code": "0001"
    },
    "entity": {"document": "92648457550", "document_type": "cpf", "name": "my name"}
  },
  "status": "SETTLED",
  "target": {
    "account": {
      "account_code": "816473259",
      "account_type": "PG",
      "branch_code": "0001"
    },
    "entity": {"document": "***257844**", "document_type": "cpf", "name": "my name"},
    "institution": {"ispb": "34697281", "name": "Banco Liquidante"}
  },
  "transaction_id": null
}

Os possíveis estados do pagamento retornado, que vem no campo status são:

  • CREATED: O pagamento está criado, mas não foi aprovado ainda.

  • CONFIRMED: O pagamento foi aprovado, mas o dinheiro ainda não saiu da conta.

  • FAILED: O pagamento falhou.

  • MONEY_RESERVED: O pagamento foi aprovado, o dinheiro saiu da conta mas ainda não foi concluído.

  • REFUNDED: O pagamento foi rejeitado pelo outro banco.

  • SETTLED: O pagamento foi concluído com sucesso.

Last updated