Skip to main content
GET
/
api
/
v1
/
payments
curl -X GET 'https://app.plowf.com/api/v1/payments?status=PAID&per_page=20' \
  -H 'Authorization: Bearer seu_token_aqui'
{
  "data": [
    {
      "uuid": "770e8400-e29b-41d4-a716-446655440000",
      "value": 250,
      "total_value": 255,
      "fees": 5,
      "currency": "BRL",
      "status": "PAID",
      "type": "PIX",
      "payment": {
        "uuid": "880e8400-e29b-41d4-a716-446655440001",
        "value": "250.00",
        "type": "QR_DYNAMIC",
        "status": "COMPLETED",
        "payload": "00020101021226570014br.gov.bcb.pix2535qr.plowf.com/qr/v2/cob/770e8400-e29b-41d4-a71652040000530398654062500.005802BR5912Empresa_Demo6009Sao_Paulo62290525770e8400e29b41d4a716446663041A2B",
        "pix": {
          "sender": {
            "name": "João Silva",
            "document": "12345678901",
            "account_number": "00123456",
            "account_agency": "0001",
            "bank": {
              "code": "341",
              "name": "ITAÚ UNIBANCO S.A.",
              "ispb": "60701190"
            },
            "account_type": "CHECKING"
          },
          "receiver": {
            "name": "Empresa Demo LTDA",
            "document": "12345678000190",
            "account_number": "9876543",
            "account_agency": "0001",
            "bank": {
              "code": "",
              "name": "PLOWF IP LTDA.",
              "ispb": "00000000"
            },
            "account_type": "CHECKING"
          },
          "txid": "770e8400e29b41d4a716446655440000",
          "value": "250.00",
          "type": "QR_DYNAMIC",
          "pix_key": "1234567890",
          "transaction": {
            "uuid": "990e8400-e29b-41d4-a716-446655440002",
            "value": "250.00",
            "movement_type": "IN",
            "type": "EXTERNAL_TRANSFER",
            "status": "SETTLED",
            "end_to_end": "E6070119020240101100500000000001",
            "settled_at": "2024-01-01T10:05:00.000000Z",
            "created_at": "2024-01-01T10:02:00.000000Z",
            "updated_at": "2024-01-01T10:05:00.000000Z"
          },
          "status": "COMPLETED",
          "expires_at": "2024-03-01T10:00:00.000000Z",
          "created_at": "2024-01-01T10:00:00.000000Z",
          "updated_at": "2024-01-01T10:05:00.000000Z"
        },
        "verify_sender": false,
        "expires_at": "2024-03-01T10:00:00.000000Z",
        "created_at": "2024-01-01T10:00:00.000000Z",
        "updated_at": "2024-01-01T10:05:00.000000Z"
      },
      "external_ref": "PED-001",
      "final_beneficiary": {
        "name": "Maria Santos",
        "document": "98765432100"
      },
      "splits": [
        {
          "uuid": "990e8400-e29b-41d4-a716-446655440002",
          "type": "PERCENTAGE",
          "value": 10,
          "status": "CREDITED",
          "recipient_account": {
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "name": "Empresa Parceira LTDA"
          }
        }
      ],
      "history": [
        {
          "status": "PENDING",
          "created_at": "2024-01-01T10:00:00Z"
        },
        {
          "status": "PAID",
          "created_at": "2024-01-01T10:05:00Z"
        }
      ],
      "created_at": "2024-01-01T10:00:00Z",
      "updated_at": "2024-01-01T10:05:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}
Lista todos as cobranças PIX In (recebimentos) da conta autenticada com paginação e filtros avançados.
curl -X GET 'https://app.plowf.com/api/v1/payments?status=PAID&per_page=20' \
  -H 'Authorization: Bearer seu_token_aqui'

Parâmetros de Query

Todos os parâmetros são opcionais.
uuid
string
Filtrar por UUID específico da cobrança
status
string
Status da cobrança. Valores possíveis: - UNDEFINED - PENDING - PAID - FAILED - REFUNDED - PARTIALLY_REFUNDED - CANCELLED - EXPIRED - PROCESSING
type
string
Tipo da cobrança. Valores possíveis: - UNDEFINED - PIX
e2e_pix
string
End-to-end ID do PIX
paid_at_start
date
Data de cobrança inicial (formato: YYYY-MM-DD)
paid_at_end
date
Data de cobrança final (formato: YYYY-MM-DD)
date_from
date
Data inicial para filtro (formato: YYYY-MM-DD)
date_to
date
Data final para filtro (formato: YYYY-MM-DD)
per_page
integer
default:"10"
Número de itens por página (mínimo: 1, máximo: 100)

Resposta de Sucesso

{
  "data": [
    {
      "uuid": "770e8400-e29b-41d4-a716-446655440000",
      "value": 250,
      "total_value": 255,
      "fees": 5,
      "currency": "BRL",
      "status": "PAID",
      "type": "PIX",
      "payment": {
        "uuid": "880e8400-e29b-41d4-a716-446655440001",
        "value": "250.00",
        "type": "QR_DYNAMIC",
        "status": "COMPLETED",
        "payload": "00020101021226570014br.gov.bcb.pix2535qr.plowf.com/qr/v2/cob/770e8400-e29b-41d4-a71652040000530398654062500.005802BR5912Empresa_Demo6009Sao_Paulo62290525770e8400e29b41d4a716446663041A2B",
        "pix": {
          "sender": {
            "name": "João Silva",
            "document": "12345678901",
            "account_number": "00123456",
            "account_agency": "0001",
            "bank": {
              "code": "341",
              "name": "ITAÚ UNIBANCO S.A.",
              "ispb": "60701190"
            },
            "account_type": "CHECKING"
          },
          "receiver": {
            "name": "Empresa Demo LTDA",
            "document": "12345678000190",
            "account_number": "9876543",
            "account_agency": "0001",
            "bank": {
              "code": "",
              "name": "PLOWF IP LTDA.",
              "ispb": "00000000"
            },
            "account_type": "CHECKING"
          },
          "txid": "770e8400e29b41d4a716446655440000",
          "value": "250.00",
          "type": "QR_DYNAMIC",
          "pix_key": "1234567890",
          "transaction": {
            "uuid": "990e8400-e29b-41d4-a716-446655440002",
            "value": "250.00",
            "movement_type": "IN",
            "type": "EXTERNAL_TRANSFER",
            "status": "SETTLED",
            "end_to_end": "E6070119020240101100500000000001",
            "settled_at": "2024-01-01T10:05:00.000000Z",
            "created_at": "2024-01-01T10:02:00.000000Z",
            "updated_at": "2024-01-01T10:05:00.000000Z"
          },
          "status": "COMPLETED",
          "expires_at": "2024-03-01T10:00:00.000000Z",
          "created_at": "2024-01-01T10:00:00.000000Z",
          "updated_at": "2024-01-01T10:05:00.000000Z"
        },
        "verify_sender": false,
        "expires_at": "2024-03-01T10:00:00.000000Z",
        "created_at": "2024-01-01T10:00:00.000000Z",
        "updated_at": "2024-01-01T10:05:00.000000Z"
      },
      "external_ref": "PED-001",
      "final_beneficiary": {
        "name": "Maria Santos",
        "document": "98765432100"
      },
      "splits": [
        {
          "uuid": "990e8400-e29b-41d4-a716-446655440002",
          "type": "PERCENTAGE",
          "value": 10,
          "status": "CREDITED",
          "recipient_account": {
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "name": "Empresa Parceira LTDA"
          }
        }
      ],
      "history": [
        {
          "status": "PENDING",
          "created_at": "2024-01-01T10:00:00Z"
        },
        {
          "status": "PAID",
          "created_at": "2024-01-01T10:05:00Z"
        }
      ],
      "created_at": "2024-01-01T10:00:00Z",
      "updated_at": "2024-01-01T10:05:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}
data
object[]
meta
object
Metadados de paginação

Erros Comuns