/ics/v3/payments/domestic-transfer

post

https://sandbox.neonomics.io/ics/v3/payments/domestic-transfer

Initiates a domestic payment. The debtorAccount can be either 'iban', 'bban', or 'sortCodeAccountNumber'. The creditorAccount can be either 'iban', 'bban', or 'sortCodeAccountNumber' (UK).
To enable a custom redirect, include the x-redirect-url parameter in the request header. The callback will then include a resource_id (the payment-id) and a result
(the request's status, either 'OK' or 'FAILED'). This API will return 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, if a domestic payment is initiated as an "instant" payment, the response will include two additional fields: transactionFeesCurrency and transactionFeesAmount.
These fields represent the currency and amount of the transaction fees for the "instant" payment, as charged by the bank.

Note:If a domestic payment is initiated as an "instant" payment, remittanceInformationStructured is not allowed. Only remittanceInformationUnstructured may be used in this case.

This endpoint is also used to initiate a Danish GIRO/FIK payment slip (currently only supported for Lunar). To do so, include paymentMetadata.countryMetadata.DK.paymentSlipType in the request with the "kortart" code printed on the slip (GIRO: "01", "04", "15"; FI/FIK: "71", "73", "75"). When this field is set, creditorAccount.bban must be the slip's creditor number (max 8 characters, rather than a normal DK BBAN) and debtorAccount.bban is required. See the paymentSlip request example below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

debtorAccount

object

required

Debtor account info, which consists of the account scheme (account type) and the account identifier (account number).
The account scheme can be either 'iban', 'bban', or 'sortCodeAccountNumber' (UK).
Note: The Curl request example lists examples of all possible account schemes, but you can use one account scheme only.

debtorName

string

required

Debtor's name (the payer).

creditorAccount

object

required

Creditor account info, which consists of the account scheme (account type) and the account identifier (account number).
The account scheme can be either 'iban', 'bban', or 'sortCodeAccountNumber' (UK).
Note: The Curl request example lists examples of all possible account schemes, but you can use one account scheme only.

creditorName

string

required

Creditor's name (the payee).

currency

string

enum

required

3 letter currency code for the account following ISO 4217.

Allowed:

instrumentedAmount

string

required

Monetary amount to be transferred. Currency precision ranges from zero to two decimal places,
separated by a dot as defined in the ISO 4217 and ISO 20022 standards.

remittanceInformationUnstructured

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 - 10, other banks in Sweden - 12, banks in Denmark - 40).
Note that either remittanceInformationUnstructured or remittanceInformationStructured must be included in the request.

remittanceInformationStructured

object

Unique identification for the payment, issued by the creditor in accordance with a national standard (e.g., 'KID' in Norway, 'OCR' in Sweden).
Note that either remittanceInformationUnstructured or remittanceInformationStructured must be included in the request.
Note: If a domestic payment is initiated as an "instant" payment, remittanceInformationStructured is not allowed. Only remittanceInformationUnstructured may be used in this case.

endToEndIdentification

string

paymentMetadata

object

Headers

x-session-id

string

required

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

x-device-id

string

required

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

x-redirect-url

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.

x-psu-ip-address

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.

x-psu-id

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".

x-psu-corporate-id

string

Corporate identifier of the end-user's organisation, used for business/corporate consents (the business-accounts scope).

Currently effective for Länsförsäkringar and Sparebanken Vest (Folio, bank folio.noSPAVNOBB).

Länsförsäkringar: required in addition to x-psu-id, and both are distinct. x-psu-id carries the
signing person's personnummer (SSN), type SSSN; x-psu-corporate-id carries the organisationsnummer
(org number), type SON. Confirmed with the bank: both values must be exactly 12 numeric digits — a
continuous digit string with no hyphens, spaces, letters, or special characters (e.g. 12345678-0987 is
not valid). Fewer or more than 12 digits fails validation.
Sparebanken Vest / Folio: required on both consent initiation and every subsequent account/transaction
read, not only at consent time. Carries the 9-digit Norwegian organisation number. x-psu-id is optional
here and, if sent, must be the authorising person's national identifier — never the organisation number.

For all other banks this header is currently ignored, even those whose corporate flows rely on a corporate
identifier (e.g. DNB) — those flows continue to work via x-psu-id as today. Do not rely on this header for any
bank other than the ones listed above; support for additional banks may be added later.

Ignored for personal-scope consents.

x-originating-host

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.

x-originating-date

string

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

Signature

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.

Digest

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.

domestic-payment-type

string

Specifies the type of domestic payment to be initiated.

Accepted values: "instant", "same-day".
If set to "instant", an instant domestic payment will be initiated.
If set to "same-day", a same-day payment will be initiated.

This header is applicable only for banks that support the "instant-domestic-transfer" service.

Responses

200OK

510Returned when the request is invalid due to client-side issues, such as missing or incorrect parameters. Check your request and refer to the Client Error Codes for details.

520Indicates a problem within the Neonomics platform. This error is not caused by your request. See Neonomics Error Codes for troubleshooting steps.

530Returned when the bank encounters an error processing your request. Review the Bank Error Codes for more information and possible solutions.