Documentação da API Pay2flow

Visão Geral

A API Pay2flow oferece três endpoints principais para integração completa com o ecossistema PIX: Cash-in (criação de cobrança), Consulta de Status e Cash-out (saque).

Autenticação & Segurança

Todos os endpoints exigem HMAC-SHA256 com proteção anti-replay e idempotência.

CopiarPOST
/api/gateway/pix/deposit/
X-P2F-Key:<SUA_CHAVE_PUBLICA>
X-P2F-Timestamp:<TIMESTAMP>
X-P2F-Nonce:<NONCE>
Idempotency-Key:<IDEMPOTENCY_KEY>
Digest:SHA-256:<DIGEST_BASE64>

Gere cobranças PIX (EMV “copia e cola”).

Request Body

Copiar{
  "valor_total": 159.90,
  "numero_pedido": "PEDIDO-externo-123",
  "payer": {
    "name": "João Silva",
    "email": "joao@example.com",
    "cpf": "12345678909"
  }
}

Response (200)

Copiar{
  "transaction_id": "fbk_tx_ABC123",
  "numero_pedido": "PEDIDO-externo-123",
  "status": "PENDING",
  "pix_emv": "<EMV copia-e-cola PIX>",
  "amount": 159.9
}

Consulte usando transaction_id e/ou numero_pedido.

Request Body

Copiar{
  "numero_pedido": "PEDIDO-externo-123",
  "transaction_id": "fbk_tx_ABC123"
}

Response (200)

Copiar{
  "numero_pedido": "PEDIDO-externo-123",
  "transaction_id": "fbk_tx_ABC123",
  "status": "PAID",
  "amount": 159.9,
  "fee": 0,
  "net_amount": 159.9,
  "created_at": "2025-08-12 22:20:51",
  "updated_at": "2025-08-12 22:23:49"
}

Permite saques via PIX a partir do saldo disponível.
Importante: quando o provedor retornar status: "WITHDRAW_REQUEST" com transactionId, consideramos o saque processado com sucesso e respondemos como COMPLETED (sem necessidade de consulta posterior).

Request Body

Copiar{
  "amount": 123.45,
  "saque_method": "PIX",
  "beneficiary_name": "Fulano de Tal",
  "beneficiary_document": "12345678909",
  "pix_key_type": "cpf_cnpj",
  "pix_key": "12345678909"
}

Response (200)

Copiar{
  "withdrawal_id": 123,
  "transaction_id": "a703cffe-6e5e-41b8-b897-3fc2210667f2",
  "status": "COMPLETED",
  "amount": 123.45
}

Códigos de Status

Suporte & Contato

Time disponível para credenciais, sandbox, troubleshooting e boas práticas de integração.

*Indicadores internos sob condições ideais e análise de risco.