Skip to content
/Transfer requests

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

Reference account payouts

Operations

Transfer requests

Operations

Create transfer request

Request

Creates a transfer request and associates it with the account specified in the request URL. This method will create a reservation on the account for the amount specified in the transfer request.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

amountobject
Example: {"value":10000,"unit":"cents","currency":"EUR"}
referencestring

A unique reference for the transfer request. Acts as an idempotency key.

Example: "e8eabf80-095f-4d6a-947a-4ca1455cc378"
descriptionstring

A description for the transfer request.

Example: "An example description"
application/json
{
  "amount": {
    "value": 10000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "An example description"
}

Responses

Transfer request created successfully

Bodyapplication/json
idstring

Unique ID of the transfer request.

Example: "d3441a66f78e6290cdeebc4c1689a4aetreq"
reservation_idstring

Unique ID of the reservation associated with the transfer request.

Example: "88cedf447b2c43828ded233733d1cc54"
amountobject
Example: {"amount":1000,"unit":"cents","currency":"EUR"}
referencestring

A unique reference for the transfer request. Used as an idempotency key.

Example: "e8eabf80-095f-4d6a-947a-4ca1455cc378"
descriptionstring

The description of the transfer request.

Example: "Example description"
resolvedboolean

Indicates whether the transfer request was resolved.

Example: false
Response
application/json
{
  "id": "d3441a66f78e6290cdeebc4c1689a4aetreq",
  "reservation_id": "88cedf447b2c43828ded233733d1cc54",
  "amount": {
    "amount": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "Example description",
  "resolved": false
}

Index transfer requests for an account

Request

Returns an array containing all transfer requests associated with the account specified in the request URL.

Path
account_idstringrequired
Query
filter[resolved]boolean

Use this filter to return only resolved transfers.

filter[reference]string

Filter the response by the reference property.

filter[reservation_id]string

Filter the response by the reservation ID associated with the transfer request.

No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the transfer request.

Example: "d3441a66f78e6290cdeebc4c1689a4aetreq"
reservation_idstring

Unique ID of the reservation associated with the transfer request.

Example: "88cedf447b2c43828ded233733d1cc54"
amountobject
Example: {"amount":1000,"unit":"cents","currency":"EUR"}
referencestring

A unique reference for the transfer request. Used as an idempotency key.

Example: "e8eabf80-095f-4d6a-947a-4ca1455cc378"
descriptionstring

The description of the transfer request.

Example: "Example description"
resolvedboolean

Indicates whether the transfer request was resolved.

Example: false
]
Response
application/json
[
  {
    "id": "d3441a66f78e6290cdeebc4c1689a4aetreq",
    "reservation_id": "88cedf447b2c43828ded233733d1cc54",
    "amount": { … },
    "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
    "description": "Example description",
    "resolved": false
  }
]

Retrieve a transfer request

Request

Returns information about the transfer request specified in the request URL.

Path
account_idstringrequired
transfer_request_idstringrequired
No request payload

Responses

Transfer request fetched successfully.

Bodyapplication/json
idstring

Unique ID of the transfer request.

Example: "d3441a66f78e6290cdeebc4c1689a4aetreq"
reservation_idstring

Unique ID of the reservation associated with the transfer request.

Example: "88cedf447b2c43828ded233733d1cc54"
amountobject
Example: {"amount":1000,"unit":"cents","currency":"EUR"}
referencestring

A unique reference for the transfer request. Used as an idempotency key.

Example: "e8eabf80-095f-4d6a-947a-4ca1455cc378"
descriptionstring

The description of the transfer request.

Example: "Example description"
resolvedboolean

Indicates whether the transfer request was resolved.

Example: false
Response
application/json
{
  "id": "d3441a66f78e6290cdeebc4c1689a4aetreq",
  "reservation_id": "88cedf447b2c43828ded233733d1cc54",
  "amount": {
    "amount": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "Example description",
  "resolved": false
}

Index transfer request executions

Request

Returns an array containing all transfer request executions for the account specified in the request URL.

Path
account_idstringrequired
transfer_request_idstringrequired
Query
page[number]integer>= 1

The number of results pages to return.

Default 1
page[size]integer

The number of results to return on each page.

Default 10
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the transfer request execution.

Example: "e451ce22c8b1438d8befe2a29182fc83"
amountobject
statusstring

Current status of the transfer request execution.

Enum"ACCEPTED""EXECUTED""DECLINED"
Example: "EXECUTED"
typestring

The type of transfer request execution.

Enum"CRYPTO_EXCHANGE""PARTNER_FEE"
Example: "CRYPTO_EXCHANGE"
recipient_ibanstring

The recipient's IBAN.

Example: "DE32110101001000000029"
instruction_idstring

Instruction id assigned to the transfer.

Example: "GT5VCLgQCkpcyTCnHuXdg8nSVz2hjDpY4Qw"
referencestring

Unique reference for the transfer request execution. Acts as an idempotency key.

Example: "55207045-4509-4278-9f44-0947635f4d75"
descriptionstring

A description of the transfer request execution.

Example: "Example description"
]
Response
application/json
[
  {
    "id": "e451ce22c8b1438d8befe2a29182fc83",
    "amount": { … },
    "status": "EXECUTED",
    "type": "CRYPTO_EXCHANGE",
    "recipient_iban": "DE32110101001000000029",
    "instruction_id": "GT5VCLgQCkpcyTCnHuXdg8nSVz2hjDpY4Qw",
    "reference": "55207045-4509-4278-9f44-0947635f4d75",
    "description": "Example description"
  }
]

Execute a transfer request

Request

Executes the transfer request specified in the request URL. Note that you can execute a transfer request for less than or equal to the transfer request amount. In case the amount is lower, a new reservation of the remaining amount will be created and the associated reservation_id of the transfer request will be updated. You must then release the previous reservation using PATCH Resolve a transfer request.

Path
account_idstringrequired
transfer_request_idstringrequired
Bodyapplication/json

The content of the request.

amountobject(Money)
referencestring

A unique reference for the transfer request. Acts as an idempotency key.

Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"
descriptionstring

A description for the transfer request.

Example: "Wallet-to-wallet payment"
recipient_ibanstring

The recipient's IBAN.

Example: "DE32110101001000000029"
typestring

The type of transfer request to be executed.

Enum"CRYPTO_EXCHANGE""PARTNER_FEE"
Example: "CRYPTO_EXCHANGE"
application/json
{
  "amount": {
    "value": 10000,
    "currency": "EUR"
  },
  "reference": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  "description": "Wallet-to-wallet payment",
  "recipient_iban": "DE32110101001000000029",
  "type": "CRYPTO_EXCHANGE"
}

Responses

Transfer request execution created successfully.

Bodyapplication/json
idstring

ID of the transfer request execution.

Example: "e451ce22c8b1438d8befe2a29182fc83"
amountobject
statusstring

Current status of the transfer request execution.

Enum"ACCEPTED""EXECUTED""DECLINED"
Example: "EXECUTED"
typestring

The type of transfer request execution.

Enum"CRYPTO_EXCHANGE""PARTNER_FEE"
Example: "CRYPTO_EXCHANGE"
recipient_ibanstring

The recipient's IBAN.

Example: "DE32110101001000000029"
instruction_idstring

Instruction id assigned to the transfer.

Example: "GT5VCLgQCkpcyTCnHuXdg8nSVz2hjDpY4Qw"
referencestring

Unique reference for the transfer request execution. Acts as an idempotency key.

Example: "55207045-4509-4278-9f44-0947635f4d75"
descriptionstring

A description of the transfer request execution.

Example: "Example description"
Response
application/json
{
  "id": "e451ce22c8b1438d8befe2a29182fc83",
  "amount": {
    "value": 0,
    "unit": "string",
    "currency": "EUR"
  },
  "status": "EXECUTED",
  "type": "CRYPTO_EXCHANGE",
  "recipient_iban": "DE32110101001000000029",
  "instruction_id": "GT5VCLgQCkpcyTCnHuXdg8nSVz2hjDpY4Qw",
  "reference": "55207045-4509-4278-9f44-0947635f4d75",
  "description": "Example description"
}

Resolve a transfer request

Request

Trigger release of reservation amount

Path
account_idstringrequired
transfer_request_idstringrequired
No request payload

Responses

Transfer request resolved successfully.

Bodyapplication/json
idstring

Unique ID of the transfer request.

Example: "d3441a66f78e6290cdeebc4c1689a4aetreq"
reservation_idstring

Unique ID of the reservation associated with the transfer request.

Example: "88cedf447b2c43828ded233733d1cc54"
amountobject
Example: {"amount":1000,"unit":"cents","currency":"EUR"}
referencestring

A unique reference for the transfer request. Used as an idempotency key.

Example: "e8eabf80-095f-4d6a-947a-4ca1455cc378"
descriptionstring

The description of the transfer request.

Example: "Example description"
resolvedboolean

Indicates whether the transfer request was resolved.

Example: false
Response
application/json
{
  "id": "d3441a66f78e6290cdeebc4c1689a4aetreq",
  "reservation_id": "88cedf447b2c43828ded233733d1cc54",
  "amount": {
    "amount": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reference": "e8eabf80-095f-4d6a-947a-4ca1455cc378",
  "description": "Example description",
  "resolved": false
}

(Legacy) Money Transfer

Operations