Transferências

A API de transferências da Grafeno permite a criação, listagem, aprovação e rejeição de transferências. Essa funcionalidade oferece uma maneira eficiente de gerenciar suas transações financeiras, automatizando processos e integrando suas operações financeiras diretamente com nossos serviços.

Funcionalidades Principais:

Criação de Transferências: Permite criar novas transferências de forma rápida e segura.
Listagem de Transferências: Facilita a visualização de todas as transferências pendentes e concluídas.
Aprovação e Rejeição de Transferências: Aprove ou rejeite transferências de forma dinâmica.
Notificações: Obtenha o status de suas transferências de forma automática através de nossos webhooks.

Tipos de Transferências

A API suporta diferentes tipos de transferências, cada uma adaptada a necessidades específicas. Abaixo estão os tipos de transferências suportadas:

Tipo de Transferência	Descrição
TED	Transferência Eletrônica Disponível. Utilizada para transferências entre diferentes bancos no Brasil.
PIX	Sistema de Pagamentos Instantâneos do Brasil. Permite transferências 24/7 de forma instantânea.

Parâmetros de Criação de Transferências

Ao criar uma transferência, os seguintes parâmetros são necessários:

Parâmetro	Tipo	Descrição	Exemplo
transfer_request.transferMethod	string	Método de transferência (TED, PIX).	pix
transfer_request.value	string	Valor da transferência.	790.00
transfer_request.api_partner_transaction_uuid	string	UUID único da transação gerado pelo parceiro API.	PIX
transfer_request.callback_url	string	URL de callback para notificação de status da transação.	[https://transferencias-grafeno.free.beeceptor.com]
beneficiary	Object	Dados do beneficiário.	-

Dados do Beneficiário

Parâmetro	Tipo	Descrição	Exemplo
beneficiary.name	string	Nome do beneficiário.	Schrute Farms
beneficiary.documentNumber	string	CPF ou CNPJ do beneficiário.	08.470.974/0001-40
beneficiary.bankCode	string	Código do banco do beneficiário.	274
beneficiary.agency	string	Número da agência do beneficiário.	0001
beneficiary.account	string	Número da conta do beneficiário.	08146972-8
beneficiary.uuid	string	UUID único do beneficiário.	48347e3f-ff08-49b3-973c-c68fa53c75ba
beneficiary.keyType	string	Tipo da chave PIX (evp, cnpj, cpf, email, phone).	evp
beneficiary.key	string	Chave PIX do beneficiário (se aplicável).	5561a2cb-24bb-4a82-b6f8-053b4ed1347c

Exemplo de Criação de Transferências

Transferência TED

{
  "transfer_request": {
    "transferMethod": "ted",
    "value": 290.90,
    "api_partner_transaction_uuid": "fb800c79-dd59-40a4-8075-2c1f10c4f3a8",
    "callback_url": "https://teste-grafeno.free.beeceptor.com"
  },
  "beneficiary": {
    "name": "Schrute Farms",
    "documentNumber": "08.470.974/0001-40",
    "bankCode": "274",
    "agency": "0001",
    "account": "08146972-8"
  }
}

Transferência PIX

{
  "transfer_request": {
    "transferMethod": "pix",
    "value": 790.90,
    "api_partner_transaction_uuid": "fb800c79-dd59-40a4-8075-2c1f10c4f3a8",
    "callback_url": "https://teste-grafeno.free.beeceptor.com"
  },
  "beneficiary": {
    "name": "Schrute Farms",
    "documentNumber": "08.470.974/0001-40",
    "keyType": "evp",
    "key": "5561a2cb-24bb-4a82-b6f8-053b4ed1347c"
  }
}

Transferência recuperando o beneficiário por uuid

{
  "transfer_request": {
    "transferMethod": "ted",
    "value": 790.90,
    "api_partner_transaction_uuid": "fb800c79-dd59-40a4-8075-2c1f10c4f3a8",
    "callback_url": "https://teste-grafeno.free.beeceptor.com"
  },
  "beneficiary": {
    "uuid": "e4c63c80-b3a8-43f0-ba4d-31ceabf6abff"
  }
}

Parâmetros de Retorno para Listar Transferências (TEF, TED e PIX)

Parâmetro	Descrição	Tipo
id	Identificador único da solicitação de transferência.	String
type	Tipo de solicitação, sempre `transferRequest` para este endpoint.	String
apiPartnerTransactionUuid	UUID da transação gerado pelo parceiro API.	String
originBankAccount.agency	Agência da conta bancária de origem.	String
originBankAccount.account	Conta bancária de origem.	String
originBankAccount.name	Nome do titular da conta bancária de origem.	String
associatedFund	Fundo associado à transferência, se aplicável.	String
beneficiary.companyName	Nome da empresa do beneficiário, se aplicável.	String
beneficiary.destinationAccount.agency	Agência da conta bancária do beneficiário.	String
beneficiary.destinationAccount.account	Conta bancária do beneficiário.	String
beneficiary.destinationAccount.name	Nome do titular da conta bancária do beneficiário.	String
beneficiary.destinationAccount.pixDetails.keyType	Tipo da chave PIX do beneficiário.	String
beneficiary.destinationAccount.pixDetails.key	Chave PIX do beneficiário.	String
transferDetails.createdAt	Data e hora da criação da solicitação de transferência.	String
transferDetails.value	Valor da transferência.	String
transferDetails.source	Fonte da solicitação de transferência (por exemplo, `api`).	String
transferDetails.transferMethod	Método de transferência utilizado (por exemplo, `pix`).	String
transferDetails.approvalStatus	Status de aprovação da transferência (por exemplo, `pending`).	String
transferDetails.transferStatus	Status da transferência (por exemplo, `completed`).	String

Webhooks

A API Grafeno também oferece suporte para webhooks, permitindo a automação do processo de aprovação ou rejeição de transferências. Quando uma transferência é criada, um webhook pode ser configurado para enviar notificações a um endpoint especificado, facilitando a integração e a resposta em tempo real às operações financeiras.

Utilizando a API de transferências da Grafeno, você pode simplificar e automatizar suas transações financeiras, garantindo maior eficiência, segurança e integração em seus processos de gestão financeira.

Para acessar a referência de notificações da API de transfers, clique aqui: Webhooks - Transferências.