手动 PIX 交易

请求

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

MÉTODO

POST

请求体

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "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"
}

请求体参数

字段	类型	描述	字符数
`request_control_key` *	string	客户使用的请求唯一标识密钥，格式为 uuid v4。	36
`pix_transfer_type` *	enumerador	要执行的 PIX 类型。对于手动转账，必须为 manual。	"manual"
`target_account` *	Object	目标账户 - 仅在 "manual" 类型交易中发送。	target_account 对象
`transaction_amount` *	number	转账金额。	10
`pix_message`	string	随 PIX 转账发送的消息。	140

提示

一个 end_to_end_id 只能用于一次转账，无论转账是否成功。

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`*	enumerador	账户类型。	account_type 枚举值
`ispb` *	string	在巴西中央银行储备转账系统中识别银行的八位代码。	8

account_type 枚举值

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

响应

STATUS

201

响应体：已发送转账

{
  "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"
}

STATUS

202

信息

如果返回的 pix_transfer_status 为 pending 状态，则不应重试 PIX 请求。该转账将被重新处理。需要通过 PIX 转账查询来检查转账状态。

响应体：待处理转账

{
  "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": "pending",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

4XX

响应体：已拒绝转账

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {
    "pix_transfer_data": {
      "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": "rejected",
      "created_at": "2021-10-22T20:30:23.459Z"
    }
  }
}

STATUS

4XX

响应体：错误

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP 状态码	QI 错误码 `code`	标题 `title`	英文描述 `Description`	葡文描述 `translation`
400	QIT000001	Bad Request	Schema Error	Erro de Schema
406	PXT000103	request_control_key must be a valid uuid v4 string	request_control_key was not accepted for not being a valid uuid v4 string	request_control_key não foi aceito por não ser uma palavra uuid v4 válida
400	PXT000048	Bad Request	Emoji not allowed in pix message.	Emoji não é permitido na mensagem pix.
400	PXT000104	Invalid Transaction Amount	Transaction amount of {transaction_amount} is not valid. It must be a positive value with at maximum 2 decimal places	O valor de transação {transaction_amount} não é válido. Deve ser um valor positivo com no máximo duas casas decimais
404	PXT000004	Account not found	Account not found for: {account_datum}	Conta não encontrada para: {account_datum}
400	PXT000003	Account is Closed	Account {account_key} is closed.	Conta {account_key} está fechada.
422	PXT000092	Invalid Account Type	Pix is not yet implemented for non-checking or non-escrow account types	Transações Pix não estão implementadas para conta que não sejam escrow ou livres
403	PIT000001	User is not allowed to do this transaction		Usuário não tem autorização para fazer essa transação
400	PXT000010	Account is Blocked	Account {account_key} is blocked.	Conta {account_key} está bloqueada.
400	PIT000003	Bad Request	Insufficient account balance for transfer and fee amount.	Saldo de conta insuficiente para a transferência e a taxa.
400	PXT000118	Requester is not Pix Participant	The requester sent an alias key but is not a indirect pix participant	O requisitante enviou uma alias key no entanto não é um participante do pix indireto
404	PXT000120	Alias sent not found	Alias key attached to this account not found	Alias key vinculada à conta não encontrada
406	PXT000105	Invalid end_to_end_id	The end_to_end_id sent {end_to_end_id} is not valid.	O end_to_end_id enviado {end_to_end_id} não é válido.
400	PXT000108	Bad Request	Billing account closed or blocked	Conta de cobrança encerrada ou bloqueada
400	PXT000079	Bad Request	Insufficient billing account balance for fee.	Saldo de conta de cobrança insuficiente para a taxa.
400	PIT000004	Bad Request	Transaction amount is over limit.	O total da transferência é superior ao limite.
400	PXT000109	Bad Request	request_control_key {request_control_key} already in use	request_control_key {request_control_key} já utilizada
400	PXT000129	SPI Error message	Message rejected by SPI-ICOM	Mensagem rejeitada pela SPI-ICOM
408	PXT000130	SPI Timeout Control	SPI Timeout Control	Controle de timeout no SPI
400	PXT000131	Receiver Internal Error	Cancelled transaction due to receiver's internal error	Transação interrompida devido a erro no PSP do Recebedor
400	PXT000132	Invalid Target Account Number	Target account number is invalid	Número da conta de destino é inexistente ou inválido
400	PXT000133	Blocked Target Account	Target account is blocked.	A conta de destino encontra-se bloqueada.
400	PXT000134	Closed Target Account	Target account is closed.	A conta de destino encontra-se encerrada.
400	PXT000141	Unrelated Beneficiary Document Number	Beneficiary document number is not that of target account owner.	CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino.
400	PXT000142	Invalid Beneficiary Document Number	Invalid beneficiary document number	CPF/CNPJ da conta de destino está incorreto.
403	PXT000144	Rejected Payment Order	Beneficiary's PSP has rejected payment order.	Ordem de pagamento foi rejeitada pelo banco recebedor.
503	PXT000157	Bacen Service Unavailable Error	Could not send the message to ICOM after 3 retries	Não pode enviar a mensagem para a ICOM depois de 3 tentativas

请求​

请求体参数​

target_account 对象​

account_type 枚举值​

响应​

请求

请求体参数

target_account 对象

account_type 枚举值

响应