通过 PIX 密钥执行异步转账

请求

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

MÉTODO

POST

请求体

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_type": "key",
  "target_pix_key": "pix@qitech.com.br",
  "pix_message": "Bom dia", 
  "transaction_amount": 500.00,
  "end_to_end_id": "E3240250220211022203051750897529",
  "schedule_date": "2021-08-04"
}

路径参数

字段	类型	描述	字符数
`account_key`	uuidv4	账户的唯一密钥。	36
`alias_key`	uuidv4	Alias 的唯一密钥。	36

请求体参数

字段	类型	描述	最大字符数
`request_control_key` *	uuidv4	用于查询所发请求的 UUID4。	36
`pix_transfer_type` *	string	PIX 有不同的发起类型："manual" 表示用户需发送目标账户和来源账户字段；"key" 表示用户需发送收款方的 PIX 密钥（目标账户）和来源账户数据。	6
`transfer_time` *	string	交易同步性信息，用于定义交易的处理时机。若为 "synchronous"，交易将立即执行，但受每分钟最大交易数限制。若为 "asynchronous"，交易将适时处理。	200
`target_pix_key` *	string	将接收交易的 PIX 密钥。	200
`pix_message` *	string	随 PIX 发送的可选消息。	140
`transaction_amount` *	float	交易金额。	20
`end_to_end_id`	string	在巴西中央银行中唯一标识交易或查询的密钥。示例：E3240250220210615135810450327042。	32
`schedule_date`	date	交易调度日期（如未发送，则在批准时立即执行转账）。	10

HTTP Status 202 Accepted

在异步 PIX 中，所有交易都返回 http status 202 Accepted，PIX 请求不应重试。在此场景中，交易将适时执行，并通过交易更新 Webhook 进行更新。还可以通过端点 /account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer/PIX_TRANSFER_KEY 查询交易状态。

响应

STATUS

202 Accepted

响应体

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "pending_confirmation",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

400

响应体：无效请求体

{
  "data": {
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {},
    "code": "LEG000069"
  }
}

请求​

路径参数​

请求体参数​

响应​

请求

路径参数

请求体参数

响应