Skip to main content
Para mais detalhes sobre o endpoint e a descrição completa de todos os campos do body, consulte a referência do endpoint.

Visão Geral

O split de pagamento permite que, ao receber um PIX, o valor seja distribuído automaticamente entre outras contas — por exemplo, para repassar comissões a parceiros ou cobrar taxas de plataforma. Dois tipos de split:
  • PERCENTAGE — repassa uma porcentagem do valor recebido
  • FIXED — repassa um valor fixo em reais independente do total

Pré-requisito

Você precisa do recipient_account_uuid de cada conta que vai receber parte do valor. Esse UUID identifica a conta destinatária na plataforma Plowf.

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

Cenário: cobrança de R$ 200,00, repassando 15% para um parceiro.
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"
      }
    ]
  }'
Resultado: o parceiro recebe R$ 30,00 (15% de R$ 200,00) automaticamente ao confirmar o pagamento.

Exemplo 2: Split fixo (taxa de plataforma)

Cenário: cobrança de R$ 100,00, deduzindo R$ 5,00 fixos como taxa de plataforma.
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"
      }
    ]
  }'

Exemplo 3: Splits combinados (percentual + fixo)

Cenário: cobrança de R$ 500,00 com dois splits simultâneos.
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"
      }
    ]
  }'
Resultado: parceiro recebe R$ 50,00 (10%) + plataforma recebe R$ 8,00 (fixo). Total distribuído: R$ 58,00.

Validações importantes

  • A soma de todos os splits PERCENTAGE não pode ultrapassar 100%
  • A soma total de todos os splits (percentual + fixo) não pode ser maior que o valor da cobrança
  • Para a mesma conta, você não pode ter dois splits do mesmo tipo (ex: dois PERCENTAGE para o mesmo recipient_account_uuid)
  • Para splits FIXED, o value representa reais (ex: 5.00 = R$ 5,00)
  • Para splits PERCENTAGE, o value representa porcentagem (ex: 10 = 10%)

Referências