Pix Schedule Completion Webhook

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

Warning!

QI Tech webhooks should not be mapped in a restrictive way. Additional fields may be included in the webhook payloads 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 of webhook dispatch	20
transaction_amount	number	Transfer amount	10
target_account	object	Schedule destination account	target_account object
schedule_transfers	array	List of transfer attempts performed by the schedule	list of schedule_transfer object
schedule_status	string	Schedule status	schedule_status enumerator
schedule_key	string	Unique schedule identification key	36
schedule_date	string	Date on which the transaction will be performed	10
request_control_key	uuidv4	Unique request identification key used by the client in uuid v4 format	36
rejection_info	object	Object with information about the rejection event
rejection_reason	string	Reason for rejection	rejection_reason enumerators
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	Schedule creation date and time	20

Pix Schedule Status

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

Schedule Transfer Object

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

Pix Transfer Status Enumerator

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

target_account Object

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	Account holder name	150
owner_person_type	enumerator	Identifier indicating whether the account owner is a natural or legal person	owner_person_type enumerator
owner_name	string	Account holder name	150
account_type	enumerator	Account type	account_type enumerator
ispb	string	Eight-digit code that identifies banks in the Central Bank reserve transfer system	8
pix_key	string	Schedule target pix key	100

owner_person_type Enumerator

Enum	Description
natural	Natural person
legal	Legal person

account_type Enumerator

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

rejection_reason Enumerators

Enumerator	Description
target_creation_error	Error in schedule creation
limit_date_for_approval_surpassed	Approval deadline surpassed
limit_date_for_batch_approval_surpassed	Batch approval deadline surpassed
max_tries_exceeded	Maximum number of attempts exceeded
rejection_by_transfer	Rejection by transfer
target_change	Change in destination account
invalid_pix_key	Invalid Pix key
max_token_validation_attempts_exceeded	Maximum number of token validation attempts exceeded
error_sending_token	Error sending token
max_token_validation_attempts_exceeded_for_batch	Maximum number of token validation attempts for batch exceeded