Solicitar Transferência Pix

Request

ENDPOINT

/baas/pix_transfer

MÉTODO

POST

Pix Manual - Transferência utilizando dados bancários

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

Campo	Tipo	Descrição	Caracteres
`pix_transfer_type` *	string	O Pix possui diferentes tipos de iniciação, o "manual" onde o usuário deve enviar os campos da conta de destino e conta de origem e o "key" onde o usuário deve enviar os campos da chave Pix do recebedor (conta de destino) e os dados da conta de origem.	10
`source_account` *	Object	Conta de origem.	Objeto source_account
`target_account`	Object	Conta destino - Só deve ser enviada em transações do tipo "manual".	Objeto target_account
`transaction_amount` *	string	Valor da transferencia.	10

Objeto source_account

Campo	Tipo	Descrição
`account_branch` *	string	Número Agência.
`branch_digit`	string	Dígito da Agência.
`account_digit` *	string	Dígito da conta.
`account_number` *	string	Número da conta.
`owner_document_number` *	string	CPF ou CNPJ (apenas números) do titular da conta.

Objeto target_account

Campo	Tipo	Descrição	Caracteres
`account_branch` *	string	Agência.	10
`account_digit` *	string	Dígito da conta	10
`account_number` *	string	Número da conta.	10
`owner_document_number` *	string	CPF ou CNPJ (apenas números) do titular da conta.	10
`owner_name` *	string	Nome do titular da conta.	10
`account_type` *	string	CPF ou CNPJ (apenas números) do titular da conta.	10
`ispb`	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central.	10

Response

STATUS

200

Response Body: Transferência manual

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

Transferência Pix utilizando Chave 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

Campo	Tipo	Descrição	Caracteres
`pix_transfer_type` *	string	Tipo de transferência Pix (key)	-
`source_account` *	Object	Conta de origem.	Objeto source_account
`pix_key`	Object	Chave pix	-
`transaction_amount` *	string	Valor da transferencia.	10
`end_to_end_id`	string	Chave de idempotência de uma transação Pix - é retornada na consulta de chave pix.	32

Objeto source_account

Campo	Tipo	Descrição
`account_branch` *	string	Número Agência.
`branch_digit`	string	Dígito da Agência.
`account_digit` *	string	Dígito da conta.
`account_number` *	string	Número da conta.
`owner_document_number` *	string	CPF ou CNPJ (apenas números) do titular da conta.

Response

STATUS

200

Response Body: Transferência por chave 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
  }
}

Transferência Pix QRCode

Os dados utilizados para realizção de uma transação de pagamento de um QR Code Pix devem ser obtidos através da decodificação do QR Code Pix, utilizando a URI do Pix Copia e Cola.

I - O campo “end_to_end_id” deve ser o mesmo valor retornado da decodificação do QR Code Dinâmico.

II - Informar no campo “transaction_amount“ o mesmo valor retornado no campo “qr_code_data.amount” da decodificação do QR Code Dinâmico;

III - Alterar o campo “pix_transfer_type” para o enumerador correspondente (static_qr_code ou dynamic_qr_code ), para solicitação do pagamento.

IV - O campo “receiver_conciliation_id” deve ser o mesmo valor retornado da decodificação do QR Code Dinâmico.

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

Campo	Tipo	Descrição	Caracteres
`pix_transfer_type` *	string	Indicador do tipo de transferência (qrcode)	10
`source_account` *	Object	Conta de origem.	Objeto source_account
`pix_key`	Object	Chave pix	-
`transaction_amount` *	string	Valor da transferencia.	10
`receiver_conciliation_id`	string	Identicação de conciliação do recebedor - Obtido através do decode do QrCode .	32
`end_to_end_id`	string	Chave de idempotência de uma transação Pix - é retornada na decodificação do QrCode.	32
`pix_transfer_key`	string	Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key".	10

Objeto source_account

Campo	Tipo	Descrição
`account_branch` *	string	Número Agência.
`branch_digit`	string	Dígito da Agência.
`account_digit` *	string	Dígito da conta.
`account_number` *	string	Número da conta.
`owner_document_number` *	string	CPF ou CNPJ (apenas números) do titular da conta.

Response

STATUS

200

Response Body: Transferência por 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
  }
}

Solicitar Transferência Pix

Request​

Pix Manual - Transferência utilizando dados bancários​

Body Params​

Objeto source_account​

Objeto target_account​

Response​

Transferência Pix utilizando Chave Pix​

Body Params​

Objeto source_account​

Response​

Transferência Pix QRCode​

Body Params​

Objeto source_account​

Response​

Request

Pix Manual - Transferência utilizando dados bancários

Body Params

Objeto source_account

Objeto target_account

Response

Transferência Pix utilizando Chave Pix

Body Params

Objeto source_account

Response

Transferência Pix QRCode

Body Params

Objeto source_account

Response