PaymentIdentificationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-payment-identification-response-schema.json",
  "title": "PaymentIdentificationResponse",
  "description": "PaymentIdentificationresponse\n",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-bulk-payment-initiation-service-extended-service-api-openapi.yml#/components/schemas/PaymentIdentificationResponse",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "CommonPaymentData": {
      "$ref": "#/$defs/CommonPaymentDataIdentificationResponse"
    },
    "Links": {
      "$ref": "#/$defs/Links"
    }
  },
  "$defs": {
    "AuthStatusEnum": {
      "description": "This data element is containing information about the status of the SCA method applied.\n\nThe following codes are defined for this data type.\n\n  * 'Received':\n    An authorisation or cancellation-authorisation resource has been created successfully.\n  * 'PsuIdentified':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n  * 'PsuAuthenticated':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n  * 'ScaMethodSelected':\n    The PSU/TPP has selected the related SCA routine.\n    If the SCA method is chosen implicitly since only one SCA method is available,\n    then this is the first status to be reported instead of 'received'.\n  * 'Started':\n    The addressed SCA routine has been started.\n  * 'Finalised':\n    The SCA routine has been finalised successfully.\n  * 'Failed':\n    The SCA routine failed\n  * 'Exempted':\n    SCA was exempted for the related transaction, the related authorisation is successful.\n  * 'Unconfirmed':\n              SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.\n",
      "type": "string",
      "enum": [
        "Received",
        "PsuIdentified",
        "PsuAuthenticated",
        "ScaMethodSelected",
        "Started",
        "Finalised",
        "Failed",
        "Exempted",
        "Unconfirmed"
      ]
    },
    "CommonPaymentDataIdentificationResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "PaymentId",
        "PaymentStatus"
      ],
      "properties": {
        "PaymentId": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "Id generated by the Open Banking Service. This should be used to\nrefer to this payment in subsequent api calls.\n"
        },
        "PaymentStatus": {
          "$ref": "#/$defs/PaymentStatusEnum"
        },
        "AuthStatus": {
          "$ref": "#/$defs/AuthStatusEnum"
        },
        "PsuMessage": {
          "maxLength": 1024,
          "minLength": 1,
          "type": "string",
          "description": "Text to be displayed to the PSU.\n"
        }
      }
    },
    "Link": {
      "required": [
        "Href"
      ],
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Href": {
          "maxLength": 1024,
          "minLength": 1,
          "type": "string"
        }
      }
    },
    "Links": {
      "type": "object",
      "additionalProperties": false,
      "description": "A list of hyperlinks to be recognized by the Initiating Party. The actual\nhyperlinks used in the response depend on the dynamical decisions on\nauthorization approach for example. Remark - All links are full links.\n\n* 'GetPaymentStatus': Endpoint to be called for retrieving the payment status.\n",
      "properties": {
        "GetPaymentStatus": {
          "$ref": "#/$defs/Link"
        }
      }
    },
    "PaymentStatusEnum": {
      "type": "string",
      "description": "Payment status.\n* 'TimeoutAtTpp': This status can only occur in combination with the Bank Selection Interface (UseAuthorisationLandingPages = true). It's set if the Bank Selection Interface concludes that the payment cannot be completed because of a timeout. It's a final state.\n",
      "enum": [
        "Open",
        "Authorised",
        "PartiallyAuthorised",
        "Pending",
        "SettlementInProcess",
        "SettlementCompleted",
        "ReceivedByCreditorBank",
        "ReceivedOnCreditorAccount",
        "Cancelled",
        "CancelledAtTPP",
        "TimeoutAtTpp",
        "Error",
        "Expired"
      ]
    }
  }
}