Manual do Dev
InstitucionalBlogService DeskStatus Page

TED

stable

Suggest Edits

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:

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

contextNome do evento (name)Descrição
TedTED_CASH_OUT_WAS_APPROVEDTransferência aprovada pela análise de antifraude.
TedTED_CASH_OUT_WAS_DONEA transferência do valor foi realizada.
TedTED_CASH_OUT_WAS_CANCELEDHouve uma falha em uma das etapas do processo de transferência. Portanto, a transferência foi cancelada.
TedTED_CASH_OUT_WAS_REPROVEDA transação foi reprovada pela equipe de análise antifraude.
TedTED_CASH_OUT_WAS_UNDONEHouve 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.
TedTED_CASH_IN_WAS_RECEIVEDO valor foi recebido no core bancário Bankly.
TedTED_CASH_IN_WAS_CLEAREDO valor foi liberado na conta destino.
TedTED_REFUND_WAS_RECEIVEDO valor devolvido foi recebido no core bancário Bankly.
TedTED_REFUND_WAS_CLEAREDO valor devolvido foi liberado na conta destino.

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Clique nas imagens para ampliá-las:

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).

Dados dos eventos

TED_CASH_OUT_WAS_APPROVED

Esse evento sinaliza que uma transferência foi aprovada pela análise antifraude e o valor correspondente foi reservado.

Descrição do objeto data do evento

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:

NomeTipoDescrição
senderobjectObjeto que contém os dados do pagador da transação.
sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.typestringTipo de cliente pagador (Customer ou Business).
sender.namestringNome do pagador.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringAgência bancária.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do pagador pertence.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do recebedor da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.recipientobjectObjeto que contém os dados do recebedor da transação.
channel.recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
channel.recipient.document.valuestringNúmero do documento.
channel.recipient.document.typestringTipo de documento (CPF ou CNPJ).
channel.recipient.typestringTipo de cliente recebedor (Customer ou Business).
channel.recipient.namestringNome do recebedor.
channel.recipient.accountobjectObjeto que contém os dados da conta do recebedor.
channel.recipient.account.branchstringAgência bancária.
channel.recipient.account.numberstringNúmero da conta.
channel.recipient.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.

Payload do evento

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"
         }
      }
   }

TED_CASH_OUT_WAS_DONE

Esse evento sinaliza que a transferência de um valor foi realizada.

Descrição do objeto data do evento

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:

NomeTipoDescrição
senderobjectObjeto que contém os dados do pagador da transação.
sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.typestringTipo de cliente pagador (Customer ou Business).
sender.namestringNome do pagador.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringAgência bancária.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do pagador pertence.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do recebedor da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.recipientobjectObjeto que contém os dados do recebedor da transação.
channel.recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
channel.recipient.document.valuestringNúmero do documento.
channel.recipient.document.typestringTipo de documento (CPF ou CNPJ).
channel.recipient.typestringTipo de cliente recebedor (Customer ou Business).
channel.recipient.namestringNome do recebedor.
channel.recipient.accountobjectObjeto que contém os dados da conta do recebedor.
channel.recipient.account.branchstringAgência bancária.
channel.recipient.account.numberstringNúmero da conta.
channel.recipient.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
channel.recipient.account.bank.namestringNome do banco.
channel.controlNumberstringIdentificador do SPB para TED realizado.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.

Payload do evento

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"
         } 
      }
 }

TED_CASH_OUT_WAS_CANCELED

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.

Descrição do objeto data do evento

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:

NomeTipoDescrição
senderobjectObjeto que contém os dados do pagador.
sender.documentobjectObjeto que contém os dados do documento do pagador.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.typestringTipo de cliente pagador (Customer ou Business).
sender.namestringNome do pagador.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringAgência bancária.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do pagador pertence.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do recebedor da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.recipientobjectObjeto que contém os dados do recebedor da transação.
channel.recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
channel.recipient.document.valuestringNúmero do documento.
channel.recipient.document.typestringTipo de documento (CPF ou CNPJ).
channel.recipient.typestringTipo de cliente recebedor (Customer ou Business).
channel.recipient.namestringNome do recebedor.
channel.recipient.accountobjectObjeto que contém os dados da conta do recebedor.
channel.recipient.account.branchstringAgência bancária.
channel.recipient.account.numberstringNúmero da conta.
channel.recipient.account.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
channel.recipient.account.bank.namestringNome do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.

