Skip to content
Transactions
/
/
Index partner remittances

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

Instant Top-Up Payment Methods

Operations

Intra-customer transfers

Operations

Prepaid accounts

Operations

Partner remittances

Operations

Index partner remittances

Request

Returns an array containing all partner remittances for all of your customers.

Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[account_id]string

Filter the results by account ID.

filter[status]string

Filter the results by remittance status.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the partner remittance.

Example: "2c7da6c316a34fd1915cb9fb2ccc632e"
receiver_first_namestring

The receiver's first name.

Example: "Max"
receiver_last_namestring

The receiver's last name.

Example: "Mustermann"
receiver_addressobject

The receiver's address.

receiver_account_numberstring

The receiver's bank account number.

Example: "DE72110101001000014344"
amountobject
statusstring

The status of the remittance.

descriptionstring

Optional description of the remittance, which will be visible to the recipient.

clearing_profile_idstring

ID of the clearing profile to use for this transaction.

Example: "1c0eda0b559825ef456b21d81f4ee962pacp"
senderobject
]
Response
application/json
[
  {
    "id": "2c7da6c316a34fd1915cb9fb2ccc632e",
    "receiver_first_name": "Max",
    "receiver_last_name": "Mustermann",
    "receiver_address": { … },
    "receiver_account_number": "DE72110101001000014344",
    "amount": { … },
    "status": "string",
    "description": "string",
    "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
    "sender": { … }
  }
]

Create a partner remittance

Request

Creates a partner remittance transaction for the account specified in the request URL. Note that this endpoint requires a change request.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

receiver_first_namestring

The receiver's first name.

Example: "Peter"
receiver_last_namestring

The receiver's last name.

Example: "Testmann"
receiver_addressobject

The receiver's address.

Example: {"line_1":"Musterstrasse 64","line_2":"Musterstrasse 64","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
receiver_account_numberstring

The receiver's bank account number.

Example: "DE72110101001000014344"
amountobject
Example: {"value":1000,"currency":"EUR","unit":"cents"}
descriptionstring

Optional description of the remittance, which will be visible to the recipient.

Example: "Purpose of the transaction"
clearing_profile_idstring

ID of the clearing profile to use for this transaction.

Example: "1c0eda0b559825ef456b21d81f4ee962pacp"
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"
referencestring

A unique transaction reference

Example: "ert123456789ert"
application/json
{
  "receiver_first_name": "Peter",
  "receiver_last_name": "Testmann",
  "receiver_address": {
    "line_1": "Musterstrasse 64",
    "line_2": "Musterstrasse 64",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "receiver_account_number": "DE72110101001000014344",
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "description": "Purpose of the transaction",
  "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  "booking_type": "INTERNAL_TRANSFER",
  "reference": "ert123456789ert"
}

Responses

Unexpected error

Body

Refund a partner remittance

Request

Initiates the refund process for a partner remittance. Use this endpoint if you cannot credit the recipient's account, e.g., due to the beneficiary account being closed or blocked.
When the refund is completed, you will receive a BOOKING webhook notification for the sender's account, and the status of the partner remittance will change to returned.
Note that you may only use this endpoints on partner remittances with a status of COMPLETED.

Path
account_idstringrequired
partner_remittance_idstringrequired
No request payload

Responses

Successful result of the operation.

Body
Response
No content

Show a partner remittance

Request

Returns the partner remittance specified in the request URL.

Path
account_idstringrequired
partner_remittance_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the partner remittance.

Example: "2c7da6c316a34fd1915cb9fb2ccc632e"
receiver_first_namestring

The receiver's first name.

Example: "Max"
receiver_last_namestring

The receiver's last name.

Example: "Mustermann"
receiver_addressobject

The receiver's address.

receiver_account_numberstring

The receiver's bank account number.

Example: "DE72110101001000014344"
amountobject
statusstring

The status of the remittance.

descriptionstring

Optional description of the remittance, which will be visible to the recipient.

clearing_profile_idstring

ID of the clearing profile to use for this transaction.

Example: "1c0eda0b559825ef456b21d81f4ee962pacp"
senderobject
Response
application/json
{
  "id": "2c7da6c316a34fd1915cb9fb2ccc632e",
  "receiver_first_name": "Max",
  "receiver_last_name": "Mustermann",
  "receiver_address": {
    "line_1": "Musterstrasse",
    "line_2": "string",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "receiver_account_number": "DE72110101001000014344",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "status": "string",
  "description": "string",
  "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
  "sender": {
    "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc",
    "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
    "first_name": "Peter",
    "last_name": "Testmann",
    "iban": "DE13110101014386274299"
  }
}

Reference account payouts

Operations

Transfer requests

Operations

(Legacy) Money Transfer

Operations