跳到主要内容

申请 Pix 转账

Request​

ENDPOINT
/baas/pix_transfer
MÉTODO
POST

手动 Pix - 使用银行数据的转账​

Request Body

{
    "pix_transfer_type": "manual",
    "source_account": {
        "account_branch": "0001",
        "account_digit": "2",
        "account_number": "2359934",
        "owner_document_number": "09080702000105"
    },
    "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": 45,
    "message": "Mensagem pix"
}


Body Params​

字段类型描述字符数
pix_transfer_type *stringPix 有不同的发起类型，"manual"模式下用户需发送目标账户和来源账户字段，"key"模式下用户需发送收款人 Pix 密钥（目标账户）和来源账户信息。10
source_account *Object来源账户。Objeto source_account
target_accountObject目标账户 - 仅在"manual"类型的交易中发送。Objeto target_account
transaction_amount *string转账金额。10

Objeto source_account​

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

Objeto 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
ispbstring八位代码，用于标识巴西央行储备转账系统中的银行。10

Response​

STATUS
200
Response Body: 手动转账
{
    "data": {
        "fee_amount": 5.0,
        "pix_message": "",
        "pix_transfer_key": "fde0f4b4-8a8a-4ae2-a179-2398f434881a",
        "transfer_purpose": "transfer",
        "transaction_amount": 15.0,
        "end_to_end_id": "E324025022024040400378WsKzFgIuUg",
        "target_account": {
            "document_number": "***.698.79*-**",
            "financial_institution": "CAIXA ECONOMICA FEDERAL"
        },
        "source_account": {
            "account_number": "1314358",
            "account_digit": "0",
            "account_brach": "0001",
            "account_type": "checking",
            "owner_name": "Bem demais",
            "owner_document_number": "90477655000148"
        }
    },
    "operation_key": "06426df6-fe8e-4fe0-84b7-75d7199c3a34",
    "status": "pending_approval",
    "event_datetime": "2024-04-03 21:37:06"
}

使用 Pix 密钥进行 Pix 转账​

Request Body

{
    "pix_transfer_type": "key",
    "source_account": {
        "account_branch": "0001",
        "account_digit": "2",
        "account_number": "2359934",
        "owner_document_number": "09080702000105"
    },
    "pix_key": "teste@pix.com",
    "transaction_amount": 45,
    "end_to_end_id": "E32402502202404040038Cs4oXRAOe98",
    "message": "olá, mundo!"
}


Body Params​

字段类型描述字符数
pix_transfer_type *stringPix 转账类型（key）-
source_account *Object来源账户。Objeto source_account
pix_keyObjectPix 密钥-
transaction_amount *string转账金额。10
end_to_end_idstringPix 交易的幂等密钥 - 在 Pix 密钥查询中返回。32

Objeto source_account​

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

Response​

STATUS
200
Response Body: 使用 Pix 密钥的转账
{
  "operation_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "status": "pending",
  "event_datetime": "2021-08-04 20:05:54",
  "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
  }
}

Pix QRCode 转账​

用于支付 Pix QR Code 的交易数据必须通过 Pix QR Code 解码 获取，使用 Pix 复制粘贴 URI。

I - "end_to_end_id"字段必须与动态 QR Code 解码返回的值相同。

II - "transaction_amount"字段填写动态 QR Code 解码的"qr_code_data.amount"字段返回的相同值；

III - 将"pix_transfer_type"字段更改为相应的枚举值（static_qr_code 或 dynamic_qr_code），以请求付款。

IV - "receiver_conciliation_id"字段必须与动态 QR Code 解码返回的值相同。

Request Body
{
    "pix_transfer_type": "dynamic_term",
    "source_account": {
        "account_branch": "0001",
        "account_digit": "2",
        "account_number": "2359934",
        "owner_document_number": "09080702000105"
    },
    "pix_key": "chave_pix_retornada",
    "receiver_conciliation_id": "27f6e293-7794-40a7-84e8-c5bf97ece57a",
    "end_to_end_id": "E32402502202304031417pknxDsRrUqM",
    "transaction_amount": 45
}

Body Params​

字段类型描述字符数
pix_transfer_type *string转账类型指示符（qrcode）10
source_account *Object来源账户。Objeto source_account
pix_keyObjectPix 密钥-
transaction_amount *string转账金额。10
receiver_conciliation_idstring收款人对账标识 - 通过 QrCode 解码获取。32
end_to_end_idstringPix 交易的幂等密钥 - 通过 QrCode 解码返回。32
pix_transfer_keystringPix 交易的幂等密钥 - 仅在转账类型为"key"时发送。10

Objeto source_account​

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

Response​

STATUS
200
Response Body: 使用 QrCode 的转账
{
  "operation_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "status": "pending",
  "event_datetime": "2021-08-04 20:05:54",
  "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
  }
}