Skip to content
/Scheduled 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

(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

Create a Scheduled Transfer

Request

Creates a scheduled transfer for the account specified in the request URL. Note: This call triggers the change request process.

Path
account_idstringrequired

The ID of the account to create a scheduled transfer for.

Bodyapplication/json

The content of the request.

transfer_typestringrequired

The type of transfer to be scheduled.

Enum"SCT""SCT_INSTANT"
Example: "SCT"
authorizer_idstringrequired

The ID of the person who should authorize the scheduled transfer.

Example: "cf67beb032b2abbfc444f1641fa669bccper"
creditor_ibanstringrequired

The recipient's IBAN.

Example: "DE32110101001000000029"
creditor_namestringrequired

The recipient's name.

Example: "Hans Mustermann"
initiator_referencestringrequired

A reference provided by the transaction initiator. It needs to be unique for the initiator.

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

The amount of the scheduled transfer transaction (in Euro cents).

amount.​valueinteger
Example: 1000
amount.​currencystring

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

Example: "EUR"
active_fromstring(date)required

The date on which the scheduled transfer will become active. The first transfer will be executed on this date.

Example: "2018-03-01"
execution_schedulestringrequired

The frequency at which to execute the scheduled transfer.

Enum"WEEKLY""EVERY_TWO_WEEKS""MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY""ONE-TIME"
Example: "MONTHLY"
creditor_bicstring

The recipient's BIC.

Example: "COBADEFFXXX"
descriptionstring

A description for the scheduled transfer.

Example: "Example scheduled transfer"
end_to_end_idstring

End-to-end ID to use in the scheduled transfer transactions.

Example: "unique-end-to-end-id"
active_tostring(date)

The date by which the scheduled transfer will be concluded. The last transfer will be executed before or on this date. For one-time transfers, this field is not required and will default to the active_from date.

Example: "2018-04-01"
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

Example: "f874b3102718a4d757a6b6e4d5996078veop"
application/json
{
  "transfer_type": "SCT",
  "initiator_reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "creditor_name": "Hans Mustermann",
  "creditor_iban": "DE32110101001000000029",
  "creditor_bic": "COBADEFFXXX",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "description": "Example scheduled transfer",
  "end_to_end_id": "unique-end-to-end-id",
  "execution_schedule": "MONTHLY",
  "active_from": "2018-03-01",
  "active_to": "2018-04-01",
  "authorizer_id": "cf67beb032b2abbfc444f1641fa669bccper",
  "verification_of_payee_id": "f874b3102718a4d757a6b6e4d5996078veop"
}

Responses

The change request was successfully confirmed, and the scheduled transfer successful.

Bodyapplication/json
idstring

Unique ID of the scheduled transfer.

Example: "f874b3102718a4d757a6b6e4d599607csctr"
account_idstring

The account ID of the account that the scheduled transfer is associated with.

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the scheduled transfer.

Enum"AUTHORIZATION_REQUIRED""ACTIVE""CANCELED""CONCLUDED"
Example: "ACTIVE"
transfer_typestring

The type of the scheduled transfer.

Enum"SCT""SCT_INSTANT"
Example: "SCT"
creditor_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
creditor_namestring<= 70 characters

The recipient's name.

Example: "Hans Mustermann"
creditor_bicstring

The recipient's BIC.

Example: "COBADEFFXXX"
initiator_referencestring

Reference provided by the transaction initiator. It needs to be unique for the initiator.

Example: "dsf2r3raedfs3fsf342fctrx"
amountobject

The amount of the scheduled transfer transaction (in Euro cents).

descriptionstring<= 140 characters

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

active_fromstring(date)

The date on which the scheduled transfer will become active. The first transfer will be executed on this date.

Example: "2025-09-01"
active_tostring(date)

The date by which the scheduled transfer will become concluded. The last transfer will be executed before or on this date. For one-time transfers this field will default to the active_from date.

Example: "2026-09-01"
execution_schedulestring

The frequency at which to execute the scheduled transfer.

Enum"WEEKLY""EVERY_TWO_WEEKS""MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY""ONE-TIME"
Example: "MONTHLY"
end_to_end_idstring<= 35 characters

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

Example: "END2ENDREJ"
next_execution_datestring(date)

Next execution_schedule for this scheduled transfer

Example: "2025-10-01"
authorizer_idstring

The ID of the person who authorized the scheduled transfer.

Example: "cf67beb032b2abbfc444f1641fa669bccper"
verification_of_payee_idstring

The ID of the verification of payee process that was used to verify the recipient's name and IBAN.

Example: "f874b3102718a4d757a6b6e4d599607cvope"
created_atstring(date-time)

UTC timestamp from the time the scheduled transfer was created.

Example: "2022-04-21T13:59:52+00:00"
updated_atstring(date-time)

UTC timestamp from the last time the scheduled transfer was updated.

Example: "2022-04-21T13:59:52+00:00"
Response
application/json
{
  "id": "f874b3102718a4d757a6b6e4d599607csctr",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "ACTIVE",
  "transfer_type": "SCT",
  "creditor_iban": "DE87110101001000057123",
  "creditor_name": "Hans Mustermann",
  "creditor_bic": "COBADEFFXXX",
  "initiator_reference": "dsf2r3raedfs3fsf342fctrx",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "description": "string",
  "active_from": "2025-09-01",
  "active_to": "2026-09-01",
  "execution_schedule": "MONTHLY",
  "end_to_end_id": "END2ENDREJ",
  "next_execution_date": "2025-10-01",
  "authorizer_id": "cf67beb032b2abbfc444f1641fa669bccper",
  "verification_of_payee_id": "f874b3102718a4d757a6b6e4d599607cvope",
  "created_at": "2022-04-21T13:59:52+00:00",
  "updated_at": "2022-04-21T13:59:52+00:00"
}

Get scheduled transfers for an account

Request

Returns the scheduled transfers for the account specified in the request URL.

Path
account_idstringrequired

The ID of the account to retrieve scheduled transfers for.

Query
page[number]string

The page number of the response.

page[size]string

The size of each page in the response.

filter[id]string

Filters the results to include only scheduled transfers with the given ID.

filter[transfer_type]string

Filters the results to include only scheduled transfers of a given type.

filter[status]string

Filters the results to include only scheduled transfers with a given status.

filter[next_execution_date][min]string

Filters the results to include only scheduled transfers with next execution date greater than or equal to the given date.

filter[next_execution_date][max]string

Filters the results to include only scheduled transfers with next execution date less than or equal to the given date.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the scheduled transfer.

Example: "f874b3102718a4d757a6b6e4d599607csctr"
account_idstring

The account ID of the account that the scheduled transfer is associated with.

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the scheduled transfer.

Enum"AUTHORIZATION_REQUIRED""ACTIVE""CANCELED""CONCLUDED"
Example: "ACTIVE"
transfer_typestring

The type of the scheduled transfer.

Enum"SCT""SCT_INSTANT"
Example: "SCT"
creditor_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
creditor_namestring<= 70 characters

The recipient's name.

Example: "Hans Mustermann"
creditor_bicstring

The recipient's BIC.

Example: "COBADEFFXXX"
initiator_referencestring

Reference provided by the transaction initiator. It needs to be unique for the initiator.

Example: "dsf2r3raedfs3fsf342fctrx"
amountobject

The amount of the scheduled transfer transaction (in Euro cents).

descriptionstring<= 140 characters

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

active_fromstring(date)

The date on which the scheduled transfer will become active. The first transfer will be executed on this date.

Example: "2025-09-01"
active_tostring(date)

The date by which the scheduled transfer will become concluded. The last transfer will be executed before or on this date. For one-time transfers this field will default to the active_from date.

Example: "2026-09-01"
execution_schedulestring

The frequency at which to execute the scheduled transfer.

Enum"WEEKLY""EVERY_TWO_WEEKS""MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY""ONE-TIME"
Example: "MONTHLY"
end_to_end_idstring<= 35 characters

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

Example: "END2ENDREJ"
next_execution_datestring(date)

Next execution_schedule for this scheduled transfer

Example: "2025-10-01"
authorizer_idstring

The ID of the person who authorized the scheduled transfer.

Example: "cf67beb032b2abbfc444f1641fa669bccper"
verification_of_payee_idstring

The ID of the verification of payee process that was used to verify the recipient's name and IBAN.

Example: "f874b3102718a4d757a6b6e4d599607cvope"
created_atstring(date-time)

UTC timestamp from the time the scheduled transfer was created.

Example: "2022-04-21T13:59:52+00:00"
updated_atstring(date-time)

UTC timestamp from the last time the scheduled transfer was updated.

Example: "2022-04-21T13:59:52+00:00"
]
Response
application/json
[
  {
    "id": "f874b3102718a4d757a6b6e4d599607csctr",
    "account_id": "236f9042a19b65c0867e10c922b93502cacc",
    "status": "ACTIVE",
    "transfer_type": "SCT",
    "creditor_iban": "DE87110101001000057123",
    "creditor_name": "Hans Mustermann",
    "creditor_bic": "COBADEFFXXX",
    "initiator_reference": "dsf2r3raedfs3fsf342fctrx",
    "amount": { … },
    "description": "string",
    "active_from": "2025-09-01",
    "active_to": "2026-09-01",
    "execution_schedule": "MONTHLY",
    "end_to_end_id": "END2ENDREJ",
    "next_execution_date": "2025-10-01",
    "authorizer_id": "cf67beb032b2abbfc444f1641fa669bccper",
    "verification_of_payee_id": "f874b3102718a4d757a6b6e4d599607cvope",
    "created_at": "2022-04-21T13:59:52+00:00",
    "updated_at": "2022-04-21T13:59:52+00:00"
  }
]

