Criar

POST/subscriptions

Aqui você pode criar uma nova subscription. Lembrando que as subscriptions são separadas pela junção dos eventos e a url, ou seja, você pode inscrever mais de uma url para o mesmo evento.

Observação

Você só poderá criar subscriptions em serviços nos quais está inscrito. A responsabilidade de inscrevê-lo nos determinados serviços é da propria zemo, qualquer problema quanto a isso contate nosso suporte.

Payload

Nome	Tipo	Descrição	Obrigatório
url	string	Uma string na qual você deseja ser notificado caso algum dos eventos descritos aconteça.	Sim
events	array[string]	Uma lista de eventos que caso aconteça deseja ser notificado.	Sim
description	string	Uma descrição do que a subscription representa para o seu negócio.	Não

Valores possíveis para events

• pix.cashin.received
• pix.cashin.creating
• pix.cashin.created
• pix.cashin.paid
• pix.cashin.error_on_creation
• pix.cashout.received
• pix.cashout.creating
• pix.cashout.created
• pix.cashout.error_on_creation
• pix.cashout.warning
• pix.cashout.transferred
• pix.cashout.transfer_failed

Exemplo de Requisição (payload)

{
  "url": "seuwebhook.com",
  "events": ["pix.cashin.received", "pix.cashout.creating"],
  "description": "cashin recebido e criado."
}

Exemplo de Resposta

{
  "subscription_id": "57f09f73-5609-40d5-82f5-aa5cb8e99911"
}

Observação

O subscription ID é utilizado para remover a subscrição, se possível guarde-o para futuras alterações ou use o endpoint de listagem.