TED
Confira os eventos relativos a TED.
beta
Os eventos de TED disparam mensagens que comunicam ao destinatário movimentações relacionadas a cash-in (recebimento de valores provenientes de transferências ou de devoluções) e a cash-out (transferências, cancelamento e reprovação de transações).
Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.
Contexto e nome do evento
Nos eventos TED, o campo context sempre informará “Ted”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:
| Nome do evento (name) | Descrição |
|---|---|
| TED_CASH_IN_WAS_RECEIVED | O valor foi recebido no core bancário Bankly. |
| TED_CASH_IN_WAS_CLEARED | O valor foi liberado na conta destino. |
| TED_REFUND_WAS_RECEIVED | O valor devolvido foi recebido no core bancário Bankly. |
| TED_REFUND_WAS_CLEARED | O valor devolvido foi liberado na conta destino. |
| TED_CASH_OUT_WAS_DONE | A transferência do valor foi realizada. |
| TED_CASH_OUT_WAS_CANCELED | Transferência cancelada por falta de saldo na conta. |
| TED_CASH_OUT_WAS_REPROVED | A transação foi reprovada pela equipe de análise antifraude. |
| TED_CASH_OUT_WAS_UNDONE | Por haver sido reprovada pela equipe de análise antifraude, a transação foi desfeita. |
EntityId
O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.
No contexto de TED, o entityId é o AuthenticationCode (código identificador da transação).
Exemplos de eventos
[
{
"entityId": "16d9ce8d-bf54-4433-ac4e-0000000000",
"companyKey": "CompanyKey",
"idempotencyKey": "3b5d8309-cb7f-4b0d-8d00-0000000000",
"context": "Ted",
"name": "TED_CASH_IN_WAS_RECEIVED",
"timestamp": "2022-01-11T13:06:24.2559021Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"metadata": null,
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-0000000000",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "0000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "0001",
"number": "0000000000",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "0000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "1",
"number": "0000000000",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR2022011100000000000"
},
"createdAt": "2022-01-09T13:06:24.2240368Z"
}
}
]
[
{
"entityId": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"companyKey": "CompanyKey ",
"idempotencyKey": "e82f5bcb-0a45-4b1f-a236-e037ab86eafc",
"context": "Ted",
"name": "TED_CASH_IN_WAS_CLEARED",
"timestamp": "2022-01-11T13:06:24.7323197Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"metadata": null,
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "1",
"number": "654321",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR20220111033509549"
},
"createdAt": "2022-01-11T13:06:24.2240368Z"
}
}
]
{
"entityId": "99be4cbe-541d-45d8-a8ef-c034cd8dda5a",
"companyKey": " CompanyKey",
"idempotencyKey": "429876e2-a167-41ed-8dd1-da963d353fg1",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_DONE",
"timestamp": "2022-01-24T12:28:09.0191388Z",
"correlationId": "99be4cbe-541d-45d8-a8ef-c034cd8dda5a",
"metadata": {
"requestedAt": 1643027289
},
"data": {
"sender": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "string",
"account": {
"branch": "0001",
"number": "000000001",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "99be4cbe-541d-45d8-a8ef-c034cd8dda5a",
"amount": {
"value": 0.5,
"currency": "BRL"
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "string",
"account": {
"branch": "0001",
"number": "12345678",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
}
}
}
}
{
"entityId": "36139396-423e-4e5e-926c-2b962f446ec5",
"companyKey": "CompanyKey",
"idempotencyKey": "3ff2b0ea-d3c6-4c97-aa40-2fd086e3fae2",
"context": "Ted",
"name": "TED_REFUND_WAS_RECEIVED",
"timestamp": "2022-01-24T12:14:46.3628873Z",
"correlationId": "41000446-c431-49d5-9a18-260b3a8efd5e",
"data": {
"authenticationCode": "36139396-111e-4e5e-926c-2b962f446ec5",
"amount": {
"value": 5007.4,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "CompanyName",
"account": {
"branch": "0001",
"number": "00000000",
"bank": {
"ispb": "12345678",
"code": "332"
}
}
},
"channel": {
"controlNumberOriginal": "AB637786231802547849",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"account": {
"branch": "123",
"number": "123456",
"bank": {
"ispb": "00000000"
}
}
},
"controlNumber": "STR20220124033580000"
},
"createdAt": "2022-01-24T12:14:46.3144017Z"
}
}
{
"entityId": "e6122670-34c4-40fe-a5a1-610643291a41",
"companyKey": "CompanyKey",
"idempotencyKey": "0c2cfe2e-ee16-4c3e-8211-ed6686812221",
"context": "Ted",
"name": "TED_REFUND_WAS_CLEARED",
"timestamp": "2022-01-24T12:16:31.5900349Z",
"correlationId": "3009a568-82c5-4e0b-8aa9-f30583e19cc2",
"data": {
"authenticationCode": "e6122670-34c4-40fe-a5a1-610643291a41",
"amount": {
"value": 4292.3,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "string",
"account": {
"branch": "0001",
"number": "12345678",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"controlNumberOriginal": "AB637786233603621544",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "000000000",
"type": "Undefined"
},
"account": {
"branch": "1",
"number": "1234567",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR20220124033569980"
},
"createdAt": "2022-01-24T12:16:31.3096071Z"
}
}
[
{
"entityId": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"companyKey": "CompanyKey",
"idempotencyKey": "e82f5bcb-0a45-4b1f-a236-e037ab86eafc",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_CANCELED",
"timestamp": "2022-01-11T13:06:24.7323197Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"metadata": null,
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "1",
"number": "654321",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR20220111033509549"
},
"createdAt": "2022-01-11T13:06:24.2240368Z"
}
}
]
[
{
"entityId": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"companyKey": "CompanyKey",
"idempotencyKey": "e82f5bcb-0a45-4b1f-a236-e037ab86eafc",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_REPROVED",
"timestamp": "2022-01-11T13:06:24.7323197Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"metadata": null,
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "1",
"number": "654321",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR20220111033509549"
},
"createdAt": "2022-01-11T13:06:24.2240368Z"
}
}
]
[
{
"entityId": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"companyKey": "CompanyKey",
"idempotencyKey": "e82f5bcb-0a45-4b1f-a236-e037ab86eafc",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_UNDONE",
"timestamp": "2022-01-11T13:06:24.7323197Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"metadata": null,
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"recipient": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "0001",
"number": "123456",
"bank": {
"ispb": "13140088",
"code": "332"
}
}
},
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "00000000000",
"type": "CPF"
},
"type": "Customer",
"name": "string",
"account": {
"branch": "1",
"number": "654321",
"bank": {
"ispb": "000000000"
}
}
},
"controlNumber": "STR20220111033509549"
},
"createdAt": "2022-01-11T13:06:24.2240368Z"
}
}
]
Importante
Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.
Objeto data nos eventos Ted
O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de TED, esse objeto trará os seguintes campos:
authenticationCode: código identificador que também é recebido no retorno da requisição de uma TED;amount: objeto contendo o valor da transação e a moeda utilizada;recipient: objeto contendo os dados do recebedor, como nome, documento, tipo e dados de sua conta;channel: objeto contendo os dados do canal de pagamento, além da identificação da transação e dos dados do pagador:name: nome do canal de pagamento que, no caso do TED, é SPB;sender: objeto contendo os dados do pagador, como nome, documento, tipo e dados de sua conta bancária.
controlNumber: identificador do SPB para aquela TED. Em eventos de devolução (refund), esse campo vira comocontroNumberOriginal;createdAt: retorna a data de criação da transação.
Em casos de devolução Ted, o data também trará o campo refundReason (subcampo de channel), que descreve o motivo da devolução do valor (geralmente BANK_RETURN).
Updated 12 months ago