OPopenbankingproject-ch
Payment Initiation Service (PIS)

Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources

Changed on

Retrieve a list of all created cancellation authorisation sub-resources.

get/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

Request

  • Base URL
    https://api.dev.openbankingproject.ch
  • URL
    https://api.dev.openbankingproject.ch/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
  • Auth
    • none
    • or HTTP bearer

Path parameters

payment-service'payments' | 'bulk-payments' | 'periodic-payments' required

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product'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' 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.

paymentIdstring required

Resource identification of the generated payment initiation resource.

Example:1234-wertiq-983

Headers

X-Request-IDstring required

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

Digeststring

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

Signaturestring

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

TPP-Signature-Certificatestring byte

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

PSU-IP-Addressstring ipv4

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

PSU-IP-Portstring

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

PSU-Acceptstring

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

PSU-Accept-Charsetstring

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

PSU-Accept-Encodingstring

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

PSU-Accept-Languagestring

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

PSU-User-Agentstring

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

PSU-Http-Method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-IDstring

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-Locationstring

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

Response

OK

authorisationIdsAuthorisationId[] required

An array of all authorisationIds.

Example response

{
  "authorisationIds": [
    "123auth456"
  ]
}

Changes

  • 0d82c4699548Revision changes
    • breaking

      the response's body type changed from array to object for status

    • warning

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)

    • warning

      added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)

    • warning

      added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

    • info

      added the required property to the response with the status

  • b51fe6ddb1fcRevision changes
    • breaking

      removed the enum value cross-border-credit-transfers from the path request parameter payment-product

    • breaking

      removed the enum value instant-sepa-credit-transfers from the path request parameter payment-product

    • breaking

      removed the enum value pain.001-instant-sepa-credit-transfers from the path request parameter payment-product

    • breaking

      removed the enum value pain.001-target-2-payments from the path request parameter payment-product

    • breaking

      removed the enum value sepa-credit-transfers from the path request parameter payment-product

    • breaking

      removed the enum value target-2-payments from the path request parameter payment-product

    • breaking

      the response's body type changed from object to array for status

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

    • warning

      removed the optional property / from the response with the status (media type: application/problem+json)

    • info

      added the new enum value domestic-swiss-credit-transfers to the path request parameter payment-product

    • info

      added the new enum value domestic-swiss-credit-transfers-isr to the path request parameter payment-product

    • info

      added the new enum value domestic-swiss-credit-transfers-qr to the path request parameter payment-product

    • info

      added the new enum value domestic-swiss-foreign-credit-transfers to the path request parameter payment-product

    • info

      added the new enum value pain.001-swiss-six-credit-transfers to the path request parameter payment-product

    • info

      added the new enum value swiss-cross-border-credit-transfers to the path request parameter payment-product

    • info

      added the new enum value swiss-sepa-credit-transfers to the path request parameter payment-product

    • info

      for the header request parameter PSU-Device-ID, the format was generalized from uuid to no format

    • info

      for the header request parameter X-Request-ID, the format was generalized from uuid to no format

    • info

      removed the SCA_INVALID enum value from the // response property for the response status (media type: application/problem+json)

    • info

      removed the SCA_INVALID enum value from the response property for the response status (media type: application/problem+json)

    • info

      removed the SCA_INVALID enum value from the // response property for the response status (media type: application/json)