Introduction

Webhooks can be used to get events from Alviere. For example, when a transaction is settled, Alviere can send an event to your webhook consumer with information about the transaction.

Events are grouped into Subscriptions and each Subscription event will be posted into a URL provided by you at the moment of the subscription.

Note: Alviere sends all events asynchronously so that it doesn't block or slow down any system operation or transaction. All events are actions that already took place.

SubscriptionsCopied!

Alviere provides several different subscriptions to receive different event types:

• ACCOUNT provides information about the lifecycle of your program accounts.

• WALLET_TRANSACTION provides information about the lifecycle of wallet transactions.

• ISSUED_CARD provides information about the lifecycle of all cards issued by Alviere.

• BENEFICIARY provides information about the lifecycle of all beneficiaries in your program.

• BANK_PM provides information about the lifecycle of all bank accounts used as payment methods.

• CARD_PM provides information about the lifecycle of all cards used as payment methods.

• CHECK provides information about the lifecycle of check deposit transaction.

• DOSSIER provides information about the lifecycle of all uploaded dossiers.

• PAYMENT_INSTRUMENT provides information about the lifecycle of all payment instruments.

Payload formatCopied!

{
  "event_uuid": "082fd7f7-7e9e-4679-bd16-ed9f5a55d827",
  "program_uuid": "04d3ac6e-82d3-4f52-b82f-6cc0320928af",
  "event_date": "2021-06-17T11:02:08.143Z",
  "event_retry": 0,
  "event_type": [SUBSCRIPTION_TYPE],
  "event_version": "2021-11-18.1",
  "entity":{
    ...
  }
}

AuthenticationCopied!

Each subscription requires the following information:

• Subscription type

• Target endpoint (needs to be a complete HTTPS URL)

• The required security key (you must setup one and give us)

• Version required for each subscription

When we call the desired HTTPS URL, we will include an HEADER called Alviere-Auth and the value of this HEADER will be the security key you provided to us.

ProcessingCopied!

Each time we send a message for the provided URL, we expect a 200 HTTP status code, otherwise we will retry the event applying a polynomial backoff starting at 20ms and going up to 2 minutes after each retry.

NOTE that we will continuously retry sending the message and this will impact any other messages in the queue as we strictly maintain messages in order (FIFO).

How to subscribeCopied!

Please contact your implementation manager for more information.