ABabacatepay

Listar PIX

Changed on

Consulta um envio de PIX pelo id. Apesar do nome, esta rota não pagina nem aceita filtros: id é obrigatório e o contrato é o mesmo de /pix/get.

get/pix/list

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/pix/list
  • Auth
    HTTP bearer

Query parameters

idstring required
Example:pix_out_abc123xyz

Identificador único do PIX enviado

externalIdstring
Example:pix-123

Identificador do PIX no seu sistema

Response

Lista de PIX retornada com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "tran_abc123xyz",
      "status": "COMPLETE",
      "receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
      "amount": 10000,
      "platformFee": 80,
      "externalId": "pix-123",
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}

Changes

  • 0ac54d6c2796Revision changes
    • warning

      added the new FAILED enum value to the // response property for the response status

    • info

      removed the CANCELLED enum value from the // response property for the response status

    • info

      removed the EXPIRED enum value from the // response property for the response status

    • info

      removed the PENDING enum value from the // response property for the response status

    • info

      removed the REFUNDED enum value from the // response property for the response status

  • ea8a72b04f2aRevision changes
    • breaking

      the query request parameter id became required

    • warning

      deleted the query request parameter after

    • warning

      deleted the query request parameter before

    • warning

      deleted the query request parameter endDate

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter startDate

    • warning

      deleted the query request parameter status