Get a single Scheduled Transfer

Request

Returns the details of the scheduled transfer specified in the request URL.

Path
idstringrequired

The ID of the scheduled transfer to retrieve.

account_idstringrequired

The account ID of the account that the scheduled transfer is associated with.

No request payload

Responses

Scheduled transfer successfully retrieved.

Bodyapplication/json
idstring

Unique ID of the scheduled transfer.

Example: "f874b3102718a4d757a6b6e4d599607csctr"
account_idstring

The account ID of the account that the scheduled transfer is associated with.

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the scheduled transfer.

Enum"AUTHORIZATION_REQUIRED""ACTIVE""CANCELED""CONCLUDED"
Example: "ACTIVE"
transfer_typestring

The type of the scheduled transfer.

Enum"SCT""SCT_INSTANT"
Example: "SCT"
creditor_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
creditor_namestring<= 70 characters

The recipient's name.

Example: "Hans Mustermann"
creditor_bicstring

The recipient's BIC.

Example: "COBADEFFXXX"
initiator_referencestring

Reference provided by the transaction initiator. It needs to be unique for the initiator.

Example: "dsf2r3raedfs3fsf342fctrx"
amountobject

The amount of the scheduled transfer transaction (in Euro cents).

descriptionstring<= 140 characters

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

active_fromstring(date)