Payload do evento

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."
                 }
              }
            }
         }         
      }
 }

TED_CASH_OUT_WAS_REPROVED

Esse evento sinaliza que uma transferência foi reprovada pela análise antifraude.

Descrição do objeto data do evento

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:

NomeTipoDescrição
senderobjectObjeto que contém os dados do pagador.
sender.documentobjectObjeto que contém os dados do documento do pagador.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.typestringTipo de cliente pagador (Customer ou Business).
sender.namestringNome do pagador.
sender.accountobjectObjeto que contém os dados da conta do pagador.
sender.account.branchstringAgência bancária.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do pagador pertence.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
sender.account.bank.codestringCódigo do banco.
sender.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do recebedor da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.recipientobjectObjeto que contém os dados do recebedor da transação.
channel.recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
channel.recipient.document.valuestringNúmero do documento.
channel.recipient.document.typestringTipo de documento (CPF ou CNPJ).
channel.recipient.typestringTipo de cliente recebedor (Customer ou Business).
channel.recipient.namestringNome do recebedor.
channel.recipient.accountobjectObjeto que contém os dados da conta do recebedor.
channel.recipient.account.branchstringAgência bancária.
channel.recipient.account.numberstringNúmero da conta.
channel.recipient.account.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
channel.recipient.account.bank.namestringNome do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.

Payload do evento

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."
                 }
              }
           }
         }
      }
 }

TED_CASH_OUT_WAS_UNDONE

Esse evento sinaliza que uma transferência foi desfeita e o valor reservado foi devolvido.

Descrição do objeto data do evento

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:

NomeTipoDescrição
senderobjectObjeto que contém os dados do pagador.
sender.documentobjectObjeto que contém os dados do documento do pagador.
sender.document.valuestringNúmero do documento.
sender.document.typestringTipo de documento (CPF ou CNPJ).
sender.typestringTipo de cliente pagador (Customer ou Business).
sender.namestringNome do pagador .
sender.accountobjectObjeto que contém os dados da conta do pagador .
sender.account.branchstringAgência bancária.
sender.account.numberstringNúmero da conta.
sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do pagador pertence.
sender.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do recebedor da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.recipientobjectObjeto que contém os dados do recebedor da transação.
channel.recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
channel.recipient.document.valuestringNúmero do documento.
channel.recipient.document.typestringTipo de documento (CPF ou CNPJ).
channel.recipient.typestringTipo de cliente recebedor (Customer ou Business).
channel.recipient.namestringNome do recebedor.
channel.recipient.accountobjectObjeto que contém os dados da conta do recebedor.
channel.recipient.account.branchstringAgência bancária.
channel.recipient.account.numberstringNúmero da conta.
channel.recipient.account.typestringTipo de conta do recebedor.
channel.recipient.account.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.

Payload do evento

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."
                 }
              }
           }
         }
      }
 }

TED_CASH_IN_WAS_RECEIVED

Esse evento sinaliza que uma transferência via TED foi recebida no core bancário.

Descrição do objeto data do evento

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:

NomeTipoDescrição
recipientobjectObjeto que contém os dados do recebedor da transação.
recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor (Customer ou Business).
recipient.namestringNome do recebedor.
recipient.accountobjectObjeto que contém os dados da conta do recebedor.
recipient.account.branchstringAgência bancária.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
recipient.account.bank.codestringCódigo do banco.
recipient.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do pagador da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.senderobjectObjeto que contém os dados do pagador da transação.
channel.sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento (CPF ou CNPJ).
channel.sender.typestringTipo de cliente pagador (Customer ou Business).
channel.sender.namestringNome do pagador.
channel.sender.accountobjectObjeto que contém os dados da conta do pagador.
channel.sender.account.branchstringAgência bancária.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
channel.recipient.account.bank.namestringNome do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.
createdAtstringData de criação da transferência, no formato ISO 8601 - UTC.

Payload do evento

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"
      }
 }

TED_CASH_IN_WAS_CLEARED

Esse evento sinaliza que o valor de uma transferência via TED foi liberado na conta de destino.

Descrição do objeto data do evento

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:

