Cadastrar destino de webhook de cartão
https://api.zypfy.com/api/v1/cards/webhooksEm vez de consultar o extrato de tempos em tempos, receba o evento na hora. Cadastre uma ou mais URLs e a Zypfy avisa a cada compra, recusa, carga, estorno ou mudança de status.
A resposta traz um secret — guarde: ele aparece uma única vez. É
com ele que você confere a assinatura de cada entrega. Perdeu? Apague o
destino e cadastre outro.
Regras da URL: https obrigatório, host público, portas 443 ou 8443.
Até 20 destinos por conta. Por padrão o destino recebe todos os
eventos; para filtrar, mande events — evento desconhecido é recusado
no cadastro, para um erro de digitação não virar "meu webhook não chega".
Cada destino pode ser da conta inteira (padrão) ou de um cartão só,
passando cardId: é o caso de quem emite um cartão por cliente e quer o
evento no sistema daquele cliente. Se a mesma URL casar pelos dois
caminhos, ela recebe uma vez só.
Corpo da requisição
urlstring (uri)obrigatóriohttps obrigatório, host público, portas 443 ou 8443.
exemplo:https://seusistema.com/webhooks/cartaolabelstring | nullexemplo:producaocardIdstring (uuid) | nullLimita o destino a um cartão. Omitido, o destino vale para a conta inteira.
eventsarray de stringOmitido, o destino recebe todos os eventos. Evento desconhecido é recusado no cadastro.
Respostas
201Destino cadastrado. O secret só aparece aqui.
webhookcampos de webhook
idstringexemplo:12urlstring (uri)labelstring | nullcardIdstring (uuid) | nullPreenchido quando o destino é de um cartão só.
eventsarray de stringnull= todos.activebooleanhealthobjectcampos de health
lastSuccessAtstring (date-time) | nulllastFailureAtstring (date-time) | nulllastFailureErrorstring | nullconsecutiveFailuresintegerexemplo:0
createdAtstring (date-time)
secretstringAparece UMA única vez. É com ele que você confere a assinatura das entregas.
exemplo:9f2c1e0b7a5d43c8...
400URL inválida (não é https, host interno, porta não aceita) ou evento desconhecido.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
409URL já cadastrada neste escopo ou limite de 20 destinos atingido.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.