Skip to main content

Account Notifications

Account webhook notifications inform you of events that happen and that apply to the accounts of your customers. Learn more how you can start receiving webhook notifications in the webhooks guide.

Weavr sends the following account-related webhook notifications:

Account Deposits​

Weavr uses webhooks to inform you when a deposit was received on an account. The webhook includes the fields transactionId and transactionAmount that represent the transaction identifier and its amount. You can use these notifications to notify customers that funds are now available on their accounts.

The information will be sent to you using the ${WEBHOOK_URL}/managed_accounts/deposits/watch webhook URL.

info

The ${WEBHOOK_URL} is the URL configured in your application settings.

Notifications can also be used in conjunction with the following endpoint which shows the effect of a deposit on the actualBalance and availableBalance of the account.

GET/managed_accounts/{id}Try it

Deposit credited immediately​

When a deposit is credited immediately, just one webhook is sent with the state COMPLETED.

If the API endpoint is called, then the transactionAmount (from the webhook) is reflected in both the actualBalance and availableBalance in the API.

Deposit held for compliance checks​

When a deposit is held for compliance checks (e.g. a Source of Funds declaration is required), two webooks will be sent. The first webhook is sent when the deposit is received (and held) and has the state : PENDING. If the API endpoint is called, the actualBalance reflects the deposit but availableBalance does not.

When compliance checks are completed, a second webhook is sent with the state : COMPLETED. If the API endpoint is called, then both the actualBalance and availableBalance reflect the deposit.

Example​

Initial balance (amounts in cents/pence) = 77650, deposit for 1500000 (held for compliance checks).

Deposit received and held for compliance checks. The first webhook is sent with transactionAmount.amount : 1500000 and state : PENDING.

API balances:

"balances": {
        "actualBalance": 1577650,
        "availableBalance": 77650

Compliance checks are completed, deposit fully processed and money can be used. The second webhook is sent with transactionAmount.amount : 1500000 and state : COMPLETED

API balances:

"balances": {
        "actualBalance": 1577650,
        "availableBalance": 1577650

Account Updates​

Weavr uses webhooks to inform you when there is an update to an account. The webhook includes the account object containing all information related to the account that has been updated. The type field describes the action that was performed on the account.

The information will be sent to you using the ${WEBHOOK_URL}/managed_accounts/watch webhook URL.