Solicitar Agendamento de Transação Pix em Lote
A QI Tech oferece a possibilidade de realizar várias transações agendadas pix com uma única chamada. Nesse sistema os agendamentos são realizados de forma assíncrona. Caso na chamada inicial seja retornado um http status 4xx, nenhum dos agendamentos será realizado. Após a solicitação, o parceiro integrador receberá um webhook para cada **pix_schedule ** rejeitado no ato da criação.
Neste tipo de agendamento, é necessário a confirmação da programação de pagamento via token enviado à pessoa com poderes de aprovação de movimentação na conta credora.
A solicitação de agendamento Pix em lote por parceiros integradores configurados para a utilização de autenticação de
dois
fatores é realizada de forma similar ao descrito
em solicitar agendamento de_transação_pix_em_lote.
A diferença
ocorre na adição do objeto tfa_info
, contento informações sobre o aprovador da transferência e a forma de contato, e o
status de uma solicitação bem sucedida que será sempre pending_2fa_approval.
O evento de notificação para o envio de token
ao aprovador é baas.token_validation.pix_transfer.schedule.batch. É
possível personalizar a mensagem enviada.
Request
/account/ACCOUNT_KEY/pix_schedule_batch
{
"request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
},
"pix_schedules": [
{
"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",
"schedule_date": "2024-12-01"
},
{
"request_control_key": "c6804f35-101e-4702-8fbc-c2dbc4c2caea",
"pix_transfer_type": "manual",
"target_account": {
"account_branch": "0001",
"account_digit": "3",
"account_number": "12345678",
"owner_document_number": "32402502000135",
"owner_name": "Qi Tech",
"account_type": "checking_account",
"ispb": "32402502"
},
"transaction_amount": 500.65,
"pix_message": "Ola Mundo",
"schedule_date": "2024-12-01"
},
{
"request_control_key": "a6804f42-101e-4702-8fbc-c2dbc4c2caed",
"pix_transfer_type": "static_qr_code",
"transaction_amount": 500.65,
"end_to_end_id": "E73856642202309201429bZKfklNlbwu",
"receiver_conciliation_id": "REC00000000000000000000009459463343",
"target_pix_key": "target_pix_key@email.com",
"pix_message": "Ola Mundo"
}
]
}
Path Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_key | uuidv4 | Chave única de identificação da conta. | 36 |
Body Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
request_control_key * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4. | 36 |
pix_schedules * | array | Lista de objetos pix_schedule vinculados ao lote. | lista de Objeto pix_schedule |
tfa_info * | Object | Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato. | Objeto tfa_info |
Objeto tfa_info
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
approver_document_number * | string | Número de documento da pessoa aprovadora da conta. | 11 |
contact_type * | string | Forma de contato com a pessoa aprovadora da conta. | Enumerador contact_type |
Enumerador | Descrição |
---|---|
sms | Envio por Mensagem de Texto para telefone celular |
Envio por correio eletrônico |
Objeto pix_schedule
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
request_control_key * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4. | 36 |
pix_transfer_type * | enumerator | Tipo de transferência Pix. | Enumerador pix_transfer_type |
target_pix_key | string | Chave pix da conta a ser enviada a transação. | 100 |
receiver_conciliation_id | string | Identicação de conciliação do recebedor. | 35 |
target_account * | Object | Conta destino - Só deve ser enviada em transferências com pix_transfer_type do tipo manual. | Objeto target_account |
transaction_amount * | number | Valor da transferência. | 10 |
end_to_end_id | string | Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo). Esta chave é retornada na consulta de chave Pix. Só deve ser enviado se o pix_transfer_type for key, static_qr_code ou static_qr_code. | 32 |
pix_message | string | Mensagem a ser enviada junto à transferência Pix. | 140 |
Objeto target_account
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_branch * | string | Agência da conta. | 6 |
account_digit * | string | Dígito da conta. | 1 |
account_number * | string | Número da conta. | 20 |
owner_document_number * | string | CPF ou CNPJ (apenas números) do titular da conta. | 14 |
owner_name * | string | Nome do titular da conta. | 150 |
account_type * | enumerator | Tipo da conta. | Enumerador account_type |
ispb * | string | Base no CNPJ da instituição financeira (8 dígitos). | 8 |