GET v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{authorisationId}

openbankingproject.ch

Summary: Read the SCA status of the payment cancellation's authorisation
Operation ID: getPaymentCancellationScaStatus
Auth: unknown
Description

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Parameters (18)

Digest (string, header, optional)

Is contained if and only if the "Signature" element is contained in the header of the request.

PSU-Accept (string, header, optional)

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, header, optional)

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, header, optional)

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, header, optional)

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Device-ID (string, header, optional)

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.

PSU-Geo-Location (string, header, optional)

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Constraints: {'pattern': 'GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}'}

PSU-Http-Method (string, header, optional)

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

Constraints: {'enum': ['GET', 'POST', 'PUT', 'PATCH', 'DELETE']}

PSU-IP-Address (string, header, optional)

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port (string, header, optional)

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-User-Agent (string, header, optional)

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

Signature (string, header, optional)

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate (string, header, optional)

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

X-Request-ID (string, header, required)

ID of the request, unique to the call, as determined by the initiating party.

authorisationId (?, path, required)

Resource identification of the related SCA.

payment-product (string, path, required)

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - domestic-swiss-credit-transfers-isr - domestic-swiss-credit-transfers - domestic-swiss-credit-transfers-qr - domestic-swiss-foreign-credit-transfers - swiss-sepa-credit-transfers - swiss-cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-cross-border-credit-transfers - pain.001-swiss-six-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

Constraints: {'enum': ['domestic-swiss-credit-transfers-isr', 'domestic-swiss-credit-transfers', 'domestic-swiss-credit-transfers-qr', 'domestic-swiss-foreign-credit-transfers', 'swiss-sepa-credit-transfers', 'swiss-cross-border-credit-transfers', 'pain.001-sepa-credit-transfers', 'pain.001-cross-border-credit-transfers', 'pain.001-swiss-six-credit-transfers']}

payment-service (string, path, required)

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

Constraints: {'enum': ['payments', 'bulk-payments', 'periodic-payments']}

paymentId (?, path, required)

Resource identification of the generated payment initiation resource.

No probe data for this endpoint yet.