Skip to content
/
SEPA Credit Batch Transfe...

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

Create a Batch Transfer

Request

Creates a batch 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 batch transfer for.

Bodyapplication/json

The content of the request.

transfer_typestringrequired

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestringrequired

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
transfersArray of objectsrequired

List of transfers to be processed as part of the batch.

transfers[].​creditor_ibanstringrequired

The recipient's IBAN.

Example: "DE87110101001000057123"
transfers[].​creditor_namestring<= 70 charactersrequired

The recipient's name.

Example: "Hans Mustermann"
transfers[].​amountobjectrequired

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

transfers[].​amount.​valueinteger

Amount described in smallest currency unit (e.g. cents).

Example: 1000
transfers[].​amount.​currencystring

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

Example: "EUR"
transfers[].​descriptionstring<= 140 characters

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

Example: "Salary Payment"
transfers[].​end_to_end_idstring

Transfer's transaction EndToEnd ID for later identification.

Example: "e2178fc8b9ad4a479e269a47f90b4a43"
transfers[].​initiator_referencestring

A unique reference for the transfer.

Example: "2603037c-e264-46c4-82e8-0d3ebc23a30f"
transfers[].​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.

Example: "1234567890abcdef1234567890abcdefvop"
descriptionstring

A description for the batch transfer.

Example: "Monthly Salary Payments"
application/json
{
  "transfer_type": "SCT_INSTANT",
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "description": "Monthly Salary Payments",
  "transfers": [
    { … }
  ]
}

Responses

The change request was successfully confirmed, and the batch transfer was accepted.

Bodyapplication/json
idstring

Unique ID of the batch transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
account_idstring

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

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"AUTHORIZATION_REQUIRED""ACCEPTED""REJECTED""IN_PROGRESS""FINISHED"
Example: "ACCEPTED"
transfer_typestring

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestring

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
descriptionstring<= 140 characters

Optional description for the batch.

Example: "Monthly Salary Payments"
total_amountnumber

The total amount of all planned transfers in the batch in cents.

Example: 1000
transfers_summaryobject

Summary of executed and failed transfer counts within the batch.

created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
started_atstring(date-time)

UTC timestamp when the batch transfer started the processing of all their transfers.

Example: "2025-04-01T14:01:00+00:00"
finished_atstring(date-time)

UTC timestamp when all transfers were processed and the status of the batch reached FINISHED.

Example: "2025-04-01T14:10:30+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
Response
application/json
{
  "id": "f874b3102718a4d757a6b6e4d5996078sctb",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "ACCEPTED",
  "transfer_type": "SCT_INSTANT",
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "description": "Monthly Salary Payments",
  "total_amount": 1000,
  "transfers_summary": {
    "executed": 9,
    "failed": 1
  },
  "created_at": "2025-04-01T13:59:52+00:00",
  "started_at": "2025-04-01T14:01:00+00:00",
  "finished_at": "2025-04-01T14:10:30+00:00",
  "updated_at": "2025-04-01T14:10:30+00:00"
}

List Batch Transfers

Request

List all batch transfers for the specified account in the request URL.

Path
account_idstringrequired

The ID of the account to retrieve batch 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 batch transfers with the given ID.

filter[transfer_type]string

Filters the results to include only batch transfers with the given transfer_type.

Enum"SCT""SCT_INSTANT"
filter[status]string

Filters the results to include only batch transfers with the given status.
Multiple comma-separated values are supported.

Enum"AUTHORIZATION_REQUIRED""ACCEPTED""REJECTED""IN_PROGRESS""FINISHED"
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the batch transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
account_idstring

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

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"AUTHORIZATION_REQUIRED""ACCEPTED""REJECTED""IN_PROGRESS""FINISHED"
Example: "ACCEPTED"
transfer_typestring

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestring

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
descriptionstring<= 140 characters

Optional description for the batch.

Example: "Monthly Salary Payments"
total_amountnumber

The total amount of all planned transfers in the batch in cents.

Example: 1000
transfers_summaryobject

Summary of executed and failed transfer counts within the batch.

created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
started_atstring(date-time)

UTC timestamp when the batch transfer started the processing of all their transfers.

Example: "2025-04-01T14:01:00+00:00"
finished_atstring(date-time)

UTC timestamp when all transfers were processed and the status of the batch reached FINISHED.

Example: "2025-04-01T14:10:30+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
]
Response
application/json
[
  {
    "id": "f874b3102718a4d757a6b6e4d5996078sctb",
    "account_id": "236f9042a19b65c0867e10c922b93502cacc",
    "status": "ACCEPTED",
    "transfer_type": "SCT_INSTANT",
    "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
    "description": "Monthly Salary Payments",
    "total_amount": 1000,
    "transfers_summary": { … },
    "created_at": "2025-04-01T13:59:52+00:00",
    "started_at": "2025-04-01T14:01:00+00:00",
    "finished_at": "2025-04-01T14:10:30+00:00",
    "updated_at": "2025-04-01T14:10:30+00:00"
  }
]

