Skip to content
/Instant Top-Ups

Transactions (1.0)

Download OpenAPI description
transactions.json
transactions.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/transactions/

Cash Operations (Viacash)

Operations

Clearing transactions

Operations

Instant Top-Ups

Operations

Create a Top-Up

Request

Creates a Top-Up for the person's account specified in the request URL. Calling this endpoint will begin the payment process with Solaris and its acquiring partner (e.g., Stripe).
Note that you must provide the returned client_secret to the Acquirer's SDK (e.g., the Stripe PaymentIntent).

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/jsonrequired

The content of the request.

amountobjectrequired
amount.​valueinteger

The amount of the Top-Up, in Euro cents.

Example: 10000
amount.​currencystring

The currency of the Top-Up. Only EUR is supported.

Value"EUR"
payment_method_idstring
application/json
{
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "payment_method_id": "string"
}

Responses

The Top-Up was successfully created.

Bodyapplication/json
idstringrequired

Unique ID of the Top-Up.

Example: "b76cdcc321d345618084feedc47bbb1d"
amountobjectrequired
amount.​valueinteger

The amount in Euro cents.

Example: 10000
amount.​currencystring

The currency of the Top-Up.

Value"EUR"
statusstring(TopupStatusValues)required

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: null
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: null
cancellation_reasonstring or null

The reason why the Top-Up was cancelled. Only present if the status is 'CANCELLED'.

Enum"abandoned""duplicate""fraudulent""requested_by_customer"
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: null
client_secretstring

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

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
instruction_idstring or null

Instruction ID of the Solaris credit transfer transaction.

Example: "3eba1ee2d8bc4d5883d350031a5fe9d8"
Response
application/json
{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "acquirer_error_code": null,
  "acquirer_decline_code": null,
  "cancellation_reason": "abandoned",
  "decline_reason": null,
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "status": "ACCEPTED",
  "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}

Index Top-Ups for a person's account

Request

Returns an array containing all Top-Ups for the person's account specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
Query
filter[status]string(TopupStatusValues)

Filter the results by the status of the Top-Up.

Enum"ACCEPTED""CONFIRMED""EXECUTED""DECLINED""CANCELLED"
filter[instruction_id]string

Filter the results by the instruction_id

No request payload

Responses

The operation was successful.

Headers
Totalstring

Total number of resources to return that match the provided filters.

Example: "123"
Per-Pagestring

Number of resources to return per page.

Example: "10"
Linkstring

Links to other pages.

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/jsonArray [
idstringrequired

Unique ID of the Top-Up.

Example: "b76cdcc321d345618084feedc47bbb1d"
amountobjectrequired
amount.​valueinteger

The amount in Euro cents.

Example: 10000
amount.​currencystring

The currency of the Top-Up.

Value"EUR"
statusstring(TopupStatusValues)required

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: null
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: null
cancellation_reasonstring or null

The reason why the Top-Up was cancelled. Only present if the status is 'CANCELLED'.

Enum"abandoned""duplicate""fraudulent""requested_by_customer"
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: null
client_secretstring

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

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
instruction_idstring or null

Instruction ID of the Solaris credit transfer transaction.

Example: "3eba1ee2d8bc4d5883d350031a5fe9d8"
]
Response
application/json
[
  {
    "id": "b76cdcc321d345618084feedc47bbb1d",
    "amount": { … },
    "acquirer_error_code": null,
    "acquirer_decline_code": null,
    "cancellation_reason": "abandoned",
    "decline_reason": null,
    "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
    "status": "ACCEPTED",
    "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
  }
]

Retrieve a Top-Up

Request

Returns the Top-Up with the ID specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
topup_idstringrequired
No request payload

Responses

The Top-Up was found.

Bodyapplication/json
idstringrequired

Unique ID of the Top-Up.

Example: "b76cdcc321d345618084feedc47bbb1d"
amountobjectrequired
amount.​valueinteger

The amount in Euro cents.

Example: 10000
amount.​currencystring

The currency of the Top-Up.

Value"EUR"
statusstring(TopupStatusValues)required

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: null
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: null
cancellation_reasonstring or null

The reason why the Top-Up was cancelled. Only present if the status is 'CANCELLED'.

Enum"abandoned""duplicate""fraudulent""requested_by_customer"
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: null
client_secretstring

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

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
instruction_idstring or null

Instruction ID of the Solaris credit transfer transaction.

Example: "3eba1ee2d8bc4d5883d350031a5fe9d8"
Response
application/json
{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "acquirer_error_code": null,
  "acquirer_decline_code": null,
  "cancellation_reason": "abandoned",
  "decline_reason": null,
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "status": "ACCEPTED",
  "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}

Cancel a Top-Up

Request

Cancels the Top-Up specified in the request URL. Specify the reason for the cancellation in the request body.

Path
person_idstringrequired
account_idstringrequired
topup_idstringrequired
Bodyapplication/jsonrequired

The content of the request.

cancellation_reasonstringrequired

The reason for cancellation.

Enum"duplicate""fraudulent""requested_by_customer""abandoned"
Example: "abandoned"
application/json
{
  "cancellation_reason": "abandoned"
}

Responses

The Top-Up was cancelled.

Bodyapplication/json
idstringrequired

Unique ID of the Top-Up.

Example: "b76cdcc321d345618084feedc47bbb1d"
amountobjectrequired
amount.​valueinteger

The amount in Euro cents.

Example: 10000
amount.​currencystring

The currency of the Top-Up.

Value"EUR"
statusstring(TopupStatusValues)required

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: null
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: null
cancellation_reasonstring or null

The reason why the Top-Up was cancelled. Only present if the status is 'CANCELLED'.

Enum"abandoned""duplicate""fraudulent""requested_by_customer"
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: null
client_secretstring

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

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
instruction_idstring or null

Instruction ID of the Solaris credit transfer transaction.

Example: "3eba1ee2d8bc4d5883d350031a5fe9d8"
Response
application/json
{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "acquirer_error_code": null,
  "acquirer_decline_code": null,
  "cancellation_reason": "abandoned",
  "decline_reason": null,
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "status": "ACCEPTED",
  "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}

Instant Top-Up Payment Methods

Operations

Intra-customer transfers

Operations

Prepaid accounts

Operations

Partner remittances

Operations

Reference account payouts

Operations

Transfer requests

Operations

(Legacy) Money Transfer

Operations