Skip to main content
API docs by Redocly

bLink API - payments-submission-service module (3.0.3.4-fi)

Download OpenAPI specification:Download

URL: https://www.six-group.com/en/products-services/banking-services/blink.html

This is the specification of the bLink 'payments-submission-service' module API. (as implemented by providers (e.g. financial institutions) and used by SIX)

payments

payment initiation submission Payment Submission Service - third party payment instruction submission

Submit payment instructions

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Request Body schema: application/json
required

Payment instruction details as defined by data model.

messageId
required
string <= 35 characters
initiatingPartyId
required
string <= 32 characters
requestedExecutionDate
required
string <date>
required
object (Payment IBAN Account)
bookingInstruction
required
string (Payment Booking Instruction)
Enum: "SINGLEBOOKING_SIA" "SINGLEBOOKING_NOA" "BATCHBOOKING_SALA_NOA" "BATCHBOOKING_SALA_CND" "BATCHBOOKING_NOA" "BATCHBOOKING_CND" "BATCHBOOKING_CWD"
required
Array of objects (Payment Instruction Item)

Responses

Request samples

Content type
application/json
{
  • "messageId": "eb6305c91f7f49deaed016487c27b42d",
  • "initiatingPartyId": "TPP01746",
  • "requestedExecutionDate": "2018-04-07",
  • "debtorAccount": {
    },
  • "bookingInstruction": "BATCHBOOKING_SALA_CND",
  • "transactions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
  • "instance": "path/to/corresponding/resource"
}

Retrieve a payment submission

path Parameters
submissionId
required
string <= 35 characters

id of payment submission

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "messageId": "eb6305c91f7f49deaed016487c27b42d",
  • "initiatingPartyId": "TPP01746",
  • "requestedExecutionDate": "2018-04-07",
  • "debtorAccount": {
    },
  • "bookingInstruction": "BATCHBOOKING_SALA_CND",
  • "transactions": [
    ]
}

Retrieve payment submission status information

path Parameters
submissionId
required
string <= 35 characters

id of payment submission

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "messageId": "eb6305c91f7f49deaed016487c27b42d",
  • "statusCode": "PART",
  • "transactions": [
    ]
}

iso20022

Submit an ISO20022 XML payment instruction (PAIN.001)

Submit an ISO20022 XML PAIN.001 payment instruction. The submitted payment instruction must conform to the XML Schema and Implementation Guidelines defined by Swiss Payment Standards; see: https://www.six-interbank-clearing.com/en/home/standardization/iso-payments/customer-bank/implementation-guidelines.html

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Request Body schema: application/xml
required

Payment instruction details as defined by data model.

string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the submitted ISO20022 XML PAIN.001 message.

path Parameters
submissionId
required
string <= 35 characters

id of payment submission

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
  • "instance": "path/to/corresponding/resource"
}

Retrieve ISO20022 XML status report (PAIN.002) of a payment instruction

Retrieve the XML ISO20022 pain.002 status report. The returned status report must conform to the XML Schema and Implementation Guidelines defined by Swiss Payment Standards; see: https://www.six-interbank-clearing.com/en/home/standardization/iso-payments/customer-bank/implementation-guidelines.html

path Parameters
submissionId
required
string <= 35 characters

id of payment submission

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
  • "instance": "path/to/corresponding/resource"
}

consents

Retrieve a list of consents

The consents endpoint allows the client (e.g., a third party provider) to query the consents for a given corporate user. The provider (e.g., a financial institution) must return the consents linked with the access token supplied with the request.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters
X-Correlation-ID
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

Authorization
string

Bearer followed by a base64 encoded OAuth access token

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Responses

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}

Returns all specified request headers, the request body and additional diagnostic information

header Parameters
X-Correlation-ID
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

Authorization
string

Bearer followed by a base64 encoded OAuth access token

User-Agent
string

Name and version of the of the client software

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI - optional)

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the provider. (SCOPE: FI)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI - optional)

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}