OPopenbankingproject-ch
Signing Baskets Service (SBS)
Common Services

Read the status of the signing basket

Changed on

Returns the status of a signing basket object.

get/v1/signing-baskets/{basketId}/status

Request

  • Base URL
    https://api.dev.openbankingproject.ch
  • URL
    https://api.dev.openbankingproject.ch/v1/signing-baskets/{basketId}/status
  • Auth
    • none
    • or HTTP bearer

Path parameters

basketIdstring required

Resource identification of the generated signing basket resource.

Example:1234-basket-567

This identification of the corresponding signing basket object.

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

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 OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.

PSU-ID-Typestring

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 defined in the ASPSP's documentation.

PSU-Corporate-IDstring

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Typestring

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

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

transactionStatus'ACSC' | 'ACTC' | 'PATC' | 'RCVD' | 'RJCT' | 'CANC' required

The transaction status is filled with codes of the ISO 20022 data table. Only the codes RCVD, PATC, ACTC, ACWC and RJCT are used:

  • 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
  • 'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful.
  • 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent.
  • 'RCVD': 'Received' - Payment initiation has been received by the receiving agent.
  • 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example response

{
  "transactionStatus": "RCVD"
}

Changes

  • 0d82c4699548Revision changes
    • 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)

  • b51fe6ddb1fcRevision changes
    • 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)

    • 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

      api tag Signing Baskets Service (SBS) added

    • info

      api tag Signing Baskets (SBS) removed

    • 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)