Create a signing basket resource

{
  "type": "object",
  "description": "Body of the JSON response for a successful create signing basket request.",
  "required": [
    "_links",
    "basketId",
    "transactionStatus"
  ],
  "properties": {
    "_links": {
      "type": "object",
      "description": "A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the\nresponse depend on the dynamical decisions of the ASPSP when processing the request.\n\nRemark: All links can be relative or full links, to be decided by the ASPSP.\nType of links admitted in this response, (further links might be added for ASPSP defined\nextensions):\n\n  * 'scaRedirect':\n    In case of an SCA Redirect Approach, the ASPSP is transmitting the link to\n    which to redirect the PSU browser.\n  * 'scaOAuth':\n    In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of\n    the Authorisation Server can be retrieved. The configuration follows the\n    OAuth 2.0 Authorisation Server Metadata specification.\n  * 'startAuthorisation':\n    In case, where an explicit start of the transaction authorisation is needed,\n    but no more data needs to be updated (no authentication method to be selected,\n    no PSU identification nor PSU authentication data to be uploaded).\n  * 'startAuthorisationWithPsuIdentification':\n    The link to the authorisation end-point, where the authorisation sub-resource\n    has to be generated while uploading the PSU identification data.\n  * 'startAuthorisationWithPsuAuthentication':\n    The link to the authorisation end-point, where the authorisation sub-resource\n    has to be generated while uploading the PSU authentication data.\n  * 'startAuthorisationWithEncryptedPsuAuthentication':\n    The link to the authorisation end-point, where the authorisation sub-resource has\n    to be generated while uploading the encrypted PSU authentication data.\n  * 'startAuthorisationWithAuthenticationMethodSelection':\n    The link to the authorisation end-point, where the authorisation sub-resource\n    has to be generated while selecting the authentication method.\n    This link is contained under exactly the same conditions as the data element 'scaMethods'\n  * 'startAuthorisationWithTransactionAuthorisation':\n    The link to the authorisation end-point, where the authorisation sub-resource\n    has to be generated while authorising the transaction e.g. by uploading an\n    OTP received by SMS.\n  * 'self':\n    The link to the payment initiation resource created by this request.\n    This link can be used to retrieve the resource data.\n  * 'status':\n    The link to retrieve the transaction status of the payment initiation.\n  * 'scaStatus':\n    The link to retrieve the scaStatus of the corresponding authorisation sub-resource.\n    This link is only contained, if an authorisation sub-resource has been already created.\n",
      "properties": {
        "scaOAuth": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "scaRedirect": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "scaStatus": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "self": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisation": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisationWithAuthenticationMethodSelection": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisationWithEncryptedPsuAuthentication": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisationWithPsuAuthentication": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisationWithPsuIdentification": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "startAuthorisationWithTransactionAuthorisation": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        },
        "status": {
          "type": "object",
          "description": "Link to a resource.",
          "properties": {
            "href": {
              "type": "string",
              "description": "Link to a resource."
            }
          }
        }
      }
    },
    "basketId": {
      "type": "string",
      "description": "Resource identification of the generated signing basket resource."
    },
    "challengeData": {
      "type": "object",
      "description": "It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.\nIn rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.\n",
      "properties": {
        "additionalInformation": {
          "type": "string",
          "description": "Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.\n"
        },
        "data": {
          "type": "array",
          "description": "A collection of strings as challenge data.",
          "items": {
            "type": "string"
          }
        },
        "image": {
          "type": "string",
          "format": "byte",
          "description": "PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.\n"
        },
        "imageLink": {
          "type": "string",
          "description": "A link where the ASPSP will provides the challenge image for the TPP."
        },
        "otpFormat": {
          "type": "string",
          "description": "The format type of the OTP to be typed in. The admitted values are \"characters\" or \"integer\".",
          "enum": [
            "characters",
            "integer"
          ]
        },
        "otpMaxLength": {
          "type": "integer",
          "description": "The maximal length for the OTP to be typed in by the PSU."
        }
      }
    },
    "chosenScaMethod": {
      "type": "object",
      "description": "Authentication object.\n",
      "required": [
        "authenticationMethodId",
        "authenticationType"
      ],
      "properties": {
        "authenticationMethodId": {
          "type": "string",
          "description": "An identification provided by the ASPSP for the later identification of the authentication method selection.\n"
        },
        "authenticationType": {
          "type": "string",
          "description": "Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n  - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n  - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. \n    To contact the card, the PSU normally needs a (handheld) device. \n    With this device, the PSU either reads the challenging data through a visual interface like flickering or \n    the PSU types in the challenge through the device key pad. \n    The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n  - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data\n    which can be read in by a consumer device or specific mobile app.\n    The device resp. the specific app than derives an OTP from the visual challenge data and displays\n    the OTP to the PSU.\n  - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.\n  - 'SMTP_OTP': An OTP is sent via email to the PSU.\n",
          "enum": [
            "SMS_OTP",
            "CHIP_OTP",
            "PHOTO_OTP",
            "PUSH_OTP",
            "SMTP_OTP"
          ]
        },
        "authenticationVersion": {
          "type": "string",
          "description": "Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.\n"
        },
        "explanation": {
          "type": "string",
          "description": "Detailed information about the SCA method for the PSU.\n"
        },
        "name": {
          "type": "string",
          "description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n"
        }
      }
    },
    "psuMessage": {
      "type": "string",
      "description": "Text to be displayed to the PSU."
    },
    "scaMethods": {
      "type": "array",
      "description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.\n",
      "items": {
        "type": "object",
        "description": "Authentication object.\n",
        "required": [
          "authenticationType",
          "authenticationMethodId"
        ],
        "properties": {
          "authenticationMethodId": {
            "type": "string",
            "description": "An identification provided by the ASPSP for the later identification of the authentication method selection.\n"
          },
          "authenticationType": {
            "type": "string",
            "description": "Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n  - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n  - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. \n    To contact the card, the PSU normally needs a (handheld) device. \n    With this device, the PSU either reads the challenging data through a visual interface like flickering or \n    the PSU types in the challenge through the device key pad. \n    The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n  - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data\n    which can be read in by a consumer device or specific mobile app.\n    The device resp. the specific app than derives an OTP from the visual challenge data and displays\n    the OTP to the PSU.\n  - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.\n  - 'SMTP_OTP': An OTP is sent via email to the PSU.\n",
            "enum": [
              "SMS_OTP",
              "CHIP_OTP",
              "PHOTO_OTP",
              "PUSH_OTP",
              "SMTP_OTP"
            ]
          },
          "authenticationVersion": {
            "type": "string",
            "description": "Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.\n"
          },
          "explanation": {
            "type": "string",
            "description": "Detailed information about the SCA method for the PSU.\n"
          },
          "name": {
            "type": "string",
            "description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n"
          }
        }
      }
    },
    "tppMessages": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "category",
          "code"
        ],
        "properties": {
          "category": {
            "type": "string",
            "description": "Category of the TPP message category.",
            "enum": [
              "ERROR",
              "WARNING"
            ]
          },
          "code": {
            "type": "string",
            "description": "Message codes for HTTP Error codes 2XX.",
            "enum": [
              "WARNING"
            ]
          },
          "path": {
            "type": "string"
          },
          "text": {
            "type": "string",
            "description": "Additional explaining text to the TPP."
          }
        }
      }
    },
    "transactionStatus": {
      "type": "string",
      "description": "The transaction status is filled with codes of the ISO 20022 data table.\nOnly the codes RCVD, PATC, ACTC, ACWC and RJCT are used:\n- 'ACSP': 'AcceptedSettlementInProcess' -\n  All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.\n- 'ACTC': 'AcceptedTechnicalValidation' -\n  Authentication and syntactical and semantical validation are successful.\n- 'ACWC': 'AcceptedWithChange' -\n  Instruction is accepted but a change will be made, such as date or remittance not sent.\n- 'RCVD': 'Received' -\n  Payment initiation has been received by the receiving agent.\n- 'RJCT': 'Rejected' -\n  Payment initiation or individual transaction included in the payment initiation has been rejected.\n",
      "enum": [
        "ACSC",
        "ACTC",
        "PATC",
        "RCVD",
        "RJCT",
        "CANC"
      ]
    }
  }
}