Ted
context | Nome do evento (name) | Descrição |
|---|---|---|
Ted | TED_CASH_OUT_WAS_APPROVED | Transferência aprovada pela análise de antifraude. |
Ted | TED_CASH_OUT_WAS_DONE | A transferência do valor foi realizada. |
Ted | TED_CASH_OUT_WAS_CANCELED | Houve uma falha em uma das etapas do processo de transferência. Portanto, a transferência foi cancelada. |
Ted | TED_CASH_OUT_WAS_REPROVED | A transação foi reprovada pela equipe de análise antifraude. |
Ted | TED_CASH_OUT_WAS_UNDONE | Houve uma falha em uma das etapas do processo de transferência. Portanto, a transação foi desfeita e o valor retornou para a conta de origem. |
Ted | TED_CASH_IN_WAS_RECEIVED | O valor foi recebido no core bancário Hiperbanco. |
Ted | TED_CASH_IN_WAS_CLEARED | O valor foi liberado na conta destino. |
Ted | TED_REFUND_WAS_RECEIVED | O valor devolvido foi recebido no core bancário Hiperbanco. |
Ted | TED_REFUND_WAS_CLEARED | O valor devolvido foi liberado na conta destino. |
Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:
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).
Esse evento sinaliza que uma transferência foi aprovada pela análise antifraude e o valor correspondente foi reservado.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"companyKey": "SQUAD_TEDDY",
"idempotencyKey": "3d1b109b-d2b3-4116-9cc3-4340286aa5bf",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_APPROVED",
"timestamp": "2022-11-24T13:55:53.0477133Z",
"correlationId": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"version": "1.0",
"metadata": {
"RequestedAt": 1669298153
},
"data": {
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "17298092",
"code": "184"
}
}
},
},
"amount": {
"value": 0.01,
"currency": "BRL"
}
}
}
Esse evento sinaliza que a transferência de um valor foi realizada.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
channel.controlNumber | string | Identificador do SPB para TED realizado. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"companyKey": "INTERNO_UPSIGHT",
"idempotencyKey": "c5e5bc8b-b4cd-42d0-ac1e-2c835ccf8849",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_DONE",
"timestamp": "2022-11-07T18:27:44.6817634Z",
"correlationId": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"controlNumber":"AB638326341140223360"
}
}
}
Esse evento sinaliza que uma transferência foi cancelada por um problema na reserva de saldo ou por problemas internos no processo de transferência.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência foi reprovada pela análise antifraude.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "1",
"number": "540108",
"bank": {
"ispb": "000000000",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência foi desfeita e o valor reservado foi devolvido.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador . |
sender.account | object | Objeto que contém os dados da conta do pagador . |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta do recebedor. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "1",
"number": "654321",
"type": "Checking",
"bank": {
"ispb": "000000000",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência via TED foi recebida no core bancário.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
recipient.account.bank.code | string | Código do banco. |
recipient.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "16d9ce8-bf54-4433-ac4e-0000000000",
"companyKey": "CompanyKey",
"idempotencyKey": "3b5d309-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",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "16d9ce8-bf54-4433-ac4e-0000000000",
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"createdAt": "2022-01-09T13:06:24.2240368Z"
}
}
Esse evento sinaliza que o valor de uma transferência via TED foi liberado na conta de destino.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
recipient.account.bank.code | string | Código do banco. |
recipient.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "16d9ce8-bf54-4433-ac4e-0000000000",
"companyKey": "CompanyKey",
"idempotencyKey": "3b5d309-cb7f-4b0d-8d00-0000000000",
"context": "Ted",
"name": "TED_CASH_IN_WAS_CLEARED",
"timestamp": "2022-01-11T13:06:24.2559021Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "16d9ce8-bf54-4433-ac4e-0000000000",
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"createdAt": "2022-01-09T13:06:24.2240368Z"
}
}
Esse evento sinaliza que o valor devolvido de uma transferência via TED foi recebido no core bancário Hiperbanco.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.controlNumberOriginal | string | Identificador do SPB para a TED realizada. |
channel.refundReason | string | Razão pela qual o valor foi devolvido. |
channel.errorReason | string | Esse campo retorna como null. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.controlNumber | string | Identificador do SPB para a devolução da TED. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "3613939-423e-4e5e-926c-2b962f446ec5",
"companyKey": "CompanyKey",
"idempotencyKey": "3ff2bea-d3c6-4c97-aa40-2fd086e3fae2",
"context": "Ted",
"name": "TED_REFUND_WAS_RECEIVED",
"timestamp": "2022-01-24T12:14:46.3628873Z",
"correlationId": "4100446-c431-49d5-9a18-260b3a8efd5e",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"name": "Editora Nísia Floresta",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {}
}
},
"authenticationCode": "3613936-111e-4e5e-926c-2b962f446ec5",
"channel": {
"controlNumberOriginal": "AB63776231802547849",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "12345678"
}
}
},
"controlNumber": "STR20220124033580000"
},
"amount": {
"value": 5007.4,
"currency": "BRL"
},
"createdAt": "2022-01-24T12:14:46.3144017Z"
}
}
Esse evento sinaliza que o valor devolvido de uma transferência via TED foi liberado na conta de destino.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.controlNumberOriginal | string | Identificador do SPB para a TED realizada. |
channel.refundReason | string | Razão pela qual o valor foi devolvido. |
channel.errorReason | string | Esse campo retorna como null. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.controlNumber | string | Identificador do SPB para a devolução da TED. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "Editora Floresta",
"account": {
"branch": "0001",
"number": "12345540108678",
"type": "Checking",
"bank": {}
}
},
"authenticationCode": "e6122670-34c4-40fe-a5a1-610643291a41",
"channel": {
"controlNumberOriginal": "AB637786233603621544",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"controlNumber": "STR20220124033569980"
},
"amount": {
"value": 4292.3,
"currency": "BRL"
},
"createdAt": "2022-01-24T12:16:31.3096071Z"
}
}
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).
Para mais informações sobre quando estes eventos são disparados e sobre o seu conteúdo, consulte as páginas:
Para receber esses eventos, o parceiro deverá:
- Configurar previamente o recebedor de eventos do webhook.
- Conhecer a estrutura básica dos eventos que acompanha o objeto
data.
Os campos context e name poderão variar de acordo com a tabela a seguir:
context | Nome do evento (name) | Descrição |
|---|---|---|
Ted | TED_CASH_OUT_WAS_APPROVED | Transferência aprovada pela análise de antifraude. |
Ted | TED_CASH_OUT_WAS_DONE | A transferência do valor foi realizada. |
Ted | TED_CASH_OUT_WAS_CANCELED | Houve uma falha em uma das etapas do processo de transferência. Portanto, a transferência foi cancelada. |
Ted | TED_CASH_OUT_WAS_REPROVED | A transação foi reprovada pela equipe de análise antifraude. |
Ted | TED_CASH_OUT_WAS_UNDONE | Houve uma falha em uma das etapas do processo de transferência. Portanto, a transação foi desfeita e o valor retornou para a conta de origem. |
Ted | TED_CASH_IN_WAS_RECEIVED | O valor foi recebido no core bancário Hiperbanco. |
Ted | TED_CASH_IN_WAS_CLEARED | O valor foi liberado na conta destino. |
Ted | TED_REFUND_WAS_RECEIVED | O valor devolvido foi recebido no core bancário Hiperbanco. |
Ted | TED_REFUND_WAS_CLEARED | O valor devolvido foi liberado na conta destino. |
Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:
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).
Esse evento sinaliza que uma transferência foi aprovada pela análise antifraude e o valor correspondente foi reservado.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"companyKey": "SQUAD_TEDDY",
"idempotencyKey": "3d1b109b-d2b3-4116-9cc3-4340286aa5bf",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_APPROVED",
"timestamp": "2022-11-24T13:55:53.0477133Z",
"correlationId": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"version": "1.0",
"metadata": {
"RequestedAt": 1669298153
},
"data": {
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "d5a36dde-b34e-4b34-96cf-4b0442a93b80",
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "17298092",
"code": "184"
}
}
},
},
"amount": {
"value": 0.01,
"currency": "BRL"
}
}
}
Esse evento sinaliza que a transferência de um valor foi realizada.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador da transação. |
sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
channel.controlNumber | string | Identificador do SPB para TED realizado. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"companyKey": "INTERNO_UPSIGHT",
"idempotencyKey": "c5e5bc8b-b4cd-42d0-ac1e-2c835ccf8849",
"context": "Ted",
"name": "TED_CASH_OUT_WAS_DONE",
"timestamp": "2022-11-07T18:27:44.6817634Z",
"correlationId": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "8fb63329-eda2-4a9c-91a1-f6c8f13c63b8",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções De Pagamento S.A."
}
}
},
"controlNumber":"AB638326341140223360"
}
}
}
Esse evento sinaliza que uma transferência foi cancelada por um problema na reserva de saldo ou por problemas internos no processo de transferência.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "0001",
"number": "540108",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência foi reprovada pela análise antifraude.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador. |
sender.account | object | Objeto que contém os dados da conta do pagador. |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
sender.account.bank.code | string | Código do banco. |
sender.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "1",
"number": "540108",
"bank": {
"ispb": "000000000",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência foi desfeita e o valor reservado foi devolvido.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
sender | object | Objeto que contém os dados do pagador. |
sender.document | object | Objeto que contém os dados do documento do pagador. |
sender.document.value | string | Número do documento. |
sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
sender.type | string | Tipo de cliente pagador (Customer ou Business). |
sender.name | string | Nome do pagador . |
sender.account | object | Objeto que contém os dados da conta do pagador . |
sender.account.branch | string | Agência bancária. |
sender.account.number | string | Número da conta. |
sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
sender.account.bank | object | Objeto que contém os dados do banco ao qual a conta do pagador pertence. |
sender.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do recebedor da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.recipient | object | Objeto que contém os dados do recebedor da transação. |
channel.recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
channel.recipient.document.value | string | Número do documento. |
channel.recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
channel.recipient.name | string | Nome do recebedor. |
channel.recipient.account | object | Objeto que contém os dados da conta do recebedor. |
channel.recipient.account.branch | string | Agência bancária. |
channel.recipient.account.number | string | Número da conta. |
channel.recipient.account.type | string | Tipo de conta do recebedor. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": {
"RequestedAt": 1667845664
},
"data": {
"authenticationCode": "16d9ce8d-bf54-4433-ac4e-b470fbb5ed09",
"amount": {
"value": 0.01,
"currency": "BRL"
},
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "1",
"number": "654321",
"type": "Checking",
"bank": {
"ispb": "000000000",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"channel": {
"name": "SPB",
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
}
}
}
Esse evento sinaliza que uma transferência via TED foi recebida no core bancário.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
recipient.account.bank.code | string | Código do banco. |
recipient.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "16d9ce8-bf54-4433-ac4e-0000000000",
"companyKey": "CompanyKey",
"idempotencyKey": "3b5d309-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",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "16d9ce8-bf54-4433-ac4e-0000000000",
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"createdAt": "2022-01-09T13:06:24.2240368Z"
}
}
Esse evento sinaliza que o valor de uma transferência via TED foi liberado na conta de destino.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
recipient.account.bank.code | string | Código do banco. |
recipient.account.bank.name | string | Nome do banco. |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.recipient.account.bank.code | string | Código do banco. |
channel.recipient.account.bank.name | string | Nome do banco. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "16d9ce8-bf54-4433-ac4e-0000000000",
"companyKey": "CompanyKey",
"idempotencyKey": "3b5d309-cb7f-4b0d-8d00-0000000000",
"context": "Ted",
"name": "TED_CASH_IN_WAS_CLEARED",
"timestamp": "2022-01-11T13:06:24.2559021Z",
"correlationId": "7ab145b5-f0a1-42af-b187-8dcb670b962c",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"name": "Nísia Floresta",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
},
"authenticationCode": "16d9ce8-bf54-4433-ac4e-0000000000",
"channel": {
"name": "SPB",
"sender": {
"document": {
"value": "09992220074",
"type": "CPF"
},
"type": "Customer",
"name": "Quitéria Maria de Jesus",
"account": {
"branch": "001",
"number": "540108",
"type": "Checking",
"bank": {
"ispb": "13140088",
"code": "332",
"name": "Acesso Soluções de Pagamento S.A."
}
}
}
},
"amount": {
"value": 0.01,
"currency": "BRL"
},
"createdAt": "2022-01-09T13:06:24.2240368Z"
}
}
Esse evento sinaliza que o valor devolvido de uma transferência via TED foi recebido no core bancário Hiperbanco.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.controlNumberOriginal | string | Identificador do SPB para a TED realizada. |
channel.refundReason | string | Razão pela qual o valor foi devolvido. |
channel.errorReason | string | Esse campo retorna como null. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.controlNumber | string | Identificador do SPB para a devolução da TED. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "3613939-423e-4e5e-926c-2b962f446ec5",
"companyKey": "CompanyKey",
"idempotencyKey": "3ff2bea-d3c6-4c97-aa40-2fd086e3fae2",
"context": "Ted",
"name": "TED_REFUND_WAS_RECEIVED",
"timestamp": "2022-01-24T12:14:46.3628873Z",
"correlationId": "4100446-c431-49d5-9a18-260b3a8efd5e",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "34183937000161",
"type": "CNPJ"
},
"type": "Business",
"name": "Editora Nísia Floresta",
"account": {
"branch": "0001",
"number": "540108",
"type": "Checking",
"bank": {}
}
},
"authenticationCode": "3613936-111e-4e5e-926c-2b962f446ec5",
"channel": {
"controlNumberOriginal": "AB63776231802547849",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"type": "Customer",
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "12345678"
}
}
},
"controlNumber": "STR20220124033580000"
},
"amount": {
"value": 5007.4,
"currency": "BRL"
},
"createdAt": "2022-01-24T12:14:46.3144017Z"
}
}
Esse evento sinaliza que o valor devolvido de uma transferência via TED foi liberado na conta de destino.
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição |
|---|---|---|
recipient | object | Objeto que contém os dados do recebedor da transação. |
recipient.document | object | Objeto que contém os dados do documento do recebedor da transação. |
recipient.document.value | string | Número do documento. |
recipient.document.type | string | Tipo de documento (CPF ou CNPJ). |
recipient.type | string | Tipo de cliente recebedor (Customer ou Business). |
recipient.name | string | Nome do recebedor. |
recipient.account | object | Objeto que contém os dados da conta do recebedor. |
recipient.account.branch | string | Agência bancária. |
recipient.account.number | string | Número da conta. |
recipient.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento |
authenticationCode | string | Código identificador da transação. |
channel | object | Objeto que contém os dados do canal de pagamento e do pagador da transação. |
channel.controlNumberOriginal | string | Identificador do SPB para a TED realizada. |
channel.refundReason | string | Razão pela qual o valor foi devolvido. |
channel.errorReason | string | Esse campo retorna como null. |
channel.name | string | Tipo de canal, que, para TED, será sempre SPB. |
channel.sender | object | Objeto que contém os dados do pagador da transação. |
channel.sender.document | object | Objeto que contém os dados do documento do pagador da transação. |
channel.sender.document.value | string | Número do documento. |
channel.sender.document.type | string | Tipo de documento (CPF ou CNPJ). |
channel.sender.type | string | Tipo de cliente pagador (Customer ou Business). |
channel.sender.name | string | Nome do pagador. |
channel.sender.account | object | Objeto que contém os dados da conta do pagador. |
channel.sender.account.branch | string | Agência bancária. |
channel.sender.account.number | string | Número da conta. |
channel.sender.account.type | string | Tipo de conta, o qual pode ser “CHECKING” para conta corrente, “SALARY” para conta salário, “SAVINGS” para conta poupança e “PAYMENT” para conta de pagamento. |
channel.recipient.account.bank | object | Objeto que contém os dados do banco ao qual a conta do recebedor pertence. |
channel.recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
channel.controlNumber | string | Identificador do SPB para a devolução da TED. |
amount | object | Objeto que contém os dados referentes ao valor da transação. |
amount.value | number | Valor da transação. |
amount.currency | string | Sigla da moeda utilizada na transação, de acordo com a ISO 4217. Exemplos: “BRL”. |
createdAt | string | Data de criação da transferência, no formato ISO 8601 - UTC. |
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"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",
"version": "1.0",
"metadata": null,
"data": {
"recipient": {
"document": {
"value": "11111111000111",
"type": "CNPJ"
},
"type": "Business",
"name": "Editora Floresta",
"account": {
"branch": "0001",
"number": "12345540108678",
"type": "Checking",
"bank": {}
}
},
"authenticationCode": "e6122670-34c4-40fe-a5a1-610643291a41",
"channel": {
"controlNumberOriginal": "AB637786233603621544",
"refundReason": "BANK_RETURN",
"errorReason": "",
"name": "SPB",
"sender": {
"document": {
"value": "47742663023",
"type": "CPF"
},
"account": {
"branch": "0001",
"number": "15164",
"type": "Checking",
"bank": {
"ispb": "13140088"
}
}
},
"controlNumber": "STR20220124033569980"
},
"amount": {
"value": 4292.3,
"currency": "BRL"
},
"createdAt": "2022-01-24T12:16:31.3096071Z"
}
}
Updated 7 months ago