The date on which the scheduled transfer will become active. The first transfer will be executed on this date.

Example: "2025-09-01"
active_tostring(date)

The date by which the scheduled transfer will become concluded. The last transfer will be executed before or on this date. For one-time transfers this field will default to the active_from date.

Example: "2026-09-01"
execution_schedulestring

The frequency at which to execute the scheduled transfer.

Enum"WEEKLY""EVERY_TWO_WEEKS""MONTHLY""QUARTERLY""EVERY_SIX_MONTHS""ANNUALLY""ONE-TIME"
Example: "MONTHLY"
end_to_end_idstring<= 35 characters

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

Example: "END2ENDREJ"
next_execution_datestring(date)

Next execution_schedule for this scheduled transfer

Example: "2025-10-01"
authorizer_idstring

The ID of the person who authorized the scheduled transfer.

Example: "cf67beb032b2abbfc444f1641fa669bccper"
verification_of_payee_idstring

The ID of the verification of payee process that was used to verify the recipient's name and IBAN.

Example: "f874b3102718a4d757a6b6e4d599607cvope"
created_atstring(date-time)

UTC timestamp from the time the scheduled transfer was created.

Example: "2022-04-21T13:59:52+00:00"
updated_atstring(date-time)

UTC timestamp from the last time the scheduled transfer was updated.

Example: "2022-04-21T13:59:52+00:00"
Response
application/json
{
  "id": "f874b3102718a4d757a6b6e4d599607csctr",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "ACTIVE",
  "transfer_type": "SCT",
  "creditor_iban": "DE87110101001000057123",
  "creditor_name": "Hans Mustermann",
  "creditor_bic": "COBADEFFXXX",
  "initiator_reference": "dsf2r3raedfs3fsf342fctrx",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "description": "string",
  "active_from": "2025-09-01",
  "active_to": "2026-09-01",
  "execution_schedule": "MONTHLY",
  "end_to_end_id": "END2ENDREJ",
  "next_execution_date": "2025-10-01",
  "authorizer_id": "cf67beb032b2abbfc444f1641fa669bccper",
  "verification_of_payee_id": "f874b3102718a4d757a6b6e4d599607cvope",
  "created_at": "2022-04-21T13:59:52+00:00",
  "updated_at": "2022-04-21T13:59:52+00:00"
}

Cancel a Scheduled Transfer

Request

Cancels the scheduled transfer specified in the request URL. Note that the customer must already have authorized and confirmed scheduled transfer. Note: This call triggers the change request process.

Path
idstringrequired

The ID of the scheduled transfer to cancel.

account_idstringrequired

The account ID of the account that the scheduled transfer is associated with.

Bodyapplication/json

The content of the request.

authorizer_idstringrequired

The ID of the person who should authorize the scheduled transfer.

Example: "cf67beb032b2abbfc444f1641fa679bccper"
application/json
{
  "authorizer_id": "cf67beb032b2abbfc444f1641fa679bccper"
}

Responses

The request is accepted, and the customer must confirm the change request.

Bodyapplication/json
idstring

ID of the change request.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
statusstring

The current status of the change request.

Enum"ACCEPTED""AUTHORIZATION_REQUIRED""CONFIRMATION_REQUIRED""COMPLETED""FAILED"
Example: "CONFIRMATION_REQUIRED"
updated_atstring(date-time)

UTC timestamp from the last time the change request was updated.

Example: "2022-04-21T13:59:52+00:00"
urlstring

URL to use to authorize the change request.

Example: "https://example.com/authorize"
Response
application/json
{
  "id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "status": "CONFIRMATION_REQUIRED",
  "updated_at": "2022-04-21T13:59:52+00:00",
  "url": "https://example.com/authorize"
}

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