Read a Batch Transfer

Request

Retrieve a single batch transfer for the specified account in the request URL.

Path
account_idstringrequired

The ID of the account to retrieve batch transfers for.

batch_transfer_idstringrequired

The ID of the batch transfer.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the batch transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
account_idstring

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

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"AUTHORIZATION_REQUIRED""ACCEPTED""REJECTED""IN_PROGRESS""FINISHED"
Example: "ACCEPTED"
transfer_typestring

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestring

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
descriptionstring<= 140 characters

Optional description for the batch.

Example: "Monthly Salary Payments"
total_amountnumber

The total amount of all planned transfers in the batch in cents.

Example: 1000
transfers_summaryobject

Summary of executed and failed transfer counts within the batch.

created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
started_atstring(date-time)

UTC timestamp when the batch transfer started the processing of all their transfers.

Example: "2025-04-01T14:01:00+00:00"
finished_atstring(date-time)

UTC timestamp when all transfers were processed and the status of the batch reached FINISHED.

Example: "2025-04-01T14:10:30+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
Response
application/json
{
  "id": "f874b3102718a4d757a6b6e4d5996078sctb",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "ACCEPTED",
  "transfer_type": "SCT_INSTANT",
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "description": "Monthly Salary Payments",
  "total_amount": 1000,
  "transfers_summary": {
    "executed": 9,
    "failed": 1
  },
  "created_at": "2025-04-01T13:59:52+00:00",
  "started_at": "2025-04-01T14:01:00+00:00",
  "finished_at": "2025-04-01T14:10:30+00:00",
  "updated_at": "2025-04-01T14:10:30+00:00"
}

List Credit Transfers

Request

List all SEPA credit transfers for the specified account and batch in the request URL. All transfers in the result list are of the same type, which is specified in the batch itself.

Path
account_idstringrequired

The ID of the account

batch_transfer_idstringrequired

The ID of the batch transfer

Query
page[number]string

The page number of the response.

page[size]string

The size of each page in the response.

filter[created_at][min]string

Filters the results to include only transfers created after the specified date and time.

filter[created_at][max]string

Filters the results to include only transfers created before the specified date and time.

filter[creditor_iban]string

Filters the results to include only transfers with the given creditor_iban.
Multiple comma-separated values are supported.

filter[end_to_end_id]string

Filters the results to include only transfers with the given end_to_end_id.
Multiple comma-separated values are supported.

filter[id]string

Filters the results to include only transfers with the given ID.
Multiple comma-separated values are supported.

filter[initiator_reference]string

Filters the results to include only transfers with the given initiator_reference.
Multiple comma-separated values are supported.

filter[status]string

Filters the results to include only transfers with the given status.
Multiple comma-separated values are supported.

Enum"OPEN""EXECUTING""BOOKED""CANCELED""FAILED"
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the SEPA credit transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctx"
account_idstring

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

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"OPEN""EXECUTING""BOOKED""CANCELED""FAILED"
Example: "BOOKED"
typestring

The type for all transfers of the batch.

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

The recipient's IBAN.

Example: "DE87110101001000057123"
creditor_namestring

The recipient's name.

Example: "Hans Mustermann"
amountobject

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

descriptionstring

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

Example: "Salary Payment"
end_to_end_idstring

Transfer's transaction EndToEnd ID for later identification.

Example: "e2178fc8b9ad4a479e269a47f90b4a43"
initiator_referencestring

A unique reference for the transfer.

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

Details in case the status is FAILED.

Example: "Creditor IBAN is not SEPA instant reachable."
batch_idstring

ID of the batch (transfer) which initiated this SEPA credit transfer

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
schedule_idstring

ID of the scheduled transfer which initiated this SEPA credit transfer

Example: "f874b3102718a4d757a6b6e4d599607ccsto"
created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
]
Response
application/json
[
  {
    "id": "f874b3102718a4d757a6b6e4d5996078sctx",
    "account_id": "236f9042a19b65c0867e10c922b93502cacc",
    "status": "BOOKED",
    "type": "SCT_INSTANT",
    "creditor_iban": "DE87110101001000057123",
    "creditor_name": "Hans Mustermann",
    "amount": { … },
    "description": "Salary Payment",
    "end_to_end_id": "e2178fc8b9ad4a479e269a47f90b4a43",
    "initiator_reference": "2603037c-e264-46c4-82e8-0d3ebc23a30f",
    "failure_reason": "Creditor IBAN is not SEPA instant reachable.",
    "batch_id": "f874b3102718a4d757a6b6e4d5996078sctb",
    "schedule_id": "f874b3102718a4d757a6b6e4d599607ccsto",
    "created_at": "2025-04-01T13:59:52+00:00",
    "updated_at": "2025-04-01T14:10:30+00:00"
  }
]

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