Pix Scheduling completion webhook

After the completion of a Pix schedule, a webhook will be sent to the integration partner with the result.

Warning!

QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in the payloads of the webhooks returned by our APIs.

Webhook Request Body

Request Body: Schedule Completed and Sent

{
  "webhook_type": "baas.pix_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "created_at": "2024-07-10T16:17:28Z",
    "pix_message": null,
    "rejection_info": null,
    "rejection_reason": null,
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_date": "2024-07-10",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_status": "sent",
    "schedule_transfers": [
      {
        "created_at": "2024-07-10T16:19:33Z",
        "end_to_end_id": "E3240250220240710161922sSHNf8BjI",
        "pix_transfer_key": "427b70cd-73b0-45d1-bb4a-97f50f605022",
        "pix_transfer_status": "sent"
      }
    ],
    "target_account": {
      "account_branch": "0001",
      "account_digit": "8",
      "account_number": "1234567",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "***91111***",
      "owner_name": "Conta manual geral",
      "owner_person_type": "natural",
      "pix_key": null,
      "receiver_conciliation_id": null
    },
    "transaction_amount": 2.0,
    "updated_at": "2024-07-10T16:19:38Z"
  }
}

Request Body: Schedule Completed and Rejected

{
  "created_at": "2024-07-11T16:03:54Z",
  "pix_message": null,
  "rejection_info": {
    "error_code": "PSC000030",
    "error_description": "The maximum amount of pix transfer attempts has been reached",
    "error_translation": "A maxima quantidade de retentativas de transacao pix foi atingida",
    "rejection_reason": "max_tries_exceeded"
  },
  "rejection_reason": null,
  "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de0008",
  "schedule_date": "2024-07-11",
  "schedule_key": "8b262d82-3fc6-40f0-bfe5-bf18556ededb",
  "schedule_status": "rejected",
  "schedule_transfers": [
    {
      "created_at": "2024-07-11T16:04:21Z",
      "end_to_end_id": "E32402502202407111604ffoPVrGebI0",
      "pix_transfer_key": "c2c4e064-e684-450b-add5-07fb1efe8991",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:08:33Z",
      "end_to_end_id": "E32402502202407111608TQ3C4vRPRPk",
      "pix_transfer_key": "c30254db-86b2-4d8a-be01-29fa0d93ae92",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:09:20Z",
      "end_to_end_id": "E32402502202407111609zSUQQOvmMV6",
      "pix_transfer_key": "1a329248-fc39-4b49-9b95-8f1c1bb10c8b",
      "pix_transfer_status": "rejected"
    }
  ],
  "target_account": {
    "account_branch": "0001",
    "account_digit": "8",
    "account_number": "1234567",
    "account_type": "checking_account",
    "ispb": "99999004",
    "owner_document_number": "***91111***",
    "owner_name": "Conta manual geral",
    "owner_person_type": "natural",
    "pix_key": null,
    "receiver_conciliation_id": null
  },
  "transaction_amount": 2.0,
  "updated_at": "2024-07-11T16:09:21Z"
}

Webhook Body Param

Field	Type	Description	Max. Characters
webhook_type	string	An enumerator that defines the type of event being reported	23
webhook_datetime	string	Date and time the webhook was sent	20
transaction_amount	number	Transfer amount	10
target_account	object	Destination account of the schedule	Object target_account
schedule_transfers	array	List of transfer attempts made by the schedule	list of Object schedule_transfer
schedule_status	string	Schedule status	Enumerator schedule_status
schedule_key	string	Unique schedule identification key	36
schedule_date	string	Date the transaction is to be performed	10
request_control_key	uuidv4	Unique identification key for the request used by the client in uuid v4 format	36
rejection_info	object	Object with information about the rejection event
rejection_reason	string	Rejection reason	100
pix_message	string	Message to be sent along with the Pix transfer	140
updated_at	string	Date and time of the last schedule update	20
created_at	string	Date and time of schedule creation	20

Pix Schedule Status

Enumerator	Description
scheduled	Scheduled transaction
sent	Schedule completed and successfully sent. Final status
rejected	Schedule rejected during creation or execution. Final status
cancelled	Schedule canceled by customer request. Final status
pending_2fa_approval	Pending two-factor authentication approval
pending_creation	Schedule in the process of creation (Transitional state for batch scheduling)
waiting_batch_approval	Schedule created and linked to a batch awaiting two-factor authentication approval

Schedule Transfer Object

Field	Type	Description	Characters
pix_transfer_key	uuidv4	Unique identification key for the Pix transfer in the QI system	36
end_to_end_id *	string	Idempotency key for a Pix transaction within the SPI (Instant Payment System)	32
pix_transfer_status	string	Transaction status	Enumerator pix_transfer_status
created_at	string	Date and time the transaction was created	20

Enumerator Pix Transfer Status

Enumerator	Description
sent	Transaction successfully sent. Final status
rejected	Transaction rejected during execution. Final status
pending	Transaction pending conclusion. Transitional state

Object target_account

Field	Type	Description	Characters
account_branch	string	Account branch	6
account_digit	string	Account digit	1
account_number	string	Account number	20
owner_document_number	string	CPF or CNPJ (numbers only) of the account holder	14
owner_name	string	Name of the account holder	150
owner_person_type	enumerator	Identifier indicating whether the account owner is an individual or legal entity	Enumerator owner_person_type
account_type	enumerator	Account type	Enumerator account_type
ispb	string	Eight-digit code that identifies banks in the Central Bank's reserve transfer system	8
pix_key	string	Target pix key of the schedule	100

Enumerator owner_person_type

Enumerator	Description
natural	Individual
legal	Legal entity

Enumerator account_type

Enumerator	Description
checking_account	Checking Account
salary_account	Salary Account
saving_account	Savings Account
payment_account	Payment Account