/ics/v3/payments/sepa-scheduled-credit

Initiates a SEPA scheduled payment. The debtorAccount can be either 'IBAN', 'BBAN', or 'SORT_CODE_ACCOUNT_NUMBER'. (Note that some Finnish banks may currently not accept 'BBAN'); the creditorAccount must be 'IBAN'. The currency is always 'EUR'. To enable a custom redirect, include the x-redirect-url parameter in the request header. Returns a 1426 error if consent is required and a 1428 'payment authorization required' if the payment requires SCA. If you get error code '1428' then you have to call API '/ics/v3/payments/{paymentProduct}/{paymentId}/authorize' to get authorization URL. Once you receive url then you can use that to get authorized with respective bank.

Additionally, payments can be initiated without debtorAccount details (iban/bban) and debtor name if the supported service for the bank includes "sepa-scheduled-credit-without-debtor-details" (only for Finnish payments). Note that initiating payments without debtor details will not apply for cross-border scheduled SEPA payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
creditorAccount
object
required
debtorAccount
object
string

Debtor's name (the payer).

string
required

Creditor's name (the payee).

string
enum
required

3 letter currency code for the account following ISO 4217.

Allowed:
string
required
string

Remittance information about the payment, such as notes about the transaction. The maximum character limit is 140 (exceptions: Danske NO - 66, Bank Norwegian NO - 30 and 70 for Credit Card and Savings Accounts, respectively, Swedbank SE - 35, other banks in Sweden - 12, banks in Denmark - 40). Note that either remittanceInformationUnstructured or remittanceInformationStructured must be included in the request.

remittanceInformationStructured
object
string
paymentMetadata
object
string
required
Headers
string

Authentication scheme used to transmit the access token. Valid value is "Bearer {access token}".

string
required

The session Id returned in the response body when this session was created.

string
required

String that uniquely identifies a single end-user or device.

string

URL where the end-user gets redirected after a consent or payment authorization. The URL must be registered in the Developer Portal under the relevant application.

string
required

The IP Address of the end-user (PSU), which must be provided if the PSU actively requests information. If this value is not provided, then the call will count towards the number of TPP calls without PSU interaction. Leave it empty if the end user is not actively requesting account information, such as during automatic background updates. Provided in either IPv4 or IPv6 format.

string

Identifier of the end-user, passed as the base64-encoded value of an encrypted string following the guidelines given in Documentation > Development > Sensitive end-user data. This parameter is required if the value of 'personalIdentificationRequired' returned from the /banks endpoint is "true".

string

The host where the request is originating from. If you are using end to end encryption from our developer portal then this header is mandatory.

string

The request originating date. If you are using end to end encryption from our developer portal then this header is mandatory.

string

The signature header consisting of the signature string If you are using end to end encryption from our developer portal then this header is mandatory.

string
Defaults to application/json

If you are using end to end encryption from our developer portal then this header is mandatory for all post/put/patch requests.

string

A Base64-encoded hash of the request body If you are using end to end encryption from our developer portal then this header is mandatory for all post/put/patch requests.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json