Skip to content
Webhooks
/
/
ACQUIRER_TOPUP_PAYMENT_FA...

Webhooks (1.0)

Download OpenAPI description
webhooks.json
webhooks.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks

Webhook subscription

Operations

Webhook events

Webhooks

ACQUIRER_TOPUP_EXECUTEDWebhook

Request

Solaris successfully processed a Top-Up via an Acquirer. The funds from the Top Up are cleared to the customer's account, and the status of the Top Up has changed to EXECUTED.

Bodyapplication/json
idstring

The ID of the Top-Up that was executed.

Example: "b76cdcc321d345618084feedc47bbb1d"
account_idstring

ID of the customer account associated with the successful Top-Up transaction.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
amountobject

The amount of the Top-Up.

client_secretstring

The client secret key provided by the Acquirer's API for use in their frontend SDK.

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
statusstring(TopupStatusValues)

The current status of the Top-Up.

Enum"ACCEPTED""CONFIRMED""EXECUTED""DECLINED""CANCELLED"
application/json
{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "status": "ACCEPTED"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

ACQUIRER_TOPUP_PAYMENT_FAILEDWebhook

Request

A customer attempted an Instant Top-Up but the payment failed (e.g., because the payment method used did not have sufficient funds). The customer may re-attempt the Top-Up with the same payment method or use a different one.

Bodyapplication/json
idstring

The ID of the Top-Up that failed.

Example: "b76cdcc321d345618084feedc47bbb1d"
account_idstring

ID of the customer account associated with the failed Top-Up transaction.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
amountobject

The amount of the Top-Up.

client_secretstring

The client secret key provided by the Acquirer's API for use in their frontend SDK.

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
statusstring(TopupStatusValues)

The current status of the Top-Up.

Enum"ACCEPTED""CONFIRMED""EXECUTED""DECLINED""CANCELLED"
acquirer_error_codestring or null

Error code forwarded by the Acquirer's API (in case there was an error on the Acquirer's end).

Example: "card_declined"
acquirer_decline_codestring or null

If the Acquirer declines the Top-Up, then this property will contain the decline code forwarded by the Acquirer's API.

Example: "exceeds daily limit"
application/json
{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "status": "ACCEPTED",
  "acquirer_error_code": "card_declined",
  "acquirer_decline_code": "exceeds daily limit"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

ACTIVATION_CHALLENGE_CREATIONWebhook

Request

This webhook event denotes that a new activation challenge is created. The payload contains the challenge_id which can be used to fetch the actual challenge itself.

Bodyapplication/json
person_idstring

The ID of the person for whom the challenge was created.

Example: "b9c5661fc7d240b8b51b9059b580cper"
challenge_idstring

ID of the challenge that is created.

Example: "a5f454e3f96447d6b3f7ecda46328040"
created_atstring

UTC timestamp when the challenge_id was created.

Example: "2025-02-31T10:55:55Z"
expires_atstring

UTC timestamp when the challenge_id will expire.

Example: "2025-03-31T10:55:55Z"
requested_bystring

The origin of the request that created this challenge. Possible values are - SOLARISBANK, WEBUI, MOBILE_APP, WEB

Example: "SOLARISBANK"
purposestring

The purpose for which the activation code is generataed. Currently it is only - DEVICE_BINDING

Example: "DEVICE_BINDING"
application/json
{
  "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  "challenge_id": "a5f454e3f96447d6b3f7ecda46328040",
  "created_at": "2025-02-31T10:55:55Z",
  "expires_at": "2025-03-31T10:55:55Z",
  "requested_by": "SOLARISBANK",
  "purpose": "DEVICE_BINDING"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.