Pular para o conteúdo principal

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.

Request

ENDPOINT
/account/ACCOUNT_KEY/pix_schedule_batch
MÉTODO
POST
{
"request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
"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

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36

Body Params

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v4.36
pix_schedules *arrayLista de objetos pix_schedule vinculados ao lote.lista de Objeto pix_schedule

Objeto pix_schedule

CampoTipoDescriçãoCaracteres
request_control_key*uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v4.36
pix_transfer_type*enumeratorTipo de transferência Pix.Enumerador pix_transfer_type
target_pix_keystringChave pix da conta a ser enviada a transação.100
receiver_conciliation_idstringIdenticação de conciliação do recebedor.35
target_account *ObjectConta destino - Só deve ser enviada em transferências com pix_transfer_type do tipo manual.Objeto target_account
transaction_amount*numberValor da transferência.10
end_to_end_idstringChave 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_messagestringMensagem a ser enviada junto à transferência Pix.140

Objeto target_account

CampoTipoDescriçãoCaracteres
account_branch *stringAgência da conta.6
account_digit *stringDígito da conta.1
account_number *stringNúmero da conta.20
owner_document_number *stringCPF ou CNPJ (apenas números) do titular da conta.14
owner_name *stringNome do titular da conta.150
account_type*enumeratorTipo da conta.Enumerador account_type
ispb *stringBase no CNPJ da instituição financeira (8 dígitos).8

Enumerador account_type

EnumeradorDescrição
checking_accountConta Corrente
salary_accountConta Salário
saving_accountConta Poupança
payment_accountConta de Pagamentos

Enumerador pix_transfer_type

EnumeradorDescrição
manualPix utilizando os dados da conta destino. Obrigatório enviar target_account
keyPix utilizando uma chave pix. Obrigatório enviar target_pix_key. Recomendado enviar end_to_end_id da consulta de chave pix caso tenha sido realizada
static_qr_codePix utilizando um QR code estático. Obrigatório enviar o end_to_end_id retornado na decodificação do QR code
dynamic_qr_codePix utilizando um QR code dinâmico. Obrigatório enviar o end_to_end_id retornado na decodificação do QR code

Response

STATUS
201
Response Body: Agendamento em lote Aprovado
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"schedule_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"schedule_batch_status": "approved",
"created_at": "2021-10-22T20:30:23.459Z"
}

Enumerador schedule_batch_status

EnumeradorDescrição
createdAgendamento em lote criado
approvedAgendamento em lote aprovado
rejectedAgendamento em lote rejeitado
pending_2fa_approvalAgendamento em lote pendente de aprovação por autenticação de dois fatores
STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTP
status
Código QI
code
Título
title
Descrição (eng)
description
Descrição (ptbr)
translation
400QIT000001Bad Requestschema error descriptionSchema Inválido
404PSC000001Account not FoundAccount was not foundConta não encontrada
406PSC000002Invalid Uuidkey was not accepted for not being a valid uuid v4 stringkey não foi aceito por não ser uma palavra uuid v4 válida
400PSC000003Bad Requestpix_message can not be longer than 140 characterspix_message não pode ser maior que 140 caracteres
400PSC000004Bad RequestEmoji not allowed in pix messageEmoji não é permitido na mensagem pix
406PSC000005Invalid Transaction AmountTransaction amount of transaction_amount is not valid. It must be a positive value with at maximum 2 decimal placesO valor de transação transaction_amount não é válido. Deve ser um valor positivo com no máximo duas casas decimais
406PSC000006Invalid end_to_end_idThe end_to_end_id sent end_to_end_id is not validO end_to_end_id enviado end_to_end_id não é válido
400PSC000007Invalid date formatDates must be sent using format YYYY-MM-DDDatas devem ser enviadas no formato YYYY-MM-DD
400PSC000008Invalid Schedule DateSchedule date must be after current date for UTC-3Data de agendamento deve ser após a data atual em UTC-3
400PSC000009Account is ClosedAccount is closedConta está fechada
400PSC000010Account is BlockedAccount is blockedConta está bloqueada
422PSC000011Invalid Account TypePix is not yet implemented for non-checking or non-escrow account typesTransações Pix não estão implementadas para conta que não sejam escrow ou livres
403PSC000012User is not allowed to do this transactionUser is not allowed to do this transactionUsuário não tem autorização para fazer essa transação
400PSC000013Bad RequestFor Manual Pix Transfer Type a target account must be providedPara transação pix do tipo manual, uma conta destino deve ser fornecida
404PSC000014Inquiry Not FoundPix key inquiry was not foundPesquisa de chave pix não encontrada
400PSC000015Bad RequestPix key sent does match inquiry pix key. Verify if end_to_end_id sent is correctChave Pix enviada não condiz com consulta. Verifique se end_to_end_id enviado está correto
404PSC000016Account not foundNonexistent account in destination financial institutionConta inexistente na instituição financeira de destino
400PSC000017Target Account and Source Account must be differentTarget Account must not be the same as Source AccountA conta de destino não pode ser a mesma da conta de origem
409PSC000018Bad Requestrequest_control_key request_control_key already in userequest_control_key request_control_key já utilizada
400PSC000019Invalid TargetAccount does not have permission to transfer to the given target accountA conta não possui permissão para realizar transferências para a conta enviada
404PSC000020Decode Inquiry Not FoundQR Code decode inquiry not foundPesquisa e decodificação de QR code não encontrada
400PSC000021Bad RequestReceiver Conciliation Id sent does match decode inquiry receiver_conciliation_id. Verify if end_to_end_id sent is correctIdentificador de transação enviado não condiz com consulta. Verifique se end_to_end_id enviado está correto
400PSC000022Bad RequestDynamic Instant QR codes cannot be scheduled for paymentPagamentos de vencimento instantâneo não podem ter pagamento agendado
400PSC000023Bad RequestSchedule Date sent is after max payment date for target qr codeData de agendamento enviada é após a data máxima de pagamento para o qr code enviado
400PSC000024Bad RequestPix transfer type sent does match decode inquiry qr code type. Verify if end_to_end_id sent is correctTipo de transação pix enviado enviado não condiz com tipo de qr code da consulta. Verifique se end_to_end_id enviado está correto
400PSC000040Empty pix-schedule list receivedA list of pix schedules must be providedUma lista de agendamentos pix deve ser fornecida
409PSC000041Bad RequestOne or more request_control_key already in useUma ou mais request_control_key já está sendo utilizada
403PSC000045Requester not allowed to access this endpointRequester has no permission to perform pix transfers on this endpointRequester não possui permissão de realizar transações pix através deste endpoint