Create SCT payment
See XS2A Framework Implementation Guidelines, Section 5.3.1 and 11.1 for additional details.
Sample Request Body
"instructedAmount": {
"amount": "100.33",
"currency": "EUR"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "EUR"
},
"debtorAccount": {
"iban": "NO95360573002",
"currency": "NOK"
}
}
Query Parameters
Advertises whether or not logical duplicate payments should be allowed.
Header Parameters
- keyId must be formatted as
keyId="SN=XXX,CA=YYY"
whereXXX
is the serial number of the signing certificate in hexadecimal encoding andYYY
is the ful Distinguished Name of the Certificate Authority having certificate - algorithm must identify the same algorithm for the signature as presented in the signing certificate and should be
rsa-sha256
- headers must contain
date
,digest
,x-request-id
,psu-id
,psu-corporate-id
, andtpp-redirect-uri
when available - signature must be computed as
Base64(RSA-SHA256(signingString))
Set this to "amount-as-string", will make amounts be serialized as strings with the correct number of decimal points. Temporarily required , default serialization will be switched to string when all clients sends this header.
Advertises which content types, expressed as MIME types, the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Advertises which character set the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice within the Content-Type response header.
Advertises which content encoding, usually a compression algorithm, the client is able to understand. Using content negotiation, the server selects one of the proposals, uses it and informs the client of its choice with the Content-Encoding response header.
Advertises which natural languages the client is able to understand, and which locale variant is preferred. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Language response header.
The domain name of the server (for virtual hosting), and (optionally) the TCP port number on which the server is listening.
Request identifier, unique to the call, as determined by the TPP.
TPP session identifier.
URI of the TPP, where the transaction flow shalle be redirected to after a Redirect.
Set to false to automatically trigger biometric authentication for mobile apps whenever available. Default is true.
Base64 encoded sha256 or sha512 hash of the message body, used with the signature.
The Digest header is defined by RFC3230 and sha256/sha512 si defined by RFC5843.
The certificate used for signing the request in base64 encoding.
HTTP Message Signature as specified by https://tools.ietf.org/html/draft-cavage-http-signatures-10 with requirements imposed by Berlin Group's NextGenPSD2 Framework.
If any values in the signature header is ISO-8859-1 or UTF-8 encoded you need to URL encode the signature header according to RFC 2047 which means MIME encoding the signature.
Also the signature must be wrapped using this format: =?charset?encoding?encoded signature?=
Example of this encoding: =?utf-8?B?a2V5QTQsQ0E9Mi41LjQuOTc9IzB........jMTM1MDUzNDQ0ZTRmMmQ0NjUz?=
Java example of how to implement encoding:
if (charset.equals(StandardCharsets.UTF_8)) {
signature = String.format("=?utf-8?B?%s?=", Base64.getEncoder().encodeToString(signature.getBytes(StandardCharsets.UTF_8)));
}
The PSU identifier.
As an alternative to PSU-ID, the PSU can be identified by norwegian personal identification number (national identity number/D-number)
The PSU Corporate agreement identifier.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded value for the User-Agent header field between the PSU and TPP, if available.
The forwarded value for the Accept header field between the PSU and TPP, if available.
The forwarded value for the Accept-Charset header field between the PSU and TPP, if available.
The forwarded value for the Accept-Encoding header field between the PSU and TPP, if available.
The forwarded value for the Accept-Language header field between the PSU and TPP, if available.
Possible values: [GET
, POST
, PUT
, PATCH
, DELETE
]
The forwarded value for the HTTP method used between the PSU and TPP, if available.
The forwarded value of the device ID used by the PSU, if available.
The forwarded value of the Geo Location of the corresponding HTTP request between the PSU and TPP, if available.
Request Body required
payload
Possible values: <= 35 characters
An optional end-to-end identification for diagnostic and audit purposes.
instructedAmount object required
Possible values: <= 70 characters
The creditor's full name.
creditorAccount object required
creditorAddress object
debtorAccount object required
Possible values: non-empty
and <= 140 characters
Unstructured representation of remittance information. Supported character encodings are ASCII and UTF-8. Note that this information may be truncated or change encoding during processing.
Payment execution date as ISO 8601 Date.
- 201
- 400
- 401
- 403
- 404
- 500
CREATED
Schema
Possible values: [ACCP
, ACSC
, ACSP
, ACTC
, ACWC
, ACWP
, RCVD
, PDNG
, RJCT
, CANC
, PART
]
transactionFees object
Indicates if the created payment will incur a fee. The total transaction fee amount will then be available in the transactionFees property. This total will also include any currency conversion fees if applicable.
tppMessages object[]
Possible values: <= 512 characters
Text to be displayed to the PSU
_links object
{
"paymentId": "enc!!H6fD9HS7Y7peXJh1HqC34RFgGfF992bjabcRx5n==",
"transactionStatus": "RCVD",
"transactionFees": {
"amount": "100.33",
"currency": "NOK"
},
"transactionFeeIndicator": false,
"tppMessages": [
{
"category": "ERROR",
"code": "SYSTEM_ERROR",
"path": "/v1/payments/norwegian-domestic-credit-transfers",
"text": "Example text"
}
],
"psuMessage": "Preliminary calculated countervalue in NOK: 642.63",
"_links": {
"self": {
"href": "https://openbanking.sgsparebank.no/",
"verbs": [
"GET"
]
}
}
}
Bad Request
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873375",
"status": 400,
"system": "ERA-PSD2",
"code": "FORMAT_ERROR"
}
Unauthorized
Schema
_links object
{
"_links": {
"scaRedirect": {
"href": "https://openbanking.sgsparebank.no/tap?route_secesb_id=1&flow=psd2&state=ca477daf-d824-4f0b-b405-6c8fc385dc0b&locale=no-NB, no; q=1.0",
"verbs": [
"GET"
]
}
}
}
Forbidden
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873376",
"system": "ERA-PSD2",
"status": 403,
"code": "PRODUCT_INVALID"
}
Not Found
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873376",
"system": "ERA-PSD2",
"status": 404,
"code": "RESOURCE_UNKNOWN"
}
Internal Server Error
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873378",
"system": "ERA-PSD2",
"status": 500,
"code": "SYSTEM_ERROR"
}
POST /v1/payments/sepa-credit-transfers
Request
Request
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'
curl -L -X POST 'https://openbanking.sgsparebank.no/api/v1/payments/sepa-credit-transfers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"endToEndIdentification": "xxxx",
"instructedAmount": {
"amount": "100.33",
"currency": "NOK"
},
"creditorName": "Company 123",
"creditorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"creditorAddress": {
"street": "Street",
"buildingNumber": "56",
"postalCode": "7014",
"city": "Trondheim",
"country": "NO"
},
"debtorAccount": {
"iban": "DE89 3704 0044 0532 0130 00",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"requestedExecutionDate": "2018-06-07"
}'