Notificações

O serviço de notificação em nossa plataforma desempenha um papel essencial ao manter os clientes informados sobre eventos relevantes relacionados às entidades cashin e cashout. Ele garante que os usuários recebam atualizações em tempo real sobre o status e as alterações ocorridas nessas transações financeiras.

Quando ocorre um evento significativo em um cashin ou cashout, como uma mudança de status, conclusão de uma transferência ou qualquer outra ação relevante, o serviço de notificação entra em ação. Ele envia notificações aos clientes para informá-los sobre o evento ocorrido.

As notificações são entregues aos clientes por meio dos Webhooks subscritos no momento de criação das Subscriptions. O serviço de notificação é altamente personalizável, permitindo que os clientes escolham quais eventos desejam ser notificados e em quais Webhook desejam receber as notificações. Isso proporciona flexibilidade e conveniência aos usuários, garantindo que eles fiquem atualizados sobre as atividades relacionadas aos seus Cashins e Cashouts.

Eventos

Listagem de eventos das entidades com seus respectivos payloads enviados.

Cashin

Cashin received

{
  "amount": 5,
  "cashin_id": "920c246eade54d63b48bc316a41b41ad",
  "expiration": 3600,
  "external_id": "71900d60-0ec6-4f48-a966-95c8a0318126",
  "payer_document": "12345678910",
  "payer_name": "ZEMOBANK",
  "status": "RECEIVED",
  "topic": "pix.cashin.received"
}

Cashin creating

{
  "amount": 5,
  "cashin_id": "920c246eade54d63b48bc316a41b41ad",
  "created_at": "2023-06-14T00:00:00.000",
  "expiration": 3600,
  "external_id": "71900d60-0ec6-4f48-a966-95c8a0318126",
  "payer_document": "12345678910",
  "payer_name": "ZEMOBANK",
  "status": "CREATING",
  "topic": "pix.cashin.creating"
}

Cashin created

{
  "amount": 5,
  "br_code": "00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/68cf46192ec34c67bdd5467cb3783fe75204000053039865802BR5925Zemo pay Tecnologia em Pa6009Sao Paulo62070503***630400AC",
  "cashin_id": "920c246eade54d63b48bc316a41b41ad",
  "created_at": "2023-06-14T00:00:00.000",
  "expiration": 3600,
  "external_id": "71900d60-0ec6-4f48-a966-95c8a0318126",
  "payer_document": "12345678910",
  "payer_name": "ZEMOBANK",
  "provider": "starkbank",
  "provider_id": "68cf46192ec34c67bdd5467cb3783fe7",
  "status": "CREATED",
  "topic": "pix.cashin.created",
  "updated_at": "2023-06-16T09:41:29.913"
}

Cashin error on creation

{
  "amount": 2500,
  "cashin_id": "a52cd7bcb9ae416dadefba32f3129aa9",
  "created_at": "",
  "error_reason": "Houston, we have a problem.",
  "external_id": "b84006c8-c47a-41c3-813a-4b7ce89518e5",
  "payer_document": "30290199000109",
  "payer_name": "ZEMOBANK",
  "payload": {
    "key": "b84006c8-c47a-41c3-813a-4b7ce89518e5",
    "payer": {
      "type": "J",
      "name": "ZEMOBANK",
      "document": "30290199000109",
      "phone": "1995985115",
      "address": {
        "postal_code": "13087534",
        "street": "RUA ALFREDO DA COSTA FIGO",
        "number": "736",
        "complement": "SEGUNDO PAVIMENTO",
        "city": "CAMPINAS",
        "state": "SP"
      }
    },
    "value": 2500,
    "expiration": 360,
    "description": "Deposit txId b84006c8-c47a-41c3-813a-4b7ce89518e5 value 2500",
    "beneficiaries": [
      { "document": "30290199000109", "value": 2500, "type": 2 }
    ]
  },
  "status": "ERROR_ON_CREATION",
  "topic": "pix.cashin.error_on_creation"
}

Cashin paid

