TED Schedule Completion Webhook

After completing a TED schedule, a webhook will be sent to the integrating partner with the result.

Attention!

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.ted.ted_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_batch_key": null,
    "schedule_status": "sent",
    "target_account": {
      "account_branch": "0001",
      "account_digit": "8",
      "account_number": "1234567",
      "owner_document_number": "***91111***",
      "owner_person_type": "natural",
      "owner_name": "Conta manual geral",
      "account_type": "checking_account",
      "ispb": "99999004"
    },
    "transaction_amount": 2.0,
    "rejection_info": null,
    "schedule_date": "2024-07-10",
    "updated_at": "2024-07-10T16:19:38Z",
    "created_at": "2024-06-10T11:17:28Z",
    "schedule_transfers": [
      {
        "request_control_key": "12723821-41d5-496b-b66c-fb7188f50fc1",
        "ted_key": "91028dfa-43a2-4665-adf2-0bd4571f6f0d",
        "created_at": "2024-07-10T16:19:38Z",
        "ted_status": "sent",
        "fee_amount": 2.00
      }
    ]
  }
}

Request Body: Schedule Completed and Rejected

{
  "webhook_type": "baas.ted.ted_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_batch_key": null,
    "schedule_status": "sent",
    "target_account": {
      "account_branch": "0001",
      "account_digit": "8",
      "account_number": "1234567",
      "owner_document_number": "***91111***",
      "owner_person_type": "natural",
      "owner_name": "Conta manual geral",
      "account_type": "checking_account",
      "ispb": "99999004"
    },
    "transaction_amount": 2.0,
    "rejection_info": {
      "error_code": "TED000103",
      "error_description": "The maximum number of failed transfer attempts has been reached",
      "error_translation": "Número máximo de tentativas de transferência foi atingida",
      "rejection_reason": "max_tries_exceeded"
    },
    "schedule_date": "2024-07-10",
    "updated_at": "2024-07-10T16:19:38Z",
    "created_at": "2024-06-10T11:17:28Z",
    "schedule_transfers": [
      {
        "ted_key": "907e38c5-5700-492f-a181-8f651317458b",
        "created_at": "2024-07-10T16:19:38Z",
        "ted_status": "rejected",
        "fee_amount": 2.00
      },
      {
        "ted_key": "356f8855-8f8d-4aaa-8e8c-1287e363d143",
        "created_at": "2024-07-10T17:19:38Z",
        "ted_status": "rejected",
        "fee_amount": 2.00
      },
      {
        "ted_key": "c51cc7ee-d966-4bbb-8405-4850b90b43f8",
        "created_at": "2024-07-10T18:19:38Z",
        "ted_status": "rejected",
        "fee_amount": 2.00
      }
    ]
  }
}

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 the webhook sending	20
request_control_key	uuidv4	Unique identification key for the request used by the client in uuid v4 format.	36
schedule_key	string	Unique identification key for the schedule	36
schedule_batch_key	string	Unique identification key for the schedule batch	36
schedule_status	string	Status of the schedule	Enumerator schedule_status
target_account	object	Target account for the schedule	Object target_account
transaction_amount	number	Transfer amount	10
schedule_transfers	array	List of transfer attempts made by the schedule	list of Object schedule_transfer
schedule_date	string	Date when the transaction will be executed.	10
rejection_info	object	Object with information about the rejection event
updated_at	string	Date and time of the last schedule update.	20
created_at	string	Date and time of schedule creation.	20

Ted Schedule Status

Enumerator	Description
scheduled	Transaction scheduled
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
waiting_batch_approval	Schedule created and linked to a batch waiting for two-factor authentication approval

Schedule Transfer Object

Field	Type	Description	Characters
ted_key	uuidv4	Unique identification key for the TED transfer in QI system.	36
ted_status	string	Transaction status.	Enumerator ted_status
fee_amount	number	Transfer amount	10
created_at	string	Date and time of transaction creation	20

Ted Status Enumerator

Enumerator	Description
sent	Transaction sent successfully. Final state
rejected	Transaction rejected during execution. Final state
pending	Transaction pending completion. Transitory 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	Name of the account holder	150
owner_person_type	enumerator	Identifier whether the owner of the sent account is a natural or legal person	Enumerator owner_person_type
owner_name	string	Name of the account holder	150
account_type	enumerator	Type of account	Enumerator account_type
ispb	string	Eight-digit code that identifies banks in the Central Bank's reserve transfer system	8

owner_person_type Enumerator

Enum	Description
natural	Natural person
legal	Legal person

account_type Enumerator

Enumerator	Translation
checking_account	checking account
deposit_account	deposit account
guaranteed_account	guarantee account
investment_account	investment account
payment_account	payment account
saving_account	savings account