bLink API - payments-submission-service module (5.0.0.1-SNAPSHOT-fi)
Download OpenAPI specification:Download
This is the specification of the bLink 'payments-submission-service' module API. (as implemented by providers (e.g. financial institutions) and used by SIX)
Submit payment instructions
Create new payments 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. |
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. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Request Body schema: application/jsonrequired
Payment instruction details as defined by data model.
bookingInstruction required | string (Payment Booking Instruction) Enum: "SINGLEBOOKING_SIA" "SINGLEBOOKING_NOA" "BATCHBOOKING_SALA_NOA" "BATCHBOOKING_SALA_CND" "BATCHBOOKING_NOA" "BATCHBOOKING_CND" "BATCHBOOKING_CWD" The payment booking instruction, i.e. the method for processing and grouping a payment. Corresponds to the attribute DbtrAcct ⇾ Tp ⇾ Prtry in SPS/ISO-20022. Possible methods are:
|
required | object (Payment IBAN Account) The IBAN account object. |
initiatingPartyId required | string (InitiatingPartyId) <= 32 characters The identifier of the third party provider (TPP) who created the payment instruction message derived from the OAuth 2.0 flow. |
messageId required | string (MessageId) <= 35 characters The unique identifier (UUID) of the the instruction message. Corresponds to the attribute MsgId in SPS/ISO-20022. |
requestedExecutionDate required | string <date> (Date) A date. |
required | Array of objects (Payment Instruction Item) The transaction items. |
Responses
Request samples
- Payload
{- "bookingInstruction": "BATCHBOOKING_SALA_CND",
- "debtorAccount": {
- "identification": "CH5481230000001998736",
- "type": "IBAN"
}, - "initiatingPartyId": "TPP01746",
- "messageId": "eb6305c91f7f49deaed016487c27b42d",
- "requestedExecutionDate": "2018-04-13",
- "transactions": [
- {
- "endToEndId": "ENDTOENDID-001",
- "instructedAmount": {
- "amount": "10.25",
- "currency": "CHF"
}, - "instructionId": "INSTR-001",
- "ibanDetails": {
- "chargeBearer": "SHAR",
- "creditor": {
- "name": "Hans Muster",
- "postalAddress": {
- "country": "CH",
- "townName": "Biel",
- "addressLine1": "Carribean At Keppel Bay",
- "addressLine2": "05-66",
- "buildingNumber": "24",
- "postCode": "2501",
- "streetName": "Rue de la gare"
}
}, - "creditorAccount": {
- "identification": "CH5481230000001998736",
- "type": "IBAN"
}, - "creditorAgent": {
- "bic": "DEUTDE5M101",
- "clearingSystemMemberIdentification": {
- "code": "CHBCC",
- "memberId": 230
}
}, - "remittanceInformation": "Rechnung Nr. 408",
- "remittanceReference": {
- "reference": "210000000003139471430009017",
- "type": "SCOR"
}, - "sepaIndicator": true
}, - "otherDetails": {
- "creditor": {
- "name": "Hans Muster",
- "postalAddress": {
- "country": "CH",
- "townName": "Biel",
- "addressLine1": "Carribean At Keppel Bay",
- "addressLine2": "05-66",
- "buildingNumber": "24",
- "postCode": "2501",
- "streetName": "Rue de la gare"
}
}, - "creditorAccount": {
- "identification": "01-39139-1",
- "type": "OTHER"
}, - "creditorAgent": {
- "bic": "DEUTDE5M101",
- "clearingSystemMemberIdentification": {
- "code": "CHBCC",
- "memberId": 230
}
}, - "chargeBearer": "SHAR",
- "remittanceReference": {
- "reference": "210000000003139471430009017",
- "type": "SCOR"
}, - "remittanceInformation": "Rechnung Nr. 408"
}, - "qrDetails": {
- "creditor": {
- "name": "Hans Muster",
- "postalAddress": {
- "country": "CH",
- "townName": "Biel",
- "addressLine1": "Carribean At Keppel Bay",
- "addressLine2": "05-66",
- "buildingNumber": "24",
- "postCode": "2501",
- "streetName": "Rue de la gare"
}
}, - "creditorAccount": {
- "identification": "CH5481230000001998736",
- "type": "IBAN"
}, - "remittanceInformation": "Rechnung Nr. 408",
- "remittanceReference": {
- "reference": "210000000003139471430009017",
- "type": "SCOR"
}, - "ultimateCreditor": {
- "name": "Hans Muster",
- "postalAddress": {
- "country": "CH",
- "townName": "Biel",
- "addressLine1": "Carribean At Keppel Bay",
- "addressLine2": "05-66",
- "buildingNumber": "24",
- "postCode": "2501",
- "streetName": "Rue de la gare"
}
}, - "ultimateDebtor": {
- "name": "Hans Muster",
- "postalAddress": {
- "country": "CH",
- "townName": "Biel",
- "addressLine1": "Carribean At Keppel Bay",
- "addressLine2": "05-66",
- "buildingNumber": "24",
- "postCode": "2501",
- "streetName": "Rue de la gare"
}
}
}, - "uetr": "fdc01a3e-4567-4abc-8def-1234567890ab"
}
]
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "submissionId": "618d4ac6e8a64e3d9f26aa3d8c4f323e"
}
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-CorAPI-Client-ID required | string ID of the client forwarded to the provider. |
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. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "statusCode": "PART",
- "messageId": "eb6305c91f7f49deaed016487c27b42d",
- "transactions": [
- {
- "instructionId": "INSTR-001",
- "statusCode": "RJCT",
- "reasonCode": "CURR",
- "reasonInformation": "currency USD not allowed for payment type IBAN"
}
]
}
Submit 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-CorAPI-Client-ID required | string ID of the client forwarded to the provider. |
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. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Request Body schema: application/xmlrequired
Payment instruction details as defined by data model.
Responses
Response samples
- 201
- 202
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "submissionId": "618d4ac6e8a64e3d9f26aa3d8c4f323e"
}
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-CorAPI-Client-ID required | string ID of the client forwarded to the provider. |
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. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Responses
Response samples
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
{- "detail": "Detailed problem description with respect to the current request",
- "title": "This is the general problem description",
- "type": "/problems/TECHNICAL_ERROR",
- "instance": "path/to/corresponding/resource"
}
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.
query Parameters
cursor | string Example: cursor=cursorIDxyz Optional parameter for pagination. Use the ID of the last item from the previous response to retrieve the next set of results. |
limit | integer <int32> >= 1 Default: 25 Example: limit=25 Optional parameter for pagination, specifying the number of items to return. The actual maximum limit can be defined by the provider. |
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. |
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. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
[- {
- "accountId": 13579,
- "iban": "CH9300762011623852957",
- "currency": "CHF",
- "accountOwner": "Account Owner XYZ",
- "designation": "Savings ABC",
- "allowedCurrencies": [
- "CHF"
]
}
]
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. |
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. |
X-CorAPI-Client-ID required | string ID of the client forwarded to the provider. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Responses
Response samples
- 200
- 500
- 501
- 502
- 503
- 504
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "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. |
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. |
X-CorAPI-Client-ID required | string ID of the client forwarded to the provider. |
X-PSU-IP-Address | string IP address of the user initiating the operation |
X-PSU-User-Agent | string User of the client software |
X-PSU-Accept-Lang | string Language of client software |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
"string"
Response samples
- 200
- 500
- 501
- 502
- 503
- 504
{- "requestDateTime": "2018-04-13T11:11:11Z",
- "receivedHeaders": [
- {
- "headerName": "X-Correlation-ID",
- "headerValue": "string"
}
], - "receivedPayload": "... as received ..."
}