IntroduçãoReferência de APICentral de AjudaObter SuporteStatus page
Referência

PIX/TED Out

post
https://api.iugu.com/v1/transfer_requests

Realize uma transferência para terceiros via TED ou PIX

Body Params
date

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

string
required

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

int32
required

Valor em centavos. Valor mínimo 2 centavos

string

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

string

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.

string

Tipo do QR Code

string

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

string

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

string

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

receiver
object

Dados do destinatário da transferência. Utilize "name" limitação de 140 caracteres e "cpf_cnpj" quando a transferência for TED ou PIX para conta bancária.

string

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

string

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

string

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

Headers
date-time
required

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

string
required
Defaults to signature=

Assinatura digital validada

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated 5 months ago