Skip to content
/SEPA Credit Transfers

SEPA transfers (1.0)

Download OpenAPI description
sepa-transfers.json
sepa-transfers.yaml
Languages
Servers
Mock Server

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

SEPA Direct Debits

Operations

SEPA Direct Debit Returns

Operations

SEPA Credit Transfers

Operations

Create SEPA Credit Transfer

Request

Creates a SEPA Credit Transfer from the account specified in the request URL to the recipient specified in the request body.

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

amountobjectrequired

The amount to transfer.

Example: {"value":1000,"currency":"EUR"}
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"
recipient_ibanstringrequired

The recipient's IBAN.

Example: "DE32110101001000000029"
recipient_namestringrequired

The recipient's name.

Example: "Hans Mustermann"
referencestringrequired

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

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

The recipient's BIC.

Example: "COBADEFFXXX"
descriptionstring

A description for the transaction, which will be visible to the customer and the recipient.

Example: "Example transaction"
end_to_end_idstring

End-to-end ID to use for the transaction.

change_request_enabledboolean

If set to true, then the customer initiating the transaction will receive a change request 2FA challenge. If false, then the legacy 2FA challenge will be used.

Default true
Example: true
verification_of_payee_idstring

The ID of a Verification of Payee that must be completed before making this transaction request. This verification confirms the recipient's identity and bank details. Will be mandatory starting on 09.10.2025

application/json
{
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "recipient_name": "Hans Mustermann",
  "recipient_iban": "DE32110101001000000029",
  "recipient_bic": "COBADEFFXXX",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "description": "Example transaction",
  "end_to_end_id": "",
  "change_request_enabled": true
}

Responses

This transaction already exists.

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

Index SEPA Credit Transfers for a person's account

Request

Returns an array containing all SEPA Credit Transfers for the person account specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[status]string

Filter on the status of the SepaCreditTransaction

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
]
Response
application/json
[
  {
    "id": "45bd0881-a79a-4054-9286-f11060d5511f",
    "status": "executed",
    "reference": "8880a72c-2675-482d-8d88-70a02c608592",
    "amount": { … },
    "description": "string",
    "recipient_iban": "DE87110101001000057123",
    "recipient_name": "Max Mustermann",
    "recipient_bic": "SOBKDEB2XXX",
    "end_to_end_id": "END2ENDREJ",
    "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
    "created_at": "2021-01-01T20:37:50Z"
  }
]

Retrieve a SEPA Credit Transfer

Request

Returns information about the SEPA Credit Transfer specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

Create a SEPA Credit Transfer from a billing account

Request

Creates a SEPA Credit Transfer from the billing account specified in the request URL to the account specified in the request body.

Path
account_idstringrequired
Bodyapplication/jsonrequired

The content of the request.

recipient_ibanstringrequired

The recipient's IBAN.

Example: "DE32110101001000000029"
referencestring

Optional reference for the transaction. Will act as an idempotency key.

recipient_namestring

The recipient's name.

Example: "Hans Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "COBADEFFXXX"
amountobject

The amount to transfer to the recipient.

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

Optional description for the transaction, which will be visible to the recipient. Limited to 140 characters.

Example: "Example transaction"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process.

application/json
{
  "reference": "",
  "recipient_name": "Hans Mustermann",
  "recipient_iban": "DE32110101001000000029",
  "recipient_bic": "COBADEFFXXX",
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "description": "Example transaction",
  "end_to_end_id": ""
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

Show a SEPA Credit Transfer from a billing account

Request

Returns the details of a single SEPA Credit Transfer transaction. You must add the account_id of your billing account and the transaction id in the request URL.

Path
account_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

(Legacy) Authorize SEPA Credit Transfer

Request

Initiates a 2FA challenge to the customer for a SEPA Credit Transfer. This endpoint is deprecated; please use the change request service instead.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

delivery_methodstring

The method to use for delivering the 2FA challenge to the customer.

Enum"device_signing""mobile_number"
Example: "device_signing"
application/json
{
  "delivery_method": "device_signing"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

(Legacy) Confirm SEPA Credit Transfer

Request

Submits the authorization code from a 2FA challenge to confirm a SEPA Credit Transfer. This endpoint is deprecated; please use the change request service instead.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

authorization_tokenstring

The authorization token from the 2FA challenge.

application/json
{
  "authorization_token": ""
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Enum"created""authorization_required""confirmation_required""accepted""declined""executed""review_needed""scheduled""canceled"
Example: "executed"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject

The amount of the transaction.

descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process. Please note the SEPA character restrictions.

Example: "END2ENDREJ"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
Response
application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "executed",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z"
}

(Legacy) Batch Transfer

Operations

SEPA Instant Credit Transfers

Operations

(Legacy) Standing orders

Operations

(Legacy) Timed orders

Operations

SDD Collection Limits

Operations

SDD Collection Applications

Operations

SDD Collections

Operations

SEPA Credit Batch Transfers

Operations

Scheduled Transfers

Operations

Sepa Instant Limits

Operations

Verification of Payee

Operations

(Legacy) SEPA Direct Debit for freelancers

Operations

(Legacy) SEPA Direct Debit for business

Operations

(Legacy) SEPA Direct Debit profile templates

Operations