v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Transferência para Terceiros

Realize uma transferência para terceiros via TED ou PIX

post/transfer_requests

Headers

Request-Timestring date-time required

Timestamp do momento que enviar a requisição de assinatura digital (RSA)

Signaturestring required

Assinatura digital validada

Request body

scheduled_datestring date

Data para agendar o PIX (AAAA-MM-DD)

transfer_typestring required

Tipo de transferência, "ted", "pix" ou "institucional".

amount_centsinteger required

Valor em centavos. Valor mínimo 2 centavos

descriptionstring

Descrição da transferência que irá aparecer no comprovante

check_payerstring

Insira o documento (CPF ou CNPJ) do destinatário para validar se é o mesmo identificado através da chave PIX utilizada na transferência. Caso o documento enviado neste parâmetro seja diferente do cadastrado na chave PIX, a chamada retornará um erro.

end_to_end_idstring

ID único do BACEN para rastreamento da transação Pix

conciliation_idstring

ID opcional para rastreamento interno da transação. <br> Limite de 35 caracteres/Não aceita caractere especial.

qrcode_typestring

Tipo do QR Code

external_referencestring

Referência ou identificador externo da transferência. Não aparece no comprovante, apenas no retorno da requisição e no painel Alia.

histstring

Histórico da Transação. Obrigatório se transfer_type = institucional.

citstring

Código Identificador de Transferência. Obrigatório se transfer_type = institucional.

reason_codestring

Código da Finalidade da Transferência. Opcional — Se transfer_type = institucional.

Response

202

transfer_request_idstring

created_atstring

amount_centsinteger

transfer_typestring

end_to_end_idstring

external_referencestring

receipt_urlstring

statusstring

Example response

{
  "transfer_request_id": "0321A2977E7D4C199AF26AE5C74220EA",
  "created_at": "2023-02-15T21:50:45-03:00",
  "amount_cents": 2,
  "transfer_type": "pix",
  "end_to_end_id": "E1511197520230216005028cd18c6d3d",
  "external_reference": "T002",
  "receipt_url": "https://comprovantes.iugu.com/0321a297-7e7d-4c19-9af2-6ae5c74220ea-e3049a",
  "status": "done"
}