Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Operations
Webhooks

Request

A Top-Up transaction was declined by Solaris. The status of the Top Up has changed to DECLINED.

Bodyapplication/json
idstring

The ID of the Top-Up that was declined.

Example: "b76cdcc321d345618084feedc47bbb1d"
account_idstring

ID of the customer account associated with the declined 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"
decline_reasonstring or null

The reason why the Top-Up was declined. Usually present if the status is DECLINED due to a technical issue.

Example: "Person has blocked account(s)"
application/json
{ "id": "b76cdcc321d345618084feedc47bbb1d", "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc", "amount": { "value": 10000, "currency": "EUR" }, "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU", "status": "ACCEPTED", "decline_reason": "Person has blocked account(s)" }

Responses

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

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.