NomeTipoDescrição
recipientobjectObjeto que contém os dados do recebedor da transação.
recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor (Customer ou Business).
recipient.namestringNome do recebedor.
recipient.accountobjectObjeto que contém os dados da conta do recebedor.
recipient.account.branchstringAgência bancária.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
recipient.account.bank.codestringCódigo do banco.
recipient.account.bank.namestringNome do banco.
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do pagador da transação.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.senderobjectObjeto que contém os dados do pagador da transação.
channel.sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento (CPF ou CNPJ).
channel.sender.typestringTipo de cliente pagador (Customer ou Business).
channel.sender.namestringNome do pagador.
channel.sender.accountobjectObjeto que contém os dados da conta do pagador.
channel.sender.account.branchstringAgência bancária.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.recipient.account.bank.codestringCódigo do banco.
channel.recipient.account.bank.namestringNome do banco.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.
createdAtstringData de criação da transferência, no formato ISO 8601 - UTC.

Payload do evento

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"
      }
 }

TED_REFUND_WAS_RECEIVED

Esse evento sinaliza que o valor devolvido de uma transferência via TED foi recebido no core bancário Bankly.

Descrição do objeto data do evento

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:

NomeTipoDescrição
recipientobjectObjeto que contém os dados do recebedor da transação.
recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor (Customer ou Business).
recipient.namestringNome do recebedor.
recipient.accountobjectObjeto que contém os dados da conta do recebedor.
recipient.account.branchstringAgência bancária.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo 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
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do pagador da transação.
channel.controlNumberOriginalstringIdentificador do SPB para a TED realizada.
channel.refundReasonstringRazão pela qual o valor foi devolvido.
channel.errorReasonstringEsse campo retorna como null.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.senderobjectObjeto que contém os dados do pagador da transação.
channel.sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento (CPF ou CNPJ).
channel.sender.typestringTipo de cliente pagador (Customer ou Business).
channel.sender.namestringNome do pagador.
channel.sender.accountobjectObjeto que contém os dados da conta do pagador.
channel.sender.account.branchstringAgência bancária.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.controlNumberstringIdentificador do SPB para a devolução da TED.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.
createdAtstringData de criação da transferência, no formato ISO 8601 - UTC.

Payload do evento

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"
      }
 }

TED_REFUND_WAS_CLEARED

Esse evento sinaliza que o valor devolvido de uma transferência via TED foi liberado na conta de destino.

Descrição do objeto data do evento

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:

NomeTipoDescrição
recipientobjectObjeto que contém os dados do recebedor da transação.
recipient.documentobjectObjeto que contém os dados do documento do recebedor da transação.
recipient.document.valuestringNúmero do documento.
recipient.document.typestringTipo de documento (CPF ou CNPJ).
recipient.typestringTipo de cliente recebedor (Customer ou Business).
recipient.namestringNome do recebedor.
recipient.accountobjectObjeto que contém os dados da conta do recebedor.
recipient.account.branchstringAgência bancária.
recipient.account.numberstringNúmero da conta.
recipient.account.typestringTipo 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
authenticationCodestringCódigo identificador da transação.
channelobjectObjeto que contém os dados do canal de pagamento e do pagador da transação.
channel.controlNumberOriginalstringIdentificador do SPB para a TED realizada.
channel.refundReasonstringRazão pela qual o valor foi devolvido.
channel.errorReasonstringEsse campo retorna como null.
channel.namestringTipo de canal, que, para TED, será sempre SPB.
channel.senderobjectObjeto que contém os dados do pagador da transação.
channel.sender.documentobjectObjeto que contém os dados do documento do pagador da transação.
channel.sender.document.valuestringNúmero do documento.
channel.sender.document.typestringTipo de documento (CPF ou CNPJ).
channel.sender.typestringTipo de cliente pagador (Customer ou Business).
channel.sender.namestringNome do pagador.
channel.sender.accountobjectObjeto que contém os dados da conta do pagador.
channel.sender.account.branchstringAgência bancária.
channel.sender.account.numberstringNúmero da conta.
channel.sender.account.typestringTipo 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.bankobjectObjeto que contém os dados do banco ao qual a conta do recebedor pertence.
channel.recipient.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
channel.controlNumberstringIdentificador do SPB para a devolução da TED.
amountobjectObjeto que contém os dados referentes ao valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda utilizada na transação com base na ISO 4217.
createdAtstringData de criação da transferência, no formato ISO 8601 - UTC.

Payload do evento

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 2 months ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados