Notificações

Confirmação

Após a criação de uma transferência, antes de sua real efetuação, é feita uma confirmação usando a URL cadastrada no token.

A confirmação é enviada logo após a criação da transferência. É efetuado um POST com os seguintes parâmetros:

Body Params

ParâmetroDescriçãoFormato
signatureCampo criptografado *.string
digestÉ usado para verificar a signature.string
kindTipo de webhookstring
data.api_partner_transaction_uuidUUID enviado pelo usuário na criação.string
data.beneficiaryVerificar abaixo os atributos do beneficiário.object
data.valueValor da transferência.string

📘

*Criptografado usando o texto: confirmation-api_partner_transaction_uuid onde api_partner_transaction_uuid é o informado pelo usuário na criação.

Atributos do Beneficiário (Confirmação e Notificações)

ParâmetroDescriçãoFormato
agencyAgência da conta para onde será enviada a transferência.string
accountNúmero da conta para onde será enviada a transferência.string
bank_codeCódigo do banco para onde será enviada a transferência.string

Notificações

As notificações são enviadas para o callback_url na hora da criação da transferência.

Body Params

ParâmetroDescriçãoFormato
signature- Campo criptografadostring
digestDigest é usado para verificar a signaturestring
kindTipo do webhookstring
data.api_partner_transaction_uuidUUID enviado pelo usuário na criaçãostring
data.resourceTipo de recurso da notificação, neste caso, transfer_requeststring
data.statusStatus atual da transferênciastring
data.messageMensagem de retornostring
data.reject_reasonMotivo pelo qual a transferência foi rejeitada (apenas quando rejeitada)string

📘

Criptografado usando o texto: status-api_partner_transaction_uuid onde api_partner_transaction_uuid é o informado pelo usuário na criação e o status é o status enviado no data.

Os tipos de status são:

  • autorizado-pelo-aprovador: Transferência autorizada pelo aprovador.
  • rejeitado-pelo-aprovador: Transferência rejeitada pelo aprovador.
  • transferencia-enviada-com-sucesso: Transferencia enviada com sucesso.
  • erro-ao-enviar-transferencia: Erro ao enviar a transferênicia.

Eventos de notificação

{
  "signature": "QgfCmWtsQaggSg1nyvzB4z83HoSUWb84aIvp3hV/53k+6Qz3teWvuqIhx+SV\npRB4z+vTxkWaVYivbEJvY+TiWBYjIBY47Fz2ONnQVnEP8RXivKfgddjwOu4N\ny7okZsaB5KZ2Itj8CGu6uhJ/t8pGugUFUcbN0WQeRnMmoBaqFNuRYLgnAP6L\nQlC7u183+WOFj6vXJN0xL1mjhfSxSnUCKjJZV5BlMU9f83Oos7hid3T2cLzK\n5s6fbzCNm5ZibSqF8NfR6VBFW7xVlrmN5xc9TWmpGVcmbR5dx2OtDNGHwNMp\nwVa9afIUTnE3D0m6g4XfrJejacxD0BaPd28R8tPdPuDLQceB+okQ4shbE666\nRT/fpFhAO7IDiIN5tteBu0L3FvHLsyv8J5tMKFKUPMSGSs3p2ZziLYvTC6vx\nD/F+192KKT34DUGupyDmBbPVwvtAYMiU4DJs+KRZqP7jJMQQE9ZQJsxDJQ1O\nU8jtgV2Xr1ykwTOHBOCEtgWhLfBPRbJ9Ok5aOgcYmfIPL0ebEpadPVwXthOK\nr5ub+sUcRoJF+YATR2L7eoZUTqdMiYGWIgm5087othbs/wnhNPcRIw6Xvszq\n14euv/dqHyYhdOu4ccJk7PdVre9C9K3fYwYOKTQy2VsS9csTXqkWzVovEW1s\nLG45WLo+Tv4JgmCfR16NDSk=\n",
  "digest": "",
  "kind": "status-alterado",
  "data": {
    "api_partner_transaction_uuid": "6e944145-39f7-48ea-aaab-e39c96d4586c",
    "resource": "transfer_request",
    "status": "autorizado-pelo-aprovador"
  }
}
{
  "signature": "QgfCmWtsQaggSg1nyvzB4z83HoSUWb84aIvp3hV/53k+6Qz3teWvuqIhx+SV\npRB4z+vTxkWaVYivbEJvY+TiWBYjIBY47Fz2ONnQVnEP8RXivKfgddjwOu4N\ny7okZsaB5KZ2Itj8CGu6uhJ/t8pGugUFUcbN0WQeRnMmoBaqFNuRYLgnAP6L\nQlC7u183+WOFj6vXJN0xL1mjhfSxSnUCKjJZV5BlMU9f83Oos7hid3T2cLzK\n5s6fbzCNm5ZibSqF8NfR6VBFW7xVlrmN5xc9TWmpGVcmbR5dx2OtDNGHwNMp\nwVa9afIUTnE3D0m6g4XfrJejacxD0BaPd28R8tPdPuDLQceB+okQ4shbE666\nRT/fpFhAO7IDiIN5tteBu0L3FvHLsyv8J5tMKFKUPMSGSs3p2ZziLYvTC6vx\nD/F+192KKT34DUGupyDmBbPVwvtAYMiU4DJs+KRZqP7jJMQQE9ZQJsxDJQ1O\nU8jtgV2Xr1ykwTOHBOCEtgWhLfBPRbJ9Ok5aOgcYmfIPL0ebEpadPVwXthOK\nr5ub+sUcRoJF+YATR2L7eoZUTqdMiYGWIgm5087othbs/wnhNPcRIw6Xvszq\n14euv/dqHyYhdOu4ccJk7PdVre9C9K3fYwYOKTQy2VsS9csTXqkWzVovEW1s\nLG45WLo+Tv4JgmCfR16NDSk=\n",
  "digest": "",
  "kind": "status-alterado",
  "data": {
    "api_partner_transaction_uuid": "6e944145-39f7-48ea-aaab-e39c96d4586c",
    "resource": "transfer_request",
    "status": "rejeitado-pelo-aprovador"
  }
}
{
  "signature": "QgfCmWtsQaggSg1nyvzB4z83HoSUWb84aIvp3hV/53k+6Qz3teWvuqIhx+SV\npRB4z+vTxkWaVYivbEJvY+TiWBYjIBY47Fz2ONnQVnEP8RXivKfgddjwOu4N\ny7okZsaB5KZ2Itj8CGu6uhJ/t8pGugUFUcbN0WQeRnMmoBaqFNuRYLgnAP6L\nQlC7u183+WOFj6vXJN0xL1mjhfSxSnUCKjJZV5BlMU9f83Oos7hid3T2cLzK\n5s6fbzCNm5ZibSqF8NfR6VBFW7xVlrmN5xc9TWmpGVcmbR5dx2OtDNGHwNMp\nwVa9afIUTnE3D0m6g4XfrJejacxD0BaPd28R8tPdPuDLQceB+okQ4shbE666\nRT/fpFhAO7IDiIN5tteBu0L3FvHLsyv8J5tMKFKUPMSGSs3p2ZziLYvTC6vx\nD/F+192KKT34DUGupyDmBbPVwvtAYMiU4DJs+KRZqP7jJMQQE9ZQJsxDJQ1O\nU8jtgV2Xr1ykwTOHBOCEtgWhLfBPRbJ9Ok5aOgcYmfIPL0ebEpadPVwXthOK\nr5ub+sUcRoJF+YATR2L7eoZUTqdMiYGWIgm5087othbs/wnhNPcRIw6Xvszq\n14euv/dqHyYhdOu4ccJk7PdVre9C9K3fYwYOKTQy2VsS9csTXqkWzVovEW1s\nLG45WLo+Tv4JgmCfR16NDSk=\n",
  "digest": "",
  "kind": "status-alterado",
  "data": {
    "api_partner_transaction_uuid": "6e944145-39f7-48ea-aaab-e39c96d4586c",
    "resource": "transfer_request",
    "status": "transferencia-enviada-com-sucesso"
  }
}
{
  "signature": "ya3P+PlsYaWlv+4x7mCB7T9E2LGqk0yJrOApRzaf8xbXrdGEGdF0wYfYwxen\nIw6DSZqFKK/IgSUghQqMXZiH6TbGaPTHXKM8bOhsQSFSA10chPEmX4/8ZIY7\njJve5JsdqQyJ+zcdb7E6WNlgI8bQtlle0nQyLInPU6mPGIYca9PUNnNnP2Zt\nY+IVbTd86b5sMCopWAivEi97zgTnCznP7Iz5j0pZB2Fm2i3lmjoiZc8U48eY\nLnR80BuKEA/dEesEBVlz69GGVmpv4FSR91NOKqz6lOIY7jhy1/YJGP0VEazE\n3/1PGYTbwM/QUEf6kw+ZYFUYVn22iHxNWxrNpy6J9OLF0uPqj77w2i+DGWwJ\n1xn8CxjG4fJ/+pp/FBQgoc3EDW1Hjo0ZXoqpn/UBQ9DSEI7rnAh/JuC/L5jf\nq9fhwiewQzeHjD9lqjck/1kvlC0y6ccKdfO9scEnnoaW6QOkYzUy5MKLuXhG\nZU4w1dM632CdJTpoHYhBPKta6XC4ZHDj/RRWxjrN7h5CLEN+3X3jCGdNWEPl\n9JA2sOokB44eeoUPfYsxpKF0D8xbnotjzpUZPXy3mLIhGacPnoLgtQ344EYu\nCKavRWagvne4yr2pO+UO2fLhu1vE6e1rHpRcTGehSjPrhjZFgJawnxYaSqLL\nyXSqjEBFCSAbqHLXp7dzHno=\n",
  "digest": "",
  "kind": "status-alterado",
  "data": {
    "status": "erro-ao-enviar-transferencia",
    "message": "Houve conflito entre dados do beneficiário e dados cadastrados na chave!",
    "resource": "transfer_request",
    "api_partner_transaction_uuid": "6743e77a-cb4e-4550-9d6f-582f438545fc"
  }
}