跳到主要内容

申请批量 Pix 交易预约

QI Tech 提供通过单次调用执行多个 Pix 定期交易的功能。在此系统中，预约以异步方式进行。如果初始调用返回 http status 4xx，则不会执行任何预约。申请后，集成合作伙伴将针对创建时被拒绝的每个 pix_schedule 收到一个 webhook。

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​

字段类型描述字符数
account_keyuuidv4账户的唯一标识键。36

Body Params​

字段类型描述字符数
request_control_key *uuidv4客户使用的请求唯一标识键，uuid v4 格式。36
pix_schedules *array关联到批次的 pix_schedule 对象列表。Objeto pix_schedule 列表

Objeto pix_schedule​

字段类型描述字符数
request_control_key*uuidv4客户使用的请求唯一标识键，uuid v4 格式。36
pix_transfer_type*enumeratorPix 转账类型。Enumerador pix_transfer_type
target_pix_keystring目标账户的 Pix 密钥。100
receiver_conciliation_idstring收款方对账标识。35
target_account *Object目标账户 - 仅在 pix_transfer_type 为 manual 时发送。Objeto target_account
transaction_amount*number转账金额。10
end_to_end_idstringSPI（即时支付系统）内 Pix 交易的幂等键。此键在 Pix 密钥查询中返回。仅当 pix_transfer_type 为 key、static_qr_code 或 static_qr_code 时发送。32
pix_messagestring随 Pix 转账发送的消息。140

Objeto target_account​

字段类型描述字符数
account_branch *string账户机构编号。6
account_digit *string账户数字。1
account_number *string账户号码。20
owner_document_number *string账户持有人 CPF 或 CNPJ（仅数字）。14
owner_name *string账户持有人姓名。150
account_type*enumerator账户类型。Enumerador account_type
ispb *string金融机构 8 位识别码（ISPB）。8

Enumerador account_type​

枚举值描述
checking_account支票账户
salary_account薪资账户
saving_account储蓄账户
payment_account付款账户

Enumerador pix_transfer_type​

枚举值描述
manual使用目标账户数据的 Pix。必须发送 target_account
key使用 Pix 密钥的 Pix。必须发送 target_pix_key。如果已执行，建议发送 Pix 密钥查询 的 end_to_end_id
static_qr_code使用静态 QR Code 的 Pix。必须发送 QR code 解码 返回的 end_to_end_id
dynamic_qr_code使用动态 QR Code 的 Pix。必须发送 QR code 解码 返回的 end_to_end_id

Response​

STATUS
201
Response Body: 批量预约已批准
{
  "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​

枚举值描述
created批量预约已创建
approved批量预约已批准
rejected批量预约已拒绝
pending_2fa_approval批量预约待双因素认证批准
STATUS
4xx
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
HTTP 代码
status		QI 代码
code		标题
title		描述（英文）
description		描述（葡文）
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