{
  "amount": 5,
  "br_code": "00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/68cf46192ec34c67bdd5467cb3783fe75204000053039865802BR5925Zemo pay Tecnologia em Pa6009Sao Paulo62070503***630400AC",
  "cashin_id": "920c246eade54d63b48bc316a41b41ad",
  "created_at": "2023-06-14T00:00:00.000",
  "end2end": "e18236120202302041249s0166b347c9",
  "expiration": 3600,
  "external_id": "71900d60-0ec6-4f48-a966-95c8a0318126",
  "paid_at": "2023-03-22T18:59:43",
  "paid_by_document": "12345678910",
  "paid_by_name": "Zemo Bank",
  "payer_document": "12345678910",
  "payer_name": "ZEMOBANK",
  "provider": "starkbank",
  "provider_id": "68cf46192ec34c67bdd5467cb3783fe7",
  "status": "PAID",
  "topic": "pix.cashin.paid",
  "updated_at": "2023-06-16T09:43:26.613"
}

Cashouts

Cashout received

{
  "amount": 500,
  "cashout_id": "355a8c09bd814d739080986297092e8f",
  "created_at": "2023-06-14T00:00:00.000",
  "dict_type": "cpf",
  "dict_value": "12345679810",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a03182",
  "status": "RECEIVED",
  "topic": "pix.cashout.received"
}

Cashout creating

{
  "amount": 500,
  "cashout_id": "355a8c09bd814d739080986297092e8f",
  "created_at": "2023-06-14T00:00:00.000",
  "dict_type": "cpf",
  "dict_value": "12345679810",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a03182",
  "status": "CREATING",
  "topic": "pix.cashout.creating"
}

Cashout created

{
  "amount": 500,
  "cashout_id": "355a8c09bd814d739080986297092e8f",
  "created_at": "2023-06-14T00:00:00.000",
  "dict_type": "cpf",
  "dict_value": "12345679810",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a03182",
  "payee_document": "***.123.456-**",
  "payee_name": "Zemo Bank",
  "provider": "starkbank",
  "provider_id": "6040249824182272",
  "status": "CREATED",
  "topic": "pix.cashout.created",
  "updated_at": "2023-06-19T09:40:04.921"
}

Cashout error on creation

{
  "amount": 1000,
  "cashout_id": "e15b0bdb588946479e0c622961fcf4f7",
  "created_at": "",
  "dict_type": "evp",
  "dict_value": "00f68fc4-7ba2-43fc-adb1-4fb58f55a6c8",
  "error_reason": "insuficient balance",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a0318020",
  "payload": {
    "key": "71900d60-0ec6-4f48-a966-92c8a0318020",
    "payer": {
      "name": "ZEMOBANK",
      "document": "30290199000109"
    },
    "dict_key": {
      "value": "00f68fc4-7ba2-43fc-adb1-4fb58f55a6c8",
      "type": "evp"
    },
    "external_id": "71900d60-0ec6-4f48-a966-92c8a0318020",
    "amount": 1000
  },
  "status": "ERROR_ON_CREATION",
  "topic": "pix.cashout.error_on_creation"
}

Cashout transferred

{
  "amount": 500,
  "cashout_id": "355a8c09bd814d739080986297092e8f",
  "created_at": "2023-06-14T00:00:00.000",
  "dict_type": "cpf",
  "dict_value": "12345679810",
  "end2end": "E33944193212501251844So2aAcDlVu10",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a03182",
  "provider": "starkbank",
  "provider_id": "6040249824182272",
  "status": "TRANSFERRED",
  "topic": "pix.cashout.transferred",
  "transfer_amount": 5,
  "transfer_at": "2023-04-20T12:40:41",
  "transfer_to_document": "***.123.456-**",
  "transfer_to_name": "Zemo Bank",
  "updated_at": "2023-06-19T09:40:04.921"
}

Cashout transfer failed

{
  "amount": 1,
  "cashout_id": "99a32dc40a0144769a3a5619b2ea320d",
  "created_at": "",
  "dict_type": "cpf",
  "dict_value": "18236120",
  "error_reason": ",Duplicated transfer",
  "external_id": "71900d60-0ec6-4f48-a966-92c8a0318051",
  "status": "TRANSFER_FAILED",
  "topic": "pix.cashout.transfer_failed"
}