Transação Pix por Chave Pix
Request Manual
ENDPOINT
/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer
MÉTODO
POSTRequest Body
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"pix_transfer_type": "key",
"target_pix_key": "target_pix_key@email.com",
"transaction_amount": 500.65,
"end_to_end_id": "E73856642202309201429bZKfklNlbwu",
"pix_message": "Ola Mundo"
}
Body Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
request_control_key * | string | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
pix_transfer_type * | enumerador | Tipo do pix a ser realizado. Para o caso de transferência por chave deve ser key | "key" |
target_pix_key * | string | Chave pix da conta a ser enviada a transação | 100 |
transaction_amount * | number | Valor da transferencia | 10 |
end_to_end_id * | string | Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key" | 32 |
pix_message | string | Mensagem a ser enviada junto à transferência Pix | 140 |
Aviso
Um end_to_end_id
deve ser enviado referente
á consulta de chave.
Aviso
O end_to_end_id
da consulta deve ter sido feito em nome do alias que solicitará a movimentação!
Aviso
Um end_to_end_id
só pode ser utilizado para uma única transferência, não importando se tenha sido bem sucedida ou não.
Response
STATUS
201Response Body: Transferência Enviada
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"alias_key": "68908c98-59cb-4fbf-9321-5d223ec78376",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"pix_transfer_status": "sent",
"created_at": "2021-10-22T20:30:23.459Z"
}