Consult TED

Request

ENDPOINT

/account/ACCOUNT_KEY/ted/TED_KEY/TED_DIRECTION

METHOD

GET

Request Path Params

Field	Type	Description	Characters
ted_direction *	string	Filter to indicate whether a transaction is inbound or outbound.	Enum ted_direction
account_key *	uuidv4	Unique identification key of the QI account.	36
ted_key *	uuidv4	Unique identification key of the TED transfer.	36

Enumerators ted_direction

Enumerator	Translation
incoming	entrada
outgoing	saída

Attention

Viewing a transfer will only be permitted if the requester has permissions on the outgoing account for transactions with a ted_direction of outgoing, or has permissions on the incoming account for transactions with a ted_direction of incoming. Otherwise, a not found error will be returned.

Response

STATUS

200

Response Body: Rejected Transfer (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "rejected",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "target_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {
    "refusal_code": 1,
    "enumerator": "conta_destinatario_encerrada",
    "description": "Conta Destinatária do Crédito Encerrada"
  }
}

Response Body: Transfer Sent (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "sent",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "target_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {}
}

Response Body: Transfer Received (incoming)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "received",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "source_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {}
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in Portuguese",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
404	TED000XXX	Outgoing TED Not Found	Ted key {ted_key} was not found	Transferência Ted de saída com chave {ted_key} não foi encontrada.
404	TED000XXX	Incoming TED Not Found	Ted key {ted_key} was not found	Transferência Ted de entrada com chave {ted_key} não foi encontrada.