ApiResponseEntityGetAuthorizations

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-get-authorizations-schema.json",
  "title": "ApiResponseEntityGetAuthorizations",
  "description": "Issuer response entity",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-account-authorization-api-openapi.yml#/components/schemas/ApiResponseEntityGetAuthorizations",
  "type": "object",
  "required": [
    "responseMetadata"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Authorization"
      }
    },
    "responseMetadata": {
      "description": "Response metadata",
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMetadata"
        }
      ]
    }
  },
  "$defs": {
    "AccountIdentifier": {
      "type": "object",
      "properties": {
        "accountReference": {
          "type": "string",
          "description": "Account reference is to identify the Account calculated by the system (algorithm is configurable per issuer). Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used."
        },
        "issuerAccountExternalReference": {
          "type": "string",
          "description": "Issuer account external reference is to identify the Account. Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used. Algorithm configurable by issuer, can be generated by the system if there is an externalReferenceGeneratorAlgorithm."
        }
      },
      "title": "AccountIdentifier"
    },
    "Authorization": {
      "type": "object",
      "properties": {
        "accountIdentifier": {
          "$ref": "#/$defs/AccountIdentifier"
        },
        "approvalCode": {
          "type": "string",
          "description": "maxLength: 10\nCode computed at time of authorization and returned to requestor in case of an approval."
        },
        "authorizationBusinessCaseIdentifier": {
          "$ref": "#/$defs/AuthorizationBusinessCaseIdentifier"
        },
        "authorizationIdentifier": {
          "$ref": "#/$defs/AuthorizationIdentifier"
        },
        "businessCaseType": {
          "type": "string",
          "description": "examples: List [ \"FinancialRequest\", \"FinancialVerification\", \"AccountVerification\", \"BalanceEnquiry\", \"StatementEnquiry\", \"PinChange\", \"PinUnblock\", \"PickUp\", \"CardReturn\", \"Reconciliation\", \"ReserveUpdate\", \"ReserveExpiry\", \"CardFileOperation\", \"TokenLifeCycleEvent\", \"Other\", \"Unknown\" ]\nThis value is the same for all transactions belonging to the same business case. "
        },
        "cardAcceptorCity": {
          "type": "string",
          "description": "maxLength: 60\nCity the acceptor is resident (e.g. Frankfurt)."
        },
        "cardAcceptorCountry": {
          "type": "string",
          "description": "minLength: 3\nmaxLength: 3\nISO 3166 numeric country code of the acceptor. \nExample: 076 = Brazil."
        },
        "cardAcceptorName": {
          "type": "string",
          "description": "maxLength: 50\nThis field is not strictly defined and therefore variations are possible.\nUsually it is the merchant name as known to the cardholder.\nFor ATMs it could be the location or the branch number. "
        },
        "cardReference": {
          "type": "string",
          "description": "minLength: 1\nmaxLength: 100\nCard Reference from IBO."
        },
        "cardScheme": {
          "type": "string",
          "description": "examples: List [ \"VISA\", \"MasterCard\", \"Diners\", \"Amex\", \"JCB\", \"UnionPay\", \"RuPay\", \"Eftpos\", \"Twint\", \"Alipay\", \"WeChatPay\", \"Payconiq\", \"PayPal\", \"Other\", \"Unknown\" ]\nIndicates the card scheme to which the card belongs to."
        },
        "cashbackAmount": {
          "description": "maximum: 1000000000000000000\nPortion of EnquiredAmount dedicated to cashback. The sign is the same as the one of EnquiredAmount.",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "cashbackBillingAmount": {
          "description": "maximum: 1000000000000000000\nSimilar to CashbackAmount but in billing (cardholder) currency. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "comment": {
          "type": "string",
          "description": "maxLength: 255\ntextual remark given when transaction was triggered. "
        },
        "declineReason": {
          "type": "string",
          "description": "Examples: List [ \"CardBlocked\", \"FraudSuspected\", \"Cvv2Missing\", \"TechnicalError\", \"OverLimit\", \"OverUsageLimit\", \"OverCreditLimit\", \"Cvv2Wrong\", \"CvvWrong\", \"CavvWrong\", \"CardUnknown\", \"CardExpired\", \"PinWrong\", \"PinTriesOverLimit\", \"PinTriesAlmostOverLimit\", \"RestrictionViolated\", \"ArqcWrong\", \"TxnNotAllowed\", \"MerchantUnknown\", \"ReplyTimeout\", \"Other\", \"Unknown\" ]"
        },
        "declined": {
          "type": "boolean",
          "description": "Indicates whether the transaction was declined or approved."
        },
        "deltaAmount": {
          "description": "maximum: 1000000000000000000\nIncrease or decrease from the old to the new total amount of business case in transaction (acceptor) currency.\nThat is: New TotalAmount = Old TotalAmount + DeltaAmount. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "deltaBillingAmount": {
          "description": "maximum: 1000000000000000000\nSimilar to DeltaAmount but in billing (cardholder) currency. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "enquiredAmount": {
          "description": "maximum: 1000000000000000000\nRequested amount in transaction (acceptor) currency. A positive value is a debit for the cardholder and a credit for the acceptor.\nWhereas a negative value is a credit for the cardholder and a debit for the acceptor.\nA partial approval (including purchase only) can be detected by comparing EnquiredAmount with ApprovedAmount.\nIn case they are different it is a partial approval. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "enquiredBillingAmount": {
          "description": "maximum: 1000000000000000000\nSimilar to EnquiredAmount but in billing (cardholder) currency. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "entryMode": {
          "type": "string",
          "description": "Examples: List [ \"KeyEntry\", \"Magstripe\", \"Chip\", \"ContactlessMagstripe\", \"ContactlessChip\", \"BarCode\", \"Ocr\", \"File\", \"AutoEntry\", \"Other\", \"Unknown\" ]\nIndicates the way the card data was captured."
        },
        "environmentType": {
          "type": "string",
          "description": "Examples: List [ \"POI\", \"MailOrder\", \"PhoneOrder\", \"ECommerce\", \"Voice\", \"Other\", \"Unknown\" ]\nIndicates the environment in which the transaction took place."
        },
        "financialType": {
          "type": "string",
          "description": "Examples: List [ \"Cash\", \"CashRefund\", \"QuasiCash\", \"QuasiCashRefund\", \"Purchase\", \"Refund\", \"Load\", \"Unload\", \"FundsTransferCredit\", \"FundsTransferDebit\", \"OtherCredit\", \"OtherDebit\", \"Deposit\", \"DepositRefund\", \"Unknown\" ]\nProvides more details on the operation in case BusinessCaseType is FinancialRequest or FinancialVerification.This value is the same for all transactions belonging to the same financial business case. "
        },
        "issuerId": {
          "type": "string",
          "description": "Not used, will be removed"
        },
        "mappedSecurityTypeId": {
          "type": "string",
          "description": "Not used, will be removed"
        },
        "maskedPan": {
          "type": "string",
          "description": "maxLength: 28\nMasked card number (PAN). Only the first 6 and the last 4 digits are visible. All other digits are replaced by a hash character.\nAbsent if the card number is in scope of PCI and the interface is configured for suppressing the masked card number."
        },
        "merchantCategoryCode": {
          "type": "string",
          "description": "maxLength: 4\nMCategory code assigned to the acceptor (MCC)."
        },
        "onPremisesOfAcceptor": {
          "type": "boolean",
          "description": "Indicates if authorization was done in the location of the terminal"
        },
        "onlinePinCheckResult": {
          "type": "string",
          "description": "Examples: List [ \"Correct\", \"Wrong\", \"Unable\", \"Other\", \"Unknown\" ]"
        },
        "openToBuy": {
          "description": "maximum: 1000000000000000000\nAvailable line of the cardholder after transaction completion in billing currency. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "operationDate": {
          "type": "string",
          "format": "date-time",
          "description": "minLength: 14\nmaxLength: 14\nDate and time at which the transaction took place. \nThe format is YYYYMMDDhhmmss and the time zone is the one of the merchant. "
        },
        "pan": {
          "type": "string",
          "description": "maxLength: 28\nClear card number (PAN).\nAbsent if the card number is in scope of PCI and the interface is configured for suppressing the clear card number."
        },
        "panExpiryDate": {
          "type": "string",
          "description": "minLength: 6\nmaxLength: 6\nExpiry date of card/plastic in the format YYYYMM.It is only guaranteed that the string consists of decimal digits."
        },
        "panReference": {
          "type": "string",
          "description": "maxLength: 100\nAlternative card number, coming from IBO.\nThis card number is optionally used by WLP FO instead of the actual card number (PAN) when communicating with external systems."
        },
        "panSequenceNumber": {
          "type": "string",
          "description": "maximum: 9999\nSequence number of card. "
        },
        "reserveAmount": {
          "description": "minimum: -1000000000000000000\nmaximum: 1000000000000000000\nReserved amount in transaction (acceptor) currency of initial authorization. \nA positive value is a debit for the cardholder and a credit for the acceptor whereas a negative value is a credit for the cardholder and a debit for the acceptor. ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "resultCode": {
          "type": "string",
          "description": "maxLength: 20\nFinal and detailed result code of transaction. Any automated evaluation of this information has to consider that new result codes are introduced often and even existing ones can disappear or change.\nTherefore this data element should be used for information purpose only. "
        },
        "resultDescription": {
          "type": "string",
          "description": "maxLength: 300\nEnglish text explaining the meaning of ResultCode."
        },
        "resultType": {
          "type": "string",
          "description": "Approval (transaction approved),Decline (transaction refused),Referral (transaction refused),PickUp (transaction refused),Other (transaction refused). "
        },
        "securityTypeId": {
          "type": "integer",
          "format": "int32",
          "description": "maximum: 999999999\nInternal unique identifier of security type in WLP FO. "
        },
        "securityTypeName": {
          "type": "string",
          "description": "maxLength: 100\nEnglish text explaining SecurityTypeId."
        },
        "standIn": {
          "type": "boolean",
          "description": "Indicates whether WLP FO has stood in for the switch-out peer (request) or whether the transaction is managed in store-and-forward mode towards the switch-out peer (advice).\nThis field is only present if the field SwitchOutPeerId is present.  "
        },
        "surchargeAmount": {
          "description": "maximum: 1000000000000000000\nPortion of EnquiredAmount dedicated to surcharge imposed by the acceptor or the acquirer.\nThe sign is the same as the one of EnquiredAmount.  ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "surchargeBillingAmount": {
          "description": "maximum: 1000000000000000000\nSimilar to SurchargeAmount but in billing (cardholder) currency.  ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "terminalId": {
          "type": "string",
          "description": "maxLength: 20\nId of terminal."
        },
        "terminalType": {
          "type": "string",
          "description": "Examples: List [ \"Attended\", \"Atm\", \"PetrolPump\", \"Adm\", \"LimitedAmountAdm\", \"Mobile\", \"InFlight\", \"ChargingStation\", \"Other\", \"Unknown\" ]\nIndicates the type of the terminal."
        },
        "totalAmount": {
          "description": "maximum: 1000000000000000000\nOverall reservation/authorization (if capturing is not finalized) or capture amount (if capturing is finalized) of business case in transaction (acceptor) currency after transaction completion. \nA positive value is a debit for the cardholder and a credit for the acceptor.\nWhereas a negative value is a credit for the cardholder and a debit for the acceptor.  ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "totalBillingAmount": {
          "description": "maximum: 1000000000000000000\nSimilar to TotalAmount but in billing (cardholder) currency.  ",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "transactionDate": {
          "type": "string",
          "description": "minLength: 23\nmaxLength: 23\nTime and date at which the transaction took place. \nThe format is 2012-12-31T22:00:00.000 and the time zone is the one of the merchant. \nIt is only guaranteed that the string consists of decimal digits. \nBut it is not ensured the value is valid. For example the month could be outside of the range from 01 to 12."
        },
        "transactionSubType": {
          "type": "string",
          "description": "Examples: List [ \"Request\", \"Advice\", \"Other\", \"Unknown\" ]\nIndicates the sub-type of the performed operation for some  Transaction types."
        },
        "transactionType": {
          "type": "string",
          "description": "DEPRECATED. Use the field TransactionType2. insteadExamples: List [ \"Authorization\", \"Reversal\", \"Confirmation\", \"Rollback\", \"ReserveUpdate\", \"ReserveExpiry\", \"Other\", \"Unknown\" ]\nIndicates the type of the performed operation for some of the listed BusinessCaseType values."
        },
        "transactionType2": {
          "type": "string",
          "description": "Examples: List [ \"Authorization\", \"Reversal\", \"Confirmation\", \"Rollback\", \"ReserveUpdate\", \"ReserveExpiry\", \"Other\", \"Unknown\" ]\nIndicates the type of the performed operation for some of the listed BusinessCaseType values."
        },
        "transactionTypeId": {
          "type": "string",
          "description": "maximum: 999999999\nInternal unique identifier of transaction type in WLP FO."
        },
        "transactionTypeName": {
          "type": "string",
          "description": "maxLength: 100\nEnglish text explaining TransactionTypeId."
        },
        "velocityLimitChecks": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/VelocityLimitCheck"
          }
        }
      },
      "title": "Authorization"
    },
    "AuthorizationBusinessCaseIdentifier": {
      "type": "object",
      "required": [
        "businessCaseId"
      ],
      "properties": {
        "businessCaseId": {
          "type": "string",
          "description": "Business case to which the transaction belongs.\nThe provided information reflects its status after transaction completion.\nA business case is a group of transactions which logically belong together (e.g. original transaction and reversal of original transaction)"
        }
      },
      "title": "AuthorizationBusinessCaseIdentifier"
    },
    "AuthorizationIdentifier": {
      "type": "object",
      "properties": {
        "transactionId": {
          "type": "string",
          "description": "minLength: 18\nmaxLength: 18\nUnique identifier of notified transaction in WLP FO. "
        },
        "issuerExternalAuthorizationReference": {
          "type": "string",
          "description": "Issuer external authorization reference"
        }
      },
      "title": "AuthorizationIdentifier"
    },
    "Links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "type": "string",
          "description": "Service method URL"
        },
        "next": {
          "type": "string",
          "description": "URL pagination query parameter next page"
        }
      },
      "title": "Links"
    },
    "MonetaryAmountAlphaCurrency": {
      "type": "object",
      "properties": {
        "exponent": {
          "type": "integer",
          "format": "int32",
          "description": "Exponent of amount currency. Number of decimal digits. Example: 2 for Euro."
        },
        "isoCode": {
          "type": "string",
          "description": "Currency code of amount. ISO4217 alphabetic format. Example: EUR for Euro."
        },
        "value": {
          "type": "integer",
          "format": "int64",
          "description": "Value of amount. Example: 54321 for 543,21 EUR (exponent = 2: 2 digits for cents)."
        }
      },
      "title": "MonetaryAmountAlphaCurrency"
    },
    "ResponseMetadata": {
      "type": "object",
      "required": [
        "correlationId",
        "responseDateTime",
        "statusCode",
        "statusMessage"
      ],
      "properties": {
        "correlationId": {
          "type": "string",
          "description": "Correlation Identifier"
        },
        "links": {
          "description": "Metadata Links",
          "allOf": [
            {
              "$ref": "#/$defs/Links"
            }
          ]
        },
        "statusMessage": {
          "type": "string",
          "description": "Executed REST API status message"
        },
        "statusCode": {
          "type": "integer",
          "format": "int32",
          "description": "HTTP status code"
        },
        "responseDateTime": {
          "type": "string",
          "description": "Timestamp when response date was generated"
        },
        "timeTakenMs": {
          "type": "integer",
          "format": "int64",
          "description": "Wall clock time required from service to generate the response"
        }
      },
      "title": "ResponseMetadata"
    },
    "VelocityLimitCheck": {
      "type": "object",
      "properties": {
        "amount": {
          "description": "Cumulated authorization amount in period. Debits have a positive sign whereas credits have a negative one. \nThe returned value is the one being effective at operation execution time.",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "count": {
          "type": "integer",
          "format": "int32",
          "description": "minimum: 0\nmaximum: 999999999\nCurrent number of transactions in period. \nThe returned value is the one being effective at operation execution time."
        },
        "issuerId": {
          "type": "string",
          "description": "Not used, will be removed."
        },
        "maximumAmount": {
          "description": "minimum: -1000000000000000000\nmaximum: 1000000000000000000\nMaximum threshold for the cumulated authorization amount in period. \nIn most of the cases the value given here will be positive. \nThe returned value is the one being effective at operation execution time. \nOnly present in case MaximumAmountCheck is true.",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "maximumAmountCheck": {
          "type": "boolean",
          "description": "Indicates whether the cumulated authorization amount in period is compared with a maximum threshold or not. \nThe returned value is the one being effective at operation execution time."
        },
        "maximumAmountCheckOrigin": {
          "type": "string",
          "description": "Examples: List [ \"Default\", \"Exception\", \"Override\", \"Other\" ]\nIndicates from which entity MaximumAmountCheck has been taken."
        },
        "maximumAmountOrigin": {
          "type": "string",
          "description": "Indicates from which level MaximumAmountCheck has been taken\nOnly present in case MaximumAmount is present.\nEnum:\n[ Default, Exception, Override, Other ]"
        },
        "maximumCount": {
          "type": "integer",
          "format": "int32",
          "description": "minimum: 0\nmaximum: 999999999\nMaximum threshold for the number of transactions in period. The returned value is the one being effective at operation execution time. Only present in case MaximumCountCheck is true. "
        },
        "maximumCountCheck": {
          "type": "boolean",
          "description": "Indicates whether the number of transactions in period is compared with a maximum threshold or not. \nThe returned value is the one being effective at operation execution time. "
        },
        "maximumCountCheckOrigin": {
          "type": "string",
          "description": "Examples: List [ \"Default\", \"Exception\", \"Override\", \"Other\" ]\nIndicates from which entity MaximumCountCheck has been taken."
        },
        "maximumCountOrigin": {
          "type": "string",
          "description": "Examples: List [ \"Default\", \"Exception\", \"Override\", \"Other\" ]\nIndicates from which entity MaximumCount has been taken.\nOnly present if the maximum count check has been performed."
        },
        "minimumAmount": {
          "description": "minimum: -1000000000000000000\nmaximum: 1000000000000000000\nMinimum threshold for the cumulated authorization amount in period. \nIn most of the cases the value given here will be negative. \nThe returned value is the one being effective at operation execution time. \nOnly present in case MinimumAmountCheck is true.",
          "allOf": [
            {
              "$ref": "#/$defs/MonetaryAmountAlphaCurrency"
            }
          ]
        },
        "minimumAmountCheck": {
          "type": "boolean",
          "description": "Indicates whether the cumulated authorization amount in period is compared with a minimum threshold or not. \nThe returned value is the one being effective at operation execution time."
        },
        "minimumAmountCheckOrigin": {
          "type": "string",
          "description": "Examples: List [ \"Default\", \"Exception\", \"Override\", \"Other\" ]\nIndicates from which entity MinimumAmountCheck has been taken."
        },
        "minimumAmountOrigin": {
          "type": "string",
          "description": "Indicates from which level MinimumAmountCheck has been taken.  \nPossible values: Default, Exception, Override, Other.\nOnly present in case MinimumAmount is present."
        },
        "velocityLimitIdentifier": {
          "$ref": "#/$defs/VelocityLimitIdentifier"
        }
      },
      "title": "VelocityLimitCheck"
    },
    "VelocityLimitIdentifier": {
      "type": "object",
      "properties": {
        "velocityLimitReference": {
          "type": "string",
          "description": "minLength: 1\nmaxLength: 60\nIdentifies the velocity check."
        }
      },
      "title": "VelocityLimitIdentifier"
    }
  }
}