Schedule Pix Transfer

It follows the same principle as Pix transfer, with the main difference being that you must send the schedule_date, and in this case, you will receive the schedule_key.

Request

ENDPOINT

/baas/pix_transfer

METHOD

POST

Manual

Request Body: Manual transfer

    {
        "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: Manual transfer

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

Chave

Request Body: Key transfer

        {
            "pix_transfer_type": "key",
            "source_account": {
                "account_branch": "0001",
                "account_digit": "2",
                "account_number": "2359934",
                "owner_document_number": "09080702000105"
            },
            "schedule_date": "2023-08-24",
            "end_to_end_id":	"E32402502202308231745g1goFJ577mp",
            "pix_key":"52720072800",
            "target_account": {
                  "bank_code": "104",
                  "account_branch": "0001",
                  "account_digit": "4",
                  "account_number": "6717606",
                  "owner_document_number": "60744463000190",
                  "owner_name": "Qi Tech",
                  "ispb": "32402502"
             },
            "transaction_amount": 15
        }

Response

STATUS

200

Response Body: Key transfer

{
  "data": {
    "end_to_end_id": "E32402502202308231825nkKhXiA9DEA",
    "fee_amount": 1,
    "pix_message": "",
    "pix_transfer_key": "c32ad14a-6bfe-43f4-b5a1-4f335dcdd543",
    "source_account": {
      "account_brach": "0001",
      "account_digit": "2",
      "account_number": "2359934",
      "account_type": "checking",
      "owner_document_number": "09080702000105",
      "owner_name": "VOVO LUCIA CONVENIENCIA LTDA"
    },
    "target_account": {
      "document_number": "***.951.18*-**",
      "financial_institution": "CAIXA ECONOMICA FEDERAL"
    },
    "transaction_amount": 15,
    "transfer_purpose": "transfer"
  },
  "event_datetime": "2023-08-23 15:25:36",
  "operation_key": "b37224f2-9a8c-4816-b446-acb213bfe5f0",
  "schedule_key": "c32ad14a-6bfe-43f4-b5a1-4f335dcdd543",
  "status": "pending_approval"
}

Body Params

Field	Type	Description	Characters
pix_transfer_type *	string	Pix has different types of initiation: "manual", where the user must send the destination and source account fields, and "key", where the user must send the Pix key fields of the receiver (destination account) and the source account details.	10
source_account *	Object	Source account.	Object source_account
target_account	Object	Destination account - Should only be sent in transactions of type "manual".	Object target_account
transaction_amount *	string	Transfer amount.	10
schedule_date	date	Scheduled date of the transaction (if not sent, the transfer is made at the time of approval).	10
receiver_conciliation_id	string	Receiver's conciliation ID.	10
is_chargeback	string	Flag identifying a Pix transaction refund (boolean True or False).	10
requester_document_identification *	string	CPF of the user requesting the transfer.	10
pix_transfer_key	string	Idempotency key of a Pix transaction - should only be sent if the transfer type is "key".	10
chargeback_amount	string	Refund amount - This field should be sent only in case of chargeback and excludes the requirement for the "transaction_amount" field.	10
chargeback_other_reason	string	Refund reason (This field should be sent only in case of chargeback).	10
chargeback_message	string	Field for the user to insert a message during the refund (This field should be sent only in case of chargeback).	10

Object source_account

Field	Type	Description	Characters
account_branch *	string	Branch number.	0
branch_digit	string	Branch digit.	0
account_digit *	string	Account digit.	0
account_number *	string	Account number.	0
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	0

Object target_account

Field	Type	Description	Characters
account_branch *	string	Branch.	10
account_digit *	string	Account digit.	10
account_number *	string	Account number.	10
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	10
owner_name *	string	Account holder's name.	10
account_type *	string	CPF or CNPJ (numbers only) of the account holder.	10
trading_name	string	Trade name for legal entities.	10
ispb	string	Eight-digit code that identifies banks in the Central Bank's reserve transfer system.	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\"}"
}