跳到主要内容

执行手动 PIX 异步转账

请求​

ENDPOINT
/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer
MÉTODO
POST
请求体

{
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "pix_transfer_type": "manual",
    "target_account": {
      "account_branch": "0001",
      "account_digit": "1",
      "account_number": "2983779",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "36188081866",
      "owner_name": "USER PF LIMIT LEDGER",
      "owner_person_type": "natural"
    },
    "pix_message": "Bom dia", 
    "transaction_amount": 500.00,
    "schedule_date": "2021-08-04"
}

请求体参数​

字段类型描述字符数
request_control_key *uuidv4用于查询所发请求的 UUID4。36
pix_transfer_type *stringPIX 有不同的发起类型："manual" 表示用户需发送目标账户和来源账户字段；"key" 表示用户需发送收款方的 PIX 密钥（目标账户）和来源账户数据。6
target_account *Object目标账户 - 仅在 "manual" 类型交易中发送。target_account 对象
pix_messagestring随 PIX 发送的可选消息。140
transaction_amount *float交易金额。20
schedule_datedate交易调度日期（如未发送，则在批准时立即执行转账）。10

target_account 对象​

字段类型描述字符数
account_branch *string支行号。4
account_digit *string账号校验位。1
account_number *string账号。8
owner_document_number *string账户持有人的 CPF 或 CNPJ（仅数字）。14
owner_name *string账户持有人姓名。120
account_type *string账户类型，可为 checking_account、deposit_account、guaranteed_account、investment_account、saving_account。20
owner_trading_namestring法人的商业名称。仅用于 CNPJ。10
ispb *string在巴西中央银行储备转账系统中识别银行的八位代码。8
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"
  }
}