跳到主要内容

安排 PIX 转账

遵循与 PIX 转账相同的原则，主要区别在于需要发送 schedule_date，届时您将收到 schedule_key。

Request​

ENDPOINT
/baas/pix_transfer
MÉTODO
POST
Request Body: 手动转账
    {
        "pix_transfer_type": "manual",
        "source_account": {
            "account_branch": "0001",
            "account_digit": "2",
            "account_number": "2359934",
            "owner_document_number": "09080702000105"
        },
        "schedule_date": "2023-08-24",
        "target_account": {
              "bank_code": "104",
              "account_branch": "0001",
              "account_digit": "4",
              "account_number": "6717606",
              "owner_document_number": "60744463000190",
              "owner_name": "Qi Tech",
              "account_type": "checking",
              "ispb": "32402502"
         },
        "transaction_amount": 15
    }

Response​

STATUS
200
Response Body: 手动转账

{
  "data": {
      "operation_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "status": "pending",
      "event_datetime": "2021-08-04 20:05:54",
      "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "pix_transaction": {
        "pix_message": "",
        "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
        "transaction_amount": 1891268.97,
        "source_account": {
          "account_branch": "0001",
          "account_digit": "3",
          "account_number": "24339",
          "owner_document_number": "32402502000135",
          "owner_name": "Qi Tech",
          "account_type": "checking"
        },
        "target_account": {
          "target_account": "78340-6",
          "financial_institution_code": "329",
          "owner_document_number": "32402502000135",
          "owner_name": "QI Tech",
          "target_account_type": "checking_account",
          "owner_person_type": "legal",
          "trading_name": "QITech"
        },
        "fee_amount": 0,
        "schedule_date": "2020-08-04"
      }
    }
}

Body Params​

字段类型描述字符数
pix_transfer_type *stringPIX 有不同的发起类型，"manual" 为用户发送目标账户和来源账户字段，"key" 为用户发送收款方 PIX 密钥（目标账户）和来源账户数据。10
source_account *Object来源账户。source_account 对象
target_accountObject目标账户 - 仅在 "manual" 类型交易中发送。target_account 对象
transaction_amount *string转账金额。10
schedule_datedate交易预约日期（如未发送，转账将在审批时立即执行）。10
receiver_conciliation_idstring收款方对账标识。10
is_chargebackstringPIX 交易退款标识（布尔值 True 或 False）。10
requester_document_identification *string请求转账用户的 CPF。10
pix_transfer_keystringPIX 交易的幂等密钥 - 仅在转账类型为 "key" 时发送。10
chargeback_amountstring退款金额 - 此字段仅在退款时发送，并免除 "transaction_amount" 字段的必填要求。10
chargeback_other_reasonstring退款原因（仅在退款时发送）。10
chargeback_messagestring用户在退款时插入消息的字段（仅在退款时发送）。10

source_account 对象​

字段类型描述字符数
account_branch *string机构号。0
branch_digitstring机构检验位。0
account_digit *string账户检验位。0
account_number *string账户号。0
owner_document_number *string账户持有人的 CPF 或 CNPJ（仅数字）。0

target_account 对象​

字段类型描述字符数
account_branch *string机构号。10
account_digit *string账户检验位10
account_number *string账户号。10
owner_document_number *string账户持有人的 CPF 或 CNPJ（仅数字）。10
owner_name *string账户持有人姓名。10
account_type *string账户持有人的 CPF 或 CNPJ（仅数字）。10
trading_namestring法人实体的商业名称。10
ispbstring识别巴西支付系统转账准备金银行的八位代码。10

Response​

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