Skip to content
Transactions
/
/
Index clearing profiles

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

Index clearing profiles

Request

Returns an array containing all clearing profiles under your control.

Headers
Solaris-Partner-Idstringrequired

Your partner ID.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the clearing profile.

Example: "8264234444a2a4cb1ee33666259c5513pacp"
ibanstring

IBAN of the clearing account.

Example: "DE97110101004884374432"
allowed_booking_typesArray of strings(Solaris-Enums-BookingType)

An array containing the allowed booking types for this profile.

Items Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: ["CURRENCY_EXCHANGE_PARTNER"]
customer_authenticationboolean

Indicates whether the customer must complete a change request for negative bookings on their account.

Example: true
]
Response
application/json
[
  {
    "id": "8264234444a2a4cb1ee33666259c5513pacp",
    "iban": "DE97110101004884374432",
    "allowed_booking_types": [ … ],
    "customer_authentication": true
  }
]

Create a credit clearing transaction

Request

Creates a credit clearing transaction on the account specified in the request URL. The funds will be sent from this account to the account defined in the clearing profile sent in the request body.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

amountobjectrequired
Example: {"value":1000,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount value.

Example: 1000
amount.​unitstring

The unit of the given value in cents.

Example: "cents"
amount.​currencystring

The currency of the given value. Only EUR is currently supported.

Example: "EUR"
booking_typestringrequired
Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
clearing_profile_idstringrequired

ID of the clearing profile to use for the clearing transaction.

Example: "1c0eda0b559825ef456b21d81f4ee962pacp"
descriptionstring

A description for the credit clearing transaction, which will be visible to the account holder.

Example: "Example clearing transaction"
referencestring

Optional unique transaction reference.

Example: "ert123456789ert"
initiator_referencestring

Optional unique initiator reference.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
application/json
{
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "booking_type": "INTERNAL_TRANSFER",
  "description": "Example clearing transaction",
  "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  "reference": "ert123456789ert",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the clearing transaction.

Example: "3f4e761f500e4c11a6627b4d90daaec4"
statusstring

The status of the clearing transaction.

Enum"ACCEPTED""DECLINED""EXECUTED""REVIEW_NEEDED""CANCELED"
Example: "EXECUTED"
account_idstring

ID of the account for which the transaction was created.

Example: "06659ff514934b28800b5650d109cacc"
account_ibanstring

The account's IBAN.

Example: "DE43110101005555555555"
clearing_account_ibanstring

The clearing account's IBAN.

Example: "DE30110101001234567890"
amountobject
descriptionstring

A description of the transaction, which is visible to both the sender and the receiver.

Example: "Example description"
booking_typestring(Solaris-Enums-BookingType)

The type of the booking. See the booking documentation for a list of explanations for each booking type.

Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
valuta_datestring

The valuta date of the transaction.

Example: "2022-04-22"
transaction_typestring

The type of the transaction.

Example: "CLEARING_TRANSACTION"
referencestring

UUID reference for the transaction. Acts as an idempotency key.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
initiator_referencestring

UUID initiatiors reference for the transaction.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
Response
application/json
{
  "id": "3f4e761f500e4c11a6627b4d90daaec4",
  "status": "EXECUTED",
  "account_id": "06659ff514934b28800b5650d109cacc",
  "account_iban": "DE43110101005555555555",
  "clearing_account_iban": "DE30110101001234567890",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "Example description",
  "booking_type": "SEPA_CREDIT_TRANSFER",
  "valuta_date": "2022-04-22",
  "transaction_type": "CLEARING_TRANSACTION",
  "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Create debit clearing transaction

Request

Creates a debit clearing transaction to the account specified in the request URL. Funds will be drawn from the account defined in the clearing profile to the account in the URL.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

amountobjectrequired
Example: {"value":1000,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount value.

Example: 1000
amount.​unitstring

The unit of the given value in cents.

Example: "cents"
amount.​currencystring

The currency of the given value. Only EUR is currently supported.

Example: "EUR"
booking_typestringrequired

The booking type to use for the debit clearing transaction. Must match one of the booking types defined in the clearing profile.

Example: "INTEREST_ACCRUED"
clearing_profile_idstringrequired

ID of the clearing profile to use for the debit clearing transaction.

Example: "1c0eda0b559825ef456b21d81f4ee962pacp"
descriptionstring

A description for the transaction.

Example: "Example clearing transaction"
referencestring

A unique reference for the transaction.

Example: "ert123456789ert"
initiator_referencestring

Optional unique initiator reference for the transaction.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
application/json
{
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "booking_type": "INTEREST_ACCRUED",
  "description": "Example clearing transaction",
  "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  "reference": "ert123456789ert",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the clearing transaction.

Example: "3f4e761f500e4c11a6627b4d90daaec4"
statusstring

The status of the clearing transaction.

Enum"ACCEPTED""DECLINED""EXECUTED""REVIEW_NEEDED""CANCELED"
Example: "EXECUTED"
account_idstring

ID of the account for which the transaction was created.

Example: "06659ff514934b28800b5650d109cacc"
account_ibanstring

The account's IBAN.

Example: "DE43110101005555555555"
clearing_account_ibanstring

The clearing account's IBAN.

Example: "DE30110101001234567890"
amountobject
descriptionstring

A description of the transaction, which is visible to both the sender and the receiver.

Example: "Example description"
booking_typestring(Solaris-Enums-BookingType)

The type of the booking. See the booking documentation for a list of explanations for each booking type.

Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
valuta_datestring

The valuta date of the transaction.

Example: "2022-04-22"
transaction_typestring

The type of the transaction.

Example: "CLEARING_TRANSACTION"
referencestring

UUID reference for the transaction. Acts as an idempotency key.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
initiator_referencestring

UUID initiatiors reference for the transaction.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
Response
application/json
{
  "id": "3f4e761f500e4c11a6627b4d90daaec4",
  "status": "EXECUTED",
  "account_id": "06659ff514934b28800b5650d109cacc",
  "account_iban": "DE43110101005555555555",
  "clearing_account_iban": "DE30110101001234567890",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "Example description",
  "booking_type": "SEPA_CREDIT_TRANSFER",
  "valuta_date": "2022-04-22",
  "transaction_type": "CLEARING_TRANSACTION",
  "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Get a clearing transaction

Request

Returns the clearing transaction specified in the request URL.

Path
account_idstringrequired
clearing_transaction_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the clearing transaction.

Example: "3f4e761f500e4c11a6627b4d90daaec4"
statusstring

The status of the clearing transaction.

Enum"ACCEPTED""DECLINED""EXECUTED""REVIEW_NEEDED""CANCELED"
Example: "EXECUTED"
account_idstring

ID of the account for which the transaction was created.

Example: "06659ff514934b28800b5650d109cacc"
account_ibanstring

The account's IBAN.

Example: "DE43110101005555555555"
clearing_account_ibanstring

The clearing account's IBAN.

Example: "DE30110101001234567890"
amountobject
descriptionstring

A description of the transaction, which is visible to both the sender and the receiver.

Example: "Example description"
booking_typestring(Solaris-Enums-BookingType)

The type of the booking. See the booking documentation for a list of explanations for each booking type.

Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
valuta_datestring

The valuta date of the transaction.

Example: "2022-04-22"
transaction_typestring

The type of the transaction.

Example: "CLEARING_TRANSACTION"
referencestring

UUID reference for the transaction. Acts as an idempotency key.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
initiator_referencestring

UUID initiatiors reference for the transaction.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
Response
application/json
{
  "id": "3f4e761f500e4c11a6627b4d90daaec4",
  "status": "EXECUTED",
  "account_id": "06659ff514934b28800b5650d109cacc",
  "account_iban": "DE43110101005555555555",
  "clearing_account_iban": "DE30110101001234567890",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "Example description",
  "booking_type": "SEPA_CREDIT_TRANSFER",
  "valuta_date": "2022-04-22",
  "transaction_type": "CLEARING_TRANSACTION",
  "reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
  "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f"
}

Instant Top-Ups

Operations

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