Criar uma Transferência

Endpoint genérico para criação de transferências de qualquer tipo. O tipo é especificado pelo campo obrigatório 'kind' no nível raiz do payload:

Tipos Suportados

PIX por Chave

Especificar kind: "pix" e fornecer os dados PIX dentro de pix.data (padrão Payment):

{
  "financial_account_uid": "...",
  "amount": 100.0,
  "kind": "pix",
  "pix": {
    "kind": "pix",
    "data": {
      "type": "key",
      "key_type": "email",
      "key": "[email protected]"
    }
  },
  "beneficiary": {
    "name": "João Silva",
    "document": "123.456.789-10"
  }
}

PIX por Conta Bancária

Especificar kind: "pix" e fornecer os dados PIX dentro de pix.data com type: "bank_account":

{
  "financial_account_uid": "...",
  "amount": 200.0,
  "kind": "pix",
  "pix": {
    "kind": "pix",
    "data": {
      "type": "bank_account",
      "bank_account": {
        "bank_code": "237",
        "agency_number": "1234",
        "account_number": "56789-0"
      }
    }
  },
  "beneficiary": {
    "name": "Maria Santos",
    "document": "987.654.321-00"
  }
}

TED

Especificar kind: "ted" e fornecer os dados bancários dentro de ted.data:

{
  "financial_account_uid": "...",
  "amount": 300.0,
  "kind": "ted",
  "ted": {
    "kind": "ted",
    "data": {
      "bank_account": {
        "bank_code": "341",
        "agency_number": "4321",
        "agency_digit": "5",
        "account_number": "98765-4",
        "account_type": "checking"
      }
    }
  },
  "beneficiary": {
    "name": "Pedro Oliveira",
    "document": "11.222.333/0001-44"
  }
}

Transferência Interna

Especificar kind: "internal" e fornecer os dados da conta destino dentro de internal.data:

{
  "financial_account_uid": "...",
  "amount": 400.0,
  "kind": "internal",
  "internal": {
    "kind": "internal",
    "data": {
      "agency_number": "0001",
      "account_number": "12345-6"
    }
  },
  "beneficiary": {
    "name": "Ana Costa",
    "document": "555.666.777-88"
  }
}

Eventos de Webhook

O evento transfer.db.created é disparado nesta operação.

[block:callout] { "type": "info", "body": "Este endpoint unifica a criação de todos os tipos de transferência. Para criar transferências de um tipo específico, você também pode usar os endpoints dedicados em /api/v2/transfer/{type}.", "title": "Endpoint Unificado" } [/block]