Skip to main content

bLink API - payments-submission-service module (4.0.0.1-six)

Download OpenAPI specification:Download

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

payments

Submit payment instructions

Create new payments submission.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

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 payment submission status information

Retrieve a specific payment submission's status.

path Parameters
submissionId
required
string <= 35 characters
Example: submissionId

ID of payment submission to be retrieved.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Responses

Response samples

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

iso20022

Submit an ISO20022 XML payment instruction (PAIN.001)

Submit an XML pain.001 payment instruction according to the ISO20022 specification.

  • bLink supports payment instructions only in XML-Schema «pain.001.001.09».
header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

Request Body schema: application/xml
required

Payment instruction details as defined by data model.

string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Retrieve the status report for the requested XML ISO20022 payment instruction (PAIN.002).

  • bLink supports status reports only in XML-Schema «pain.002.001.10».
path Parameters
submissionId
required
string <= 35 characters
Example: submissionId

ID of payment submission to be retrieved.

header Parameters
Authorization
required
string

Bearer followed by a base64 encoded OAuth access token

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

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 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-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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

X-PSU-IP-Address
required
string

IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

X-PSU-User-Agent
required
string

User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

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
required
string

ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)

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