ApiResponseEntityCreateAddressAndSubscriptionResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-create-address-and-subscription-response-schema.json",
  "title": "ApiResponseEntityCreateAddressAndSubscriptionResponse",
  "description": "Issuer response entity",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-customer-related-api-openapi.yml#/components/schemas/ApiResponseEntityCreateAddressAndSubscriptionResponse",
  "x-wl-api-response": true,
  "type": "object",
  "required": [
    "responseMetadata"
  ],
  "properties": {
    "responseMetadata": {
      "description": "Response metadata",
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMetadata"
        }
      ]
    },
    "data": {
      "description": "Response data",
      "allOf": [
        {
          "$ref": "#/$defs/CreateAddressAndSubscriptionResponse"
        }
      ]
    }
  },
  "$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"
    },
    "AddressIdentifier": {
      "type": "object",
      "properties": {
        "addressReference": {
          "type": "string",
          "description": "Unique internal identifier computed with a specific algorithm (mandatory)"
        },
        "issuerAddressExternalReference": {
          "type": "string",
          "description": "Unique external identifier provided by the issuer (optional)"
        }
      },
      "title": "AddressIdentifier"
    },
    "CardContractIdentifier": {
      "type": "object",
      "description": "Identification of the card contract either by Issuer card contract external reference or by card contract reference",
      "properties": {
        "cardContractReference": {
          "type": "string",
          "description": "The reference of the card contract in our system, unique per platform\nThis reference is calculated from an algorithm (currently a unique algorithm 'DefaultCardContractReferenceAlgorithm' referenced in the card profile version).\nThe reference is composed of the issuerId + a sequence number of 16 digits (e;g; 100042000000000095003, where 10004 is the issuerId)"
        },
        "issuerCardContractExternalReference": {
          "type": "string",
          "description": "The external reference of the card contract provided by the issuer\nThis reference is unique per issuer and may be used to carry out research and find information."
        }
      },
      "title": "CardContractIdentifier"
    },
    "CreateAddOnSubscriptionResponse": {
      "type": "object",
      "required": [
        "addonReference",
        "serviceTypeReference"
      ],
      "properties": {
        "addonReference": {
          "type": "string",
          "description": "Name of the add-on"
        },
        "subscriptionDate": {
          "type": "string",
          "description": "Date of the add-on subscription.",
          "format": "date-time"
        },
        "accountIdentifier": {
          "description": "The accountIdentifier of the Account on which the subscription has been done",
          "allOf": [
            {
              "$ref": "#/$defs/AccountIdentifier"
            }
          ]
        },
        "cardContractIdentifier": {
          "description": "The cardContractIdentifier of the Card Contract on which the subscription has been done",
          "allOf": [
            {
              "$ref": "#/$defs/CardContractIdentifier"
            }
          ]
        }
      },
      "title": "CreateAddOnSubscriptionResponse"
    },
    "CreateAddressAndSubscriptionResponse": {
      "type": "object",
      "required": [
        "createAddressResponse",
        "createAddOnSubscriptionResponse"
      ],
      "properties": {
        "createAddressResponse": {
          "description": "Refer to CreateAddressResponse",
          "allOf": [
            {
              "$ref": "#/$defs/CreateAddressResponse"
            }
          ]
        },
        "createAddOnSubscriptionResponse": {
          "description": "Refer to CreateAddOnSubscriptionResponse",
          "allOf": [
            {
              "$ref": "#/$defs/CreateAddOnSubscriptionResponse"
            }
          ]
        }
      },
      "title": "CreateAddressAndSubscriptionResponse"
    },
    "CreateAddressResponse": {
      "type": "object",
      "properties": {
        "addressIdentifier": {
          "description": "Identification of the customer address either by Issuer address external reference or by address reference",
          "allOf": [
            {
              "$ref": "#/$defs/AddressIdentifier"
            }
          ]
        }
      },
      "title": "CreateAddressResponse"
    },
    "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"
    },
    "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"
    }
  }
}