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.

BATCH_TRANSFER_STATUS_CHANGEDWebhook

Request

When a batch transfer’s status changes to IN_PROGRESS, REJECTED or FINISHED, this webhook will be triggered.

Bodyapplication/json
idstring

Unique ID of the batch transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
account_idstring

The account ID of the account that the batch transfer is associated with.

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"REJECTED""IN_PROGRESS""FINISHED"
Example: "FINISHED"
transfer_typestring

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestring

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
descriptionstring

Optional description for the batch.

Example: "Monthly Salary Payments"
total_amountnumber

The total amount of all planned transfers in the batch in cents.

Example: 1000
transfers_summaryobject

Summary of executed and failed transfer counts within the batch.

created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
started_atstring(date-time)

UTC timestamp when the batch transfer started the processing of all their transfers.

Example: "2025-04-01T14:01:00+00:00"
finished_atstring(date-time)

UTC timestamp when all transfers were processed and the status of the batch reached FINISHED.

Example: "2025-04-01T14:10:30+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
application/json
{
  "id": "f874b3102718a4d757a6b6e4d5996078sctb",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "FINISHED",
  "transfer_type": "SCT_INSTANT",
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "description": "Monthly Salary Payments",
  "total_amount": 1000,
  "transfers_summary": {
    "executed": 9,
    "failed": 1
  },
  "created_at": "2025-04-01T13:59:52+00:00",
  "started_at": "2025-04-01T14:01:00+00:00",
  "finished_at": "2025-04-01T14:10:30+00:00",
  "updated_at": "2025-04-01T14:10:30+00:00"
}

Responses

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