Pular para o conteúdo principal

Efetuar Transferencia Assíncrona via Chave Pix

Request Normal

ENDPOINT
/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer
MÉTODO
POST
Request Body
{
"request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
"pix_transfer_type": "key",
"target_pix_key": "pix@qitech.com.br",
"pix_message": "Bom dia",
"transaction_amount": 500.00,
"end_to_end_id": "E3240250220211022203051750897529",
"schedule_date": "2021-08-04"
}

Request Path Params

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única da conta.36
alias_keyuuidv4Chave única do alias.36

Body Param

CampoTipoDescriçãoMax. Caracteres
request_control_key *uuidv4UUID4 para fins de consulta sobre a requisição feita.36
pix_transfer_type *stringO Pix possui diferentes tipos de iniciação, o "manual" onde o usuário deve enviar os campos da conta de destino e conta de origem e o "key" onde o usuário deve enviar os campos da chave Pix do recebedor (conta de destino) e os dados da conta de origem.6
transfer_time *stringInformação de sincronicidade da trasação, utilizada para definir quando a transação será processada. Caso seja "synchronous", a transação sera efetuada imediatamente, porém respeitando-se um limite maximo de transações por minuto. Ja se for "asynchronous", a transação será processada em um200
target_pix_key *stringChave Pix que irá receber a transação.200
pix_message *stringMensagem opcional que acompanhará o Pix140
transaction_amount *floatValor da transação realizada20
end_to_end_idstringchave de identificação única de uma transação ou consulta no Banco Central. Exemplo: E324025022021061513581045032704232
schedule_datedateData de agendamento da transação (caso não seja enviado a transferência é realizada no momento da aprovação).10
HTTP Status 202 Accepted

No pix assíncrono, toda transação retorna http status 202 Accepted, a solicitação de Pix não deve ser retentada. Neste cenário, a transação será efetuada oportunamente e será atualizada por meio do Webhook de Atualização de Transação. É possível ainda consultar o status da transação por meio do endpoint /account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer/PIX_TRANSFER_KEY.

Response

STATUS
202 Accepted
Response Body
{
"request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"pix_transfer_status": "pending_confirmation",
"created_at": "2021-10-22T20:30:23.459Z"
}

STATUS
400
Response Body: Invalid Request Body
{
"data": {
"title": "Bad Request",
"description": "Invalid request body.",
"translation": "Corpo da requisição inválido.",
"extra_fields": {},
"code": "LEG000069"
}
}