Skip to main content
GET
/
api
/
v1
/
transfers
curl -X GET 'https://app.plowf.com/api/v1/transfers?status=PAID&per_page=20' \
  -H 'Authorization: Bearer seu_token_aqui'
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "value": 100.5,
      "fees": 0.5,
      "currency": "BRL",
      "status": "PAID",
      "type": "PIX",
      "external_ref": "REF-001",
      "final_beneficiary": {
        "name": "João Silva",
        "document": "12345678900"
      },
      "transfer": {
        "uuid": "660e8400-e29b-41d4-a716-446655440001",
        "initiation": {
          "sender": {
            "name": "Empresa Exemplo Ltda",
            "document": "00000000000100",
            "account_number": "0000001",
            "account_agency": "0001",
            "bank": {
              "code": "",
              "name": "BANCO EXEMPLO IP LTDA.",
              "ispb": "00000000"
            },
            "account_type": "CHECKING"
          },
          "receiver": {
            "name": "João Silva",
            "document": "123.***.***-00",
            "account_number": "********************",
            "account_agency": "****",
            "bank": {
              "code": "260",
              "name": "BANCO EXEMPLO - IP",
              "ispb": "00000001"
            },
            "account_type": "CHECKING"
          },
          "txid": null,
          "value": 100.5,
          "type": "KEY",
          "pix_key": "12345678900",
          "status": "COMPLETED",
          "expires_at": null,
          "created_at": "2024-01-01T11:59:00Z",
          "updated_at": "2024-01-01T11:59:01Z"
        },
        "value": 100.5,
        "movement_type": "OUT",
        "type": "EXTERNAL_TRANSFER",
        "status": "SETTLED",
        "end_to_end": "E000000002024010111590000000000",
        "settled_at": "2024-01-01T11:59:00Z",
        "created_at": "2024-01-01T11:59:00Z",
        "updated_at": "2024-01-01T11:59:01Z"
      },
      "history": [
        {
          "status": "PENDING",
          "created_at": "2024-01-01T11:59:00Z"
        },
        {
          "status": "PROCESSING",
          "created_at": "2024-01-01T11:59:30Z"
        },
        {
          "status": "PAID",
          "created_at": "2024-01-01T12:00:00Z"
        }
      ],
      "created_at": "2024-01-01T11:59:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 10,
    "to": 10,
    "total": 100
  }
}
Lista todas as transferências da conta autenticada com paginação e filtros avançados.
curl -X GET 'https://app.plowf.com/api/v1/transfers?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 transferência
status
string
Status da transferência. Valores possíveis: - UNDEFINED - PENDING - PAID
  • FAILED - REFUNDED - PARTIALLY_REFUNDED - CANCELLED - EXPIRED - PROCESSING
type
string
Tipo da transferência. Valores possíveis: - UNDEFINED - PIX
date_from
date
Data inicial para filtro (formato: YYYY-MM-DD)
date_to
date
Data final para filtro (formato: YYYY-MM-DD)
transfer_at_start
date
Data de transferência inicial (formato: YYYY-MM-DD)
transfer_at_end
date
Data de transferência final (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": "550e8400-e29b-41d4-a716-446655440000",
      "value": 100.5,
      "fees": 0.5,
      "currency": "BRL",
      "status": "PAID",
      "type": "PIX",
      "external_ref": "REF-001",
      "final_beneficiary": {
        "name": "João Silva",
        "document": "12345678900"
      },
      "transfer": {
        "uuid": "660e8400-e29b-41d4-a716-446655440001",
        "initiation": {
          "sender": {
            "name": "Empresa Exemplo Ltda",
            "document": "00000000000100",
            "account_number": "0000001",
            "account_agency": "0001",
            "bank": {
              "code": "",
              "name": "BANCO EXEMPLO IP LTDA.",
              "ispb": "00000000"
            },
            "account_type": "CHECKING"
          },
          "receiver": {
            "name": "João Silva",
            "document": "123.***.***-00",
            "account_number": "********************",
            "account_agency": "****",
            "bank": {
              "code": "260",
              "name": "BANCO EXEMPLO - IP",
              "ispb": "00000001"
            },
            "account_type": "CHECKING"
          },
          "txid": null,
          "value": 100.5,
          "type": "KEY",
          "pix_key": "12345678900",
          "status": "COMPLETED",
          "expires_at": null,
          "created_at": "2024-01-01T11:59:00Z",
          "updated_at": "2024-01-01T11:59:01Z"
        },
        "value": 100.5,
        "movement_type": "OUT",
        "type": "EXTERNAL_TRANSFER",
        "status": "SETTLED",
        "end_to_end": "E000000002024010111590000000000",
        "settled_at": "2024-01-01T11:59:00Z",
        "created_at": "2024-01-01T11:59:00Z",
        "updated_at": "2024-01-01T11:59:01Z"
      },
      "history": [
        {
          "status": "PENDING",
          "created_at": "2024-01-01T11:59:00Z"
        },
        {
          "status": "PROCESSING",
          "created_at": "2024-01-01T11:59:30Z"
        },
        {
          "status": "PAID",
          "created_at": "2024-01-01T12:00:00Z"
        }
      ],
      "created_at": "2024-01-01T11:59:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 10,
    "to": 10,
    "total": 100
  }
}
data
object[]
meta
object
Metadados de paginação

Erros Comuns