Plowf

https://docs.plowf.com/
Admin
Plowf é uma plataforma para operar PIX e fluxos financeiros associados: você pode receber (cobranças...
Tokens:103,773
Snippets:511
Trust Score:4.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Successful Response Example

Source: https://docs.plowf.com/api-reference/pix-keys/list

This is an example of a successful JSON response when listing PIX keys. It includes the data for the keys and metadata for pagination.

```json
{
  "data": [
    {
      "key": "user@email.com",
      "type": "EMAIL",
      "is_active": true,
      "created_at": "2026-01-19T19:32:14.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "total": 1,
    "per_page": 10
  }
}
```

--------------------------------

### Successful Response Example

Source: https://docs.plowf.com/api-reference/meds/list

This example shows the structure of a successful response when listing MEDs, including data and metadata.

```json
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "pix_in_transaction": {
        "uuid": "660e8400-e29b-41d4-a716-446655440001",
        "initiation": {
          "sender": {
            "name": "João Silva",
            "document": "12345678900",
            "account_number": "12345678",
            "account_agency": "0001",
            "bank": {
              "code": "001",
              "name": "Banco Exemplo",
              "ispb": "00000000"
            },
            "account_type": "PAYMENT"
          },
          "receiver": {
            "name": "Empresa Exemplo LTDA",
            "document": "12345678000199",
            "account_number": "87654321",
            "account_agency": "0001",
            "bank": {
              "code": "002",
              "name": "Banco Recebedor",
              "ispb": "00000001"
            },
            "account_type": "CHECKING"
          },
          "txid": "txid123456789abcdef",
          "value": "150.00",
          "type": "QR_DYNAMIC",
          "pix_key": "770e8400-e29b-41d4-a716-446655440002",
          "additional_info": [
            {
              "name": "ID do pagamento",
              "value": "880e8400-e29b-41d4-a716-446655440003"
            }
          ],
          "status": "COMPLETED",
          "expires_at": "2024-01-02T23:59:59.000000Z",
          "created_at": "2024-01-01T10:00:00.000000Z",
          "updated_at": "2024-01-01T10:05:00.000000Z"
        },
        "value": "150.00",
        "movement_type": "IN",
        "type": "EXTERNAL_TRANSFER",
        "status": "SETTLED",
        "end_to_end": "E00000000202401011000abcdef12345",
        "settled_at": "2024-01-01T10:05:00.000000Z",
        "created_at": "2024-01-01T10:05:00.000000Z",
        "updated_at": "2024-01-01T10:05:00.000000Z"
      },
      "attachments": [
        {
          "uuid": "990e8400-e29b-41d4-a716-446655440004",
          "url": "https://app.plowf.com/attachments/meds/550e8400-e29b-41d4-a716-446655440000/990e8400-e29b-41d4-a716-446655440004.jpg"
        }
      ],
      "med_type": "RECEIVED_MED",
      "dispute_type": "UNDEFINED",
      "status": "PROCESSING",
      "details": "01",
      "analysis": "Texto de análise do MED",
      "resolved": false,
      "created_at": "2024-01-01T12:00:00.000000Z",
      "updated_at": "2024-01-02T14:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}
```

--------------------------------

### List Transfers Response Example

Source: https://docs.plowf.com/api-reference/transfers/list

This example demonstrates the structure of a successful response when listing transfers. It includes details about the transfer data, such as UUID, value, status, and beneficiary information, along with pagination metadata.

```json
{
  "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
  }
}
```

--------------------------------

### Create PIX Payment - Provider Specific

Source: https://docs.plowf.com/api-reference/payments/create

This example demonstrates how to create a PIX payment using a specific provider. It requires the provider's UUID and the payment value.

```bash
curl -X POST 'https://app.plowf.com/api/v1/payments' \
    -H 'Authorization: Bearer seu_token_aqui' \
    -H 'Content-Type: application/json' \
    -d '{
      "value": 250.00,
      "type": "pix",
      "provider_uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001"
    }'
```

--------------------------------

### Success Response Example

Source: https://docs.plowf.com/llms-full.txt

This is an example of a successful response from the API, detailing transfer information.

```APIDOC
## Response Example

```json
{
  "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
  }
}
```
```

--------------------------------

### Create PIX Payment - Default

Source: https://docs.plowf.com/api-reference/payments/create

Use this example to create a standard PIX payment. It includes fields for value, type, external reference, final beneficiary details, and optional splits for distributing funds.

```bash
curl -X POST 'https://app.plowf.com/api/v1/payments' \
    -H 'Authorization: Bearer seu_token_aqui' \
    -H 'Content-Type: application/json' \
    -d '{
      "value": 250.00,
      "type": "pix",
      "external_ref": "PED-001",
      "final_beneficiary": {
        "name": "Maria Santos",
        "document": "98765432100"
      },
      "splits": [
        {
          "type": "percentage",
          "value": 10,
          "recipient_account_uuid": "550e8400-e29b-41d4-a716-446655440000"
        },
        {
          "type": "fixed",
          "value": 5.00,
          "recipient_account_uuid": "660e8400-e29b-41d4-a716-446655440001"
        }
      ]
    }'
```

--------------------------------

### Node.js Webhook Validation Example

Source: https://docs.plowf.com/api-reference/webhooks/validation-link

This Node.js example demonstrates how to set up an Express server to receive and validate incoming webhooks using HMAC SHA-256 signatures.

```APIDOC
## POST /webhook

### Description
Receives and validates an incoming webhook.

### Method
POST

### Endpoint
/webhook

### Parameters
#### Headers
- **X-Webhook-Signature** (string) - Required - The HMAC SHA-256 signature of the payload.

#### Request Body
- **(object)** - Required - The webhook payload.

### Request Example
```json
{
  "event": "user.created",
  "data": {
    "id": 123,
    "name": "John Doe"
  }
}
```

### Response
#### Success Response (200)
- **received** (boolean) - Indicates if the webhook was successfully received and validated.

#### Response Example
```json
{
  "received": true
}
```

#### Error Response (401)
- **error** (string) - "Missing signature" or "Invalid signature".

#### Error Response Example
```json
{
  "error": "Invalid signature"
}
```
```

--------------------------------

### GET /api/v1/pix-keys

Source: https://docs.plowf.com/llms-full.txt

Lista todas as chaves PIX da conta autenticada com suporte a filtros e paginação.

```APIDOC
## GET /api/v1/pix-keys

### Description
Lista todas as chaves PIX da conta autenticada com suporte a filtros e paginação.

### Method
GET

### Endpoint
/api/v1/pix-keys

### Parameters
#### Query Parameters
- **type** (string) - Optional - Tipo da chave PIX. Valores possíveis: `DOCUMENT`, `EMAIL`, `PHONE`, `RANDOM`
- **is_active** (boolean) - Optional - Filtrar por status da chave. `true` para ativas, `false` para inativas.
- **per_page** (integer) - Optional - Número de itens por página (mínimo: 1, máximo: 100)

### Request Example
```bash
curl -X GET 'https://app.plowf.com/api/v1/pix-keys?type=EMAIL&is_active=true' \
  -H 'Authorization: Bearer seu_token_aqui'
```

### Response
#### Success Response (200)
- **data** (object[]) - Lista de chaves PIX.
  - **key** (string) - Valor da chave PIX (e-mail, telefone, CPF/CNPJ ou chave aleatória)
  - **type** (string) - Tipo da chave: `DOCUMENT`, `EMAIL`, `PHONE` ou `RANDOM`
  - **is_active** (boolean) - Indica se a chave está ativa
  - **created_at** (datetime) - Data e hora de criação da chave
- **meta** (object) - Metadados de paginação.
  - **current_page** (number) - Página atual
  - **from** (number) - Índice do primeiro item da página
  - **last_page** (number) - Última página disponível
  - **per_page** (number) - Itens por página
  - **to** (number) - Índice do último item da página
  - **total** (number) - Total de itens

#### Response Example
```json
{
  "data": [
    {
      "key": "user@email.com",
      "type": "EMAIL",
      "is_active": true,
      "created_at": "2026-01-19T19:32:14.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "total": 1,
    "per_page": 10
  }
}
```

### Errors
#### Error Response (401)
- **message** (string) - Token de autenticação inválido ou ausente
```

--------------------------------

### Success Response Example

Source: https://docs.plowf.com/llms-full.txt

This snippet illustrates a typical successful response when retrieving charge information.

```APIDOC
## Response Example
{
  "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
  }
}
```

--------------------------------

### Criar Chave PIX do tipo EMAIL

Source: https://docs.plowf.com/api-reference/pix-keys/create

This example demonstrates creating a PIX key associated with an email address. Include the type as EMAIL, along with auth_code_id and auth_code in the request body.

```bash
curl -X POST 'https://app.plowf.com/api/v1/pix-keys' \
    -H 'Authorization: Bearer seu_token_aqui' \
    -H 'Content-Type: application/json' \
    -d '{ 
      "type": "EMAIL",
      "auth_code_id": "abc123xyz",
      "auth_code": "123456"
    }'
```

--------------------------------

### Create Webhook Request Example

Source: https://docs.plowf.com/llms-full.txt

Use this cURL command to create a new webhook. Ensure you replace 'seu_token_aqui' with your actual API token and provide a valid HTTPS URL for the webhook endpoint. The token parameter is optional and will be auto-generated if omitted.

```bash
curl -X POST 'https://app.plowf.com/api/v1/webhooks' \
    -H 'Authorization: Bearer seu_token_aqui' \
    -H 'Content-Type: application/json' \
    -d '{
      "url": "https://webhook.site/04ef5e41-d054-49f9-805c-03a6a345245e",
      "token": "nUeO7RobnrgJxs8mBr1oOvChV4wqOblj"
    }'
```

--------------------------------

### Create Webhook

Source: https://docs.plowf.com/guides/webhooks/intro

Register a new webhook URL with the platform to start receiving event notifications.

```APIDOC
## POST /api/v1/webhooks

### Description
Creates a new webhook subscription.

### Method
POST

### Endpoint
/api/v1/webhooks

### Parameters
#### Request Body
- **url** (string) - Required - The URL to which webhook events will be sent.
- **events** (array of strings) - Optional - A list of event types to subscribe to. If not provided, all events will be sent.

### Request Example
{
  "url": "https://your-server.com/webhook-handler",
  "events": ["PAYMENT", "TRANSFER"]
}

### Response
#### Success Response (201)
- **uuid** (string) - The unique identifier for the created webhook.
- **url** (string) - The registered webhook URL.
- **events** (array of strings) - The list of events subscribed to.

#### Response Example
{
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "url": "https://your-server.com/webhook-handler",
  "events": ["PAYMENT", "TRANSFER"]
}
```

--------------------------------

### Successful Response Example

Source: https://docs.plowf.com/llms-full.txt

This JSON structure represents a successful response when listing providers. It includes a 'data' array with provider details and 'meta' information for pagination.

```json
{
  "data": [
    {
      "uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001",
      "status": "ACTIVE",
      "provider": "DELFINANCE",
      "type": "NOMINAL",
      "is_operational": true,
      "is_public": true,
      "virtual_account": {
        "type": "NOMINAL",
        "name": "Empresa Demo LTDA",
        "document": "12345678000190",
        "account_number": "9876543",
        "account_agency": "0001",
        "bank": {
          "code": "",
          "name": "PLOWF IP LTDA.",
          "ispb": "00000000"
        },
        "account_type": "CHECKING"
      },
      "balances": [
        {
          "available_balance": 1500.00,
          "pending_balance": 0,
          "blocked_balance": 0,
          "retained_balance": 0,
          "provisioned_balance": 0,
          "currency": "BRL"
        }
      ]
    },
    {
      "uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f002",
      "status": "ACTIVE",
      "provider": "WOOVI",
      "type": "POOL",
      "is_operational": true,
      "is_public": false,
      "virtual_account": null,
      "balances": [
        {
          "available_balance": 250.50,
          "pending_balance": 0,
          "blocked_balance": 0,
          "retained_balance": 0,
          "provisioned_balance": 0,
          "currency": "BRL"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 2,
    "total": 2,
    "per_page": 10
  }
}
```

--------------------------------

### Exemplo de Requisição para Listar Provedores Padrão

Source: https://docs.plowf.com/llms-full.txt

Utilize este comando cURL para fazer uma requisição GET ao endpoint de provedores padrão. Certifique-se de substituir 'seu_token_aqui' pelo seu token de autenticação válido.

```bash
curl -X GET 'https://app.plowf.com/api/v1/providers/defaults' \
    -H 'Authorization: Bearer seu_token_aqui'
```

--------------------------------

### Obter Detalhes de Transferência

Source: https://docs.plowf.com/api-reference/transfers/get

Utilize este comando cURL para fazer uma requisição GET à API e recuperar os detalhes de uma transferência específica. Certifique-se de substituir 'seu_token_aqui' pelo seu token de autenticação real e o ID da transferência pelo ID desejado.

```bash
curl -X GET 'https://app.plowf.com/api/v1/transfers/550e8400-e29b-41d4-a716-446655440000' \
    -H 'Authorization: Bearer seu_token_aqui'
```

--------------------------------

### GET /api/v1/providers/{providerUuid}

Source: https://docs.plowf.com/llms-full.txt

Retorna os detalhes de um provedor específico. Se o token estiver vinculado a um provedor diferente do informado em `{providerUuid}`, a API responderá com 404.

```APIDOC
## GET /api/v1/providers/{providerUuid}

### Description
Retorna os detalhes de um provedor específico. Se o token estiver vinculado a um provedor diferente do informado em `{providerUuid}`, a API responderá com 404.

### Method
GET

### Endpoint
/api/v1/providers/{providerUuid}

### Parameters
#### Path Parameters
- **providerUuid** (string) - Required - UUID do provedor

### Request Example
```bash
curl -X GET 'https://app.plowf.com/api/v1/providers/9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001' \
  -H 'Authorization: Bearer seu_token_aqui'
```

### Response
#### Success Response (200)
- **data** (object) - Contém os detalhes do provedor. A estrutura é a mesma de cada item do endpoint de listagem.

#### Response Example
```json
{
  "data": {
    "uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001",
    "status": "ACTIVE",
    "provider": "DELFINANCE",
    "type": "NOMINAL",
    "is_operational": true,
    "is_public": true,
    "virtual_account": {
      "type": "NOMINAL",
      "name": "Empresa Demo LTDA",
      "document": "12345678000190",
      "account_number": "9876543",
      "account_agency": "0001",
      "bank": {
        "code": "",
        "name": "PLOWF IP LTDA.",
        "ispb": "00000000"
      },
      "account_type": "CHECKING"
    },
    "balances": [
      {
        "available_balance": 1500.00,
        "pending_balance": 0,
        "blocked_balance": 0,
        "retained_balance": 0,
        "provisioned_balance": 0,
        "currency": "BRL"
      }
    ]
  }
}
```

### Errors
#### Error Response (401)
- **message** (string) - Token de autenticação inválido ou ausente

#### Error Response (404)
- **message** (string) - Provedor não encontrado. Verifique se o UUID está correto e se ele pertence à conta autenticada.
```

--------------------------------

### Success Response Example

Source: https://docs.plowf.com/llms-full.txt

This snippet shows the structure of a successful response when retrieving MED (Mensagem Eletrônica de Disputa) information. It includes details about the MED itself, associated Pix transactions, attachments, and pagination metadata.

```APIDOC
## Response Example

```json
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "pix_in_transaction": {
        "uuid": "660e8400-e29b-41d4-a716-446655440001",
        "initiation": {
          "sender": {
            "name": "João Silva",
            "document": "12345678900",
            "account_number": "12345678",
            "account_agency": "0001",
            "bank": {
              "code": "001",
              "name": "Banco Exemplo",
              "ispb": "00000000"
            },
            "account_type": "PAYMENT"
          },
          "receiver": {
            "name": "Empresa Exemplo LTDA",
            "document": "12345678000199",
            "account_number": "87654321",
            "account_agency": "0001",
            "bank": {
              "code": "002",
              "name": "Banco Recebedor",
              "ispb": "00000001"
            },
            "account_type": "CHECKING"
          },
          "txid": "txid123456789abcdef",
          "value": "150.00",
          "type": "QR_DYNAMIC",
          "pix_key": "770e8400-e29b-41d4-a716-446655440002",
          "additional_info": [
            {
              "name": "ID do pagamento",
              "value": "880e8400-e29b-41d4-a716-446655440003"
            }
          ],
          "status": "COMPLETED",
          "expires_at": "2024-01-02T23:59:59.000000Z",
          "created_at": "2024-01-01T10:00:00.000000Z",
          "updated_at": "2024-01-01T10:05:00.000000Z"
        },
        "value": "150.00",
        "movement_type": "IN",
        "type": "EXTERNAL_TRANSFER",
        "status": "SETTLED",
        "end_to_end": "E00000000202401011000abcdef12345",
        "settled_at": "2024-01-01T10:05:00.000000Z",
        "created_at": "2024-01-01T10:05:00.000000Z",
        "updated_at": "2024-01-01T10:05:00.000000Z"
      },
      "attachments": [
        {
          "uuid": "990e8400-e29b-41d4-a716-446655440004",
          "url": "https://app.plowf.com/attachments/meds/550e8400-e29b-41d4-a716-446655440000/990e8400-e29b-41d4-a716-446655440004.jpg"
        }
      ],
      "med_type": "RECEIVED_MED",
      "dispute_type": "UNDEFINED",
      "status": "PROCESSING",
      "details": "01",
      "analysis": "Texto de análise do MED",
      "resolved": false,
      "created_at": "2024-01-01T12:00:00.000000Z",
      "updated_at": "2024-01-02T14:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}
```
```

--------------------------------

### Success Response Example

Source: https://docs.plowf.com/llms-full.txt

This JSON object represents a successful API response, detailing a received PIX transaction within a MED (Mensagem Eletrônica de Dados). It includes sender and receiver information, transaction details, and associated attachments.

```json
{
    "data": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "pix_in_transaction": {
          "uuid": "660e8400-e29b-41d4-a716-446655440001",
          "initiation": {
            "sender": {
              "name": "João Silva",
              "document": "12345678900",
              "account_number": "12345678",
              "account_agency": "0001",
              "bank": {
                "code": "001",
                "name": "Banco Exemplo",
                "ispb": "00000000"
              },
              "account_type": "PAYMENT"
            },
            "receiver": {
              "name": "Empresa Exemplo LTDA",
              "document": "12345678000199",
              "account_number": "87654321",
              "account_agency": "0001",
              "bank": {
                "code": "002",
                "name": "Banco Recebedor",
                "ispb": "00000001"
              },
              "account_type": "CHECKING"
            },
            "txid": "txid123456789abcdef",
            "value": "150.00",
            "type": "QR_DYNAMIC",
            "pix_key": "770e8400-e29b-41d4-a716-446655440002",
            "additional_info": [
              {
                "name": "ID do pagamento",
                "value": "880e8400-e29b-41d4-a716-446655440003"
              }
            ],
            "status": "COMPLETED",
            "expires_at": "2024-01-02T23:59:59.000000Z",
            "created_at": "2024-01-01T10:00:00.000000Z",
            "updated_at": "2024-01-01T10:05:00.000000Z"
          },
          "value": "150.00",
          "movement_type": "IN",
          "type": "EXTERNAL_TRANSFER",
          "status": "SETTLED",
          "end_to_end": "E00000000202401011000abcdef12345",
          "settled_at": "2024-01-01T10:05:00.000000Z",
          "created_at": "2024-01-01T10:05:00.000000Z",
          "updated_at": "2024-01-01T10:05:00.000000Z"
        },
        "attachments": [
          {
            "uuid": "990e8400-e29b-41d4-a716-446655440004",
            "url": "https://app.plowf.com/attachments/meds/550e8400-e29b-41d4-a716-446655440000/990e8400-e29b-41d4-a716-446655440004.jpg"
          }
        ],
        "med_type": "RECEIVED_MED",
        "dispute_type": "UNDEFINED",
        "status": "PROCESSING",
        "details": "01",
        "analysis": "Texto de análise do MED",
        "resolved": false,
        "created_at": "2024-01-01T12:00:00.000000Z",
        "updated_at": "2024-01-02T14:30:00.000000Z"
      }
    ],
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 5,
      "per_page": 10,
      "to": 10,
      "total": 50
    }
  }
}
```

--------------------------------

### Exemplo 3: Splits combinados (percentual + fixo)

Source: https://docs.plowf.com/guides/payments/recipes/payment-with-split

Cria uma cobrança PIX de R$ 500,00 com dois splits simultâneos: 10% para um parceiro e R$ 8,00 fixos para a plataforma. O total distribuído é R$ 58,00.

```bash
curl -X POST 'https://app.plowf.com/api/v1/payments' \
  -H 'Authorization: Bearer seu_token_aqui' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": 500.00,
    "type": "pix",
    "external_ref": "PEDIDO-791",
    "splits": [
      {
        "type": "PERCENTAGE",
        "value": 10,
        "recipient_account_uuid": "550e8400-e29b-41d4-a716-446655440000"
      },
      {
        "type": "FIXED",
        "value": 8.00,
        "recipient_account_uuid": "660e8400-e29b-41d4-a716-446655440001"
      }
    ]
  }'
```

--------------------------------

### Atualizar Provedores Padrão para PIX

Source: https://docs.plowf.com/llms-full.txt

Use este endpoint para definir a ordem de prioridade dos provedores de pagamento para um tipo específico. Certifique-se de que todos os UUIDs fornecidos sejam válidos e correspondam a provedores ativos em sua conta.

```bash
curl -X PUT 'https://app.plowf.com/api/v1/providers/defaults' \
    -H 'Authorization: Bearer seu_token_aqui' \
    -H 'Content-Type: application/json' \
    -d '{
      "payment_type": "PIX",
      "provider_uuids": [
        "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001",
        "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f002"
      ]
    }'
```

--------------------------------

### Exemplo 2: Split fixo (taxa de plataforma)

Source: https://docs.plowf.com/guides/payments/recipes/payment-with-split

Cria uma cobrança PIX de R$ 100,00, deduzindo R$ 5,00 fixos como taxa de plataforma. O valor fixo é repassado para a conta da plataforma.

```bash
curl -X POST 'https://app.plowf.com/api/v1/payments' \
  -H 'Authorization: Bearer seu_token_aqui' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": 100.00,
    "type": "pix",
    "external_ref": "PEDIDO-790",
    "splits": [
      {
        "type": "FIXED",
        "value": 5.00,
        "recipient_account_uuid": "660e8400-e29b-41d4-a716-446655440001"
      }
    ]
  }'
```

--------------------------------

### Example TRANSFER Webhook Payload

Source: https://docs.plowf.com/guides/transfers/recipes/transfer-webhook

This is an example of the JSON payload received when a PIX transfer is settled or fails. It includes event details, status, value, and transfer-specific information.

```json
{
  "event": "TRANSFER",
  "timestamp": "2024-01-01T12:00:00Z",
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PAID",
    "value": 250.00,
    "external_ref": "SAQUE-98765",
    "transfer": {
      "end_to_end": "E000000002024010112000000000001",
      "settled_at": "2024-01-01T12:00:00Z"
    }
  }
}
```

--------------------------------

### Exemplo 1: Split percentual (comissão de parceiro)

Source: https://docs.plowf.com/guides/payments/recipes/payment-with-split

Cria uma cobrança PIX de R$ 200,00, repassando 15% para um parceiro. O parceiro receberá R$ 30,00 automaticamente.

```bash
curl -X POST 'https://app.plowf.com/api/v1/payments' \
  -H 'Authorization: Bearer seu_token_aqui' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": 200.00,
    "type": "pix",
    "external_ref": "PEDIDO-789",
    "splits": [
      {
        "type": "PERCENTAGE",
        "value": 15,
        "recipient_account_uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ]
  }'
```

--------------------------------

### Get MED Details using cURL

Source: https://docs.plowf.com/api-reference/meds/get

Use this cURL command to make a GET request to the API to retrieve MED details. Replace 'seu_token_aqui' with your actual API token and the MED ID with the specific ID you want to query.

```bash
curl -X GET 'https://app.plowf.com/api/v1/meds/550e8400-e29b-41d4-a716-446655440000' \
    -H 'Authorization: Bearer seu_token_aqui'
```

--------------------------------

### Exemplo de Resposta de Sucesso para Provedores Padrão

Source: https://docs.plowf.com/llms-full.txt

A resposta de sucesso lista os provedores padrão agrupados por tipo de pagamento. Para PIX, é fornecida uma lista priorizada de provedores, incluindo detalhes operacionais e de conta virtual quando aplicável.

```json
{
  "data": {
    "PIX": [
      {
        "uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f001",
        "status": "ACTIVE",
        "provider": "DELFINANCE",
        "type": "NOMINAL",
        "is_operational": true,
        "is_public": true,
        "virtual_account": {
          "type": "NOMINAL",
          "name": "Empresa Demo LTDA",
          "document": "12345678000190",
          "account_number": "9876543",
          "account_agency": "0001",
          "bank": {
            "code": "",
            "name": "PLOWF IP LTDA.",
            "ispb": "00000000"
          },
          "account_type": "CHECKING"
        }
      },
      {
        "uuid": "9f1c0a30-3b8c-4a82-a4d7-2b8e93b1f002",
        "status": "ACTIVE",
        "provider": "WOOVI",
        "type": "POOL",
        "is_operational": true,
        "is_public": false,
        "virtual_account": null
      }
    ]
  }
}
```
Tokens:
Raw