# Swiss NextGen Banking API-Framework API

> Swiss NextGen Banking API-Framework API on Apizie: 34 endpoints (Read account list, Read account details, Read balance, Read transaction list of an account, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/finance:openbankingproject-ch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:openbankingproject-ch`
- Category: Finance
- Status: byok
- Source: https://www.openbankingproject.ch
- Page: https://apizie.tech/api/finance/openbankingproject-ch
- OpenAPI: https://apizie.tech/api/finance/openbankingproject-ch/openapi.json

# Summary The **Swiss NextGen API** is based on the NextGenPSD2 *Framework Version 1.3.4* of the Berlin Group which offers a modern, open, harmonised and interoperable set of Application Programming Interfaces (APIs)…

## Endpoints

### Read account list
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-account-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| withBalance | boolean | no | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the… |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID | string | yes | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Read account details
`GET https://apizie.tech/v1/finance:openbankingproject-ch/read-account-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account-id | string | yes | This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card… |
| withBalance | boolean | no | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the… |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID | string | yes | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Read balance
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account-id | string | yes | This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card… |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID | string | yes | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Read transaction list of an account
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-transaction-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account-id | string | yes | This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card… |
| dateFrom | string | no | Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if… |
| dateTo | string | no | End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used.… |
| entryReferenceFrom | string | no | This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification… |
| bookingStatus | string | yes | Permitted codes are * "information", * "booked", * "pending", and * "both" "booked" shall be supported by the ASPSP. To support the… |
| deltaList | boolean | no | This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the… |
| withBalance | boolean | no | If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the… |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID | string | yes | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Read transaction details
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-transaction-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account-id | string | yes | This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card… |
| transactionId | string | yes | This identification is given by the attribute transactionId of the corresponding entry of a transaction list. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID | string | yes | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Create consent
`POST https://apizie.tech/v1/finance:openbankingproject-ch/create-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Explicit-Authorisation-Preferred | boolean | no | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This… |
| TPP-Brand-Logging-Information | string | no | This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-IP-Address | string | yes | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available,… |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Get consent request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-consent-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Delete Consent
`POST https://apizie.tech/v1/finance:openbankingproject-ch/delete-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Get consent authorisation sub-resources request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-consent-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Start the authorisation process for a consent
`POST https://apizie.tech/v1/finance:openbankingproject-ch/start-consent-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Read the SCA status of the consent authorisation
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-consent-sca-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Update PSU Data for consents
`POST https://apizie.tech/v1/finance:openbankingproject-ch/update-consents-psu-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Consent status request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-consent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentId | string | yes | ID of the corresponding consent object as returned by an account information consent request. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Confirmation of funds request
`POST https://apizie.tech/v1/finance:openbankingproject-ch/check-availability-of-funds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| body | object | yes | JSON request body |

### Create a signing basket resource
`POST https://apizie.tech/v1/finance:openbankingproject-ch/create-signing-basket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| Consent-ID | string | no | This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then… |
| PSU-IP-Address | string | yes | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available,… |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Explicit-Authorisation-Preferred | boolean | no | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Returns the content of an signing basket object
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-signing-basket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Delete the signing basket
`POST https://apizie.tech/v1/finance:openbankingproject-ch/delete-signing-basket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Get signing basket authorisation sub-resources request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-signing-basket-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Start the authorisation process for a signing basket
`POST https://apizie.tech/v1/finance:openbankingproject-ch/start-signing-basket-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Read the SCA status of the signing basket authorisation
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-signing-basket-sca-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Update PSU data for signing basket
`POST https://apizie.tech/v1/finance:openbankingproject-ch/update-signing-basket-psu-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Read the status of the signing basket
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-signing-basket-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| basketId | string | yes | This identification of the corresponding signing basket object. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Payment initiation request
`POST https://apizie.tech/v1/finance:openbankingproject-ch/initiate-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| Consent-ID | string | no | This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then… |
| PSU-IP-Address | string | yes | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available,… |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Explicit-Authorisation-Preferred | boolean | no | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This… |
| TPP-Rejection-NoFunds-Preferred | boolean | no | If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation… |
| TPP-Brand-Logging-Information | string | no | This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | yes | JSON request body |

### Get payment information
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Payment cancellation request
`POST https://apizie.tech/v1/finance:openbankingproject-ch/cancel-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Explicit-Authorisation-Preferred | boolean | no | If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This… |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Get payment initiation authorisation sub-resources request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-initiation-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Start the authorisation process for a payment initiation
`POST https://apizie.tech/v1/finance:openbankingproject-ch/start-payment-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Read the SCA status of the payment authorisation
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-initiation-sca-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Update PSU data for payment initiation
`POST https://apizie.tech/v1/finance:openbankingproject-ch/update-payment-psu-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-initiation-cancellation-authorisation-informatio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Start the authorisation process for the cancellation of the addressed payment
`POST https://apizie.tech/v1/finance:openbankingproject-ch/start-payment-initiation-cancellation-authorisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | boolean | no | If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected… |
| TPP-Redirect-URI | string | no | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically… |
| TPP-Nok-Redirect-URI | string | no | If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a… |
| TPP-Notification-URI | string | no | URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the… |
| TPP-Notification-Content-Preferred | string | no | The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The… |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Read the SCA status of the payment cancellation's authorisation
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-cancellation-sca-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

### Update PSU data for payment initiation cancellation
`POST https://apizie.tech/v1/finance:openbankingproject-ch/update-payment-cancellation-psu-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| authorisationId | string | yes | Resource identification of the related SCA. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string | no | Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an… |
| PSU-ID-Type | string | no | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then… |
| PSU-Corporate-ID | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string | no | Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
| body | object | no | JSON request body |

### Payment initiation status request
`GET https://apizie.tech/v1/finance:openbankingproject-ch/get-payment-initiation-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment-service | string | yes | Payment service: Possible values are: * payments * bulk-payments * periodic-payments |
| payment-product | string | yes | The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment… |
| paymentId | string | yes | Resource identification of the generated payment initiation resource. |
| X-Request-ID | string | yes | ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string | no | Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string | no | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string | no | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string | no | The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string | no | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string | no | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string | no | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string | no | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE |
| PSU-Device-ID | string | no | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device… |
| PSU-Geo-Location | string | no | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |

## Example
```
curl "https://apizie.tech/v1/finance:openbankingproject-ch/get-account-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Swiss NextGen Banking API-Framework API?
Create a free Apizie key, then send GET https://apizie.tech/v1/finance:openbankingproject-ch/get-account-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Swiss NextGen Banking API-Framework API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Swiss NextGen Banking API-Framework itself also needs your own key from openbankingproject.ch.

### Can AI agents use the Swiss NextGen Banking API-Framework API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:openbankingproject-ch.

### What is the status of the Swiss NextGen Banking API-Framework API?
Needs your own provider key (bring your own key)