{ "swagger": "2.0", "info": { "version": "v1", "title": "Visa.ICPP.CPVS.WebApi" }, "host": "localhost:50730", "schemes": ["http"], "paths": { "/vces/services/v1/eligibility/prepay": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card details to Visa.", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured", "operationId": "CardProductValidationCore_Prepay", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "prepayCard", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/PrepayRequest" } }], "responses": { "200": { "description": "Prepay card", "schema": { "$ref": "#/definitions/PrepayResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/PrepayResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/eligibility/prepayIframe": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card details to Visa [Non-PCI]", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured", "operationId": "CardProductValidationCore_PrepayIframe", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "prepayCard", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/PrepayIframeRequest" } }], "responses": { "200": { "description": "Prepay card", "schema": { "$ref": "#/definitions/PrepayResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/PrepayResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/promo/redeem": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card details to Visa.", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured", "operationId": "CardProductValidationCore_Redeem", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "redeem", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/RedeemRequest" } }], "responses": { "200": { "description": "redeem card against a promotion which, a card which has been validated", "schema": { "$ref": "#/definitions/RedeemResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/RedeemResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/promo/redeemIframe": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card details to Visa.", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured", "operationId": "CardProductValidationCore_RedeemIframe", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "redeem", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/RedeemIframeRequest" } }], "responses": { "200": { "description": "redeem card against a promotion for which, alias Id has been validated", "schema": { "$ref": "#/definitions/RedeemResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/RedeemResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/eligibility/validate": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card validation details to Visa.", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured for that program", "operationId": "CardProductValidationCore_Validate", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "validate", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/ValidateRequest" } }], "responses": { "200": { "description": "validateCardResponse response with eligibility information", "schema": { "$ref": "#/definitions/ValidateResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/ValidateResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/eligibility/validateIframe": { "post": { "tags": ["CardProductValidationCore"], "summary": "Send Card validation details to Visa [Non PCI]", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured for that program", "operationId": "CardProductValidationCore_ValidateIframe", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "validate", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/ValidateIframeRequest" } }], "responses": { "200": { "description": "validateCardResponse response with eligibility information", "schema": { "$ref": "#/definitions/ValidateResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/ValidateResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/cpvs/services/v1/validateCardLimit": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_ValidateCardLimit", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "validateCardLimitRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ValidateCardLimitRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidateCardResponse" } } } } }, "/cpvs/services/v1/validateCardEligibility": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_ValidateCardEligibility", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "validateCardEligibilityRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ValidateCardEligibilityRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CPVSResponse" } } } } }, "/cpvs/services/v1/prePaymentValidation": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_PrePaymentValidation", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "prePaymentRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrePaymentValidationRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrePaymentValidationResponse" } } } } }, "/cpvs/services/v1/redemptionValidation": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_RedemptionValidation", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "redemptionValidationRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RedemptionValidationRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RedemptionResponse" } } } } }, "/cpvs/services/v1/loadErrorMessagesToCache": { "get": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_LoadErrorMessagesToCache", "consumes": [], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ErrorMessage" } } } } } }, "/cpvs/services/v1/loadApplicationConfiguration": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_LoadApplicationConfiguration", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "appConfigRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ApplicationConfigurationRequest" } }], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "/cpvs/services/v1/getVendorDetail": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_GetVendorDetail", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "pVendorUniueId", "in": "body", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VendorDetail" } } } } }, "/cpvs/services/v1/getVendorDetails": { "get": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_GetVendorDetails", "consumes": [], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VendorInformation" } } } } }, "/cpvs/services/v1/updateActivityLog": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_UpdateActivityLog", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "updateActivityRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateActivityRequest" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/getCardBenefits": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_GetCardBenefits", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "crdBenefitRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CardBenefitRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VFSResponse" } } } } }, "/cpvs/services/v1/updateVendorLockDateTime": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_UpdateVendorLockDateTime", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "vendorLockedDateTime", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VendorLockedDateTime" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/VendorStatus": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_VendorStatus", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "vendorStatus", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VendorStatus" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/validateAcknowledgement": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_ValidateAcknowledgement", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "auditRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AuditRequest" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/logActivity": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_LogActivity", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "activityLogDetails", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActivityLogDetails" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/userLockOutInfo": { "post": { "tags": ["CardProductValidationCore"], "operationId": "CardProductValidationCore_GetUserLockOutInfo", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "userDetail", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDetail" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/cpvs/services/v1/TestData": { "post": { "tags": ["Provisioning"], "summary": "Test Card Numbers", "description": "Gets Test Permanent Account Numbers to be used against the registration", "operationId": "Provisioning_GetCards", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "getCards", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/GetCardsRequest" } }], "responses": { "200": { "description": "returns test Permanent Account Numbers", "schema": { "$ref": "#/definitions/GetCardsResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/GetCardsResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "404": { "description": "Server has not found anything matching the request URI" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/cpvs/services/v1/register": { "post": { "tags": ["Provisioning"], "summary": "Gets Visa Card Eligibility Service Test Program for a Merchant", "description": "Gets test Program ID for a Merchant", "operationId": "Provisioning_RegisterMerchant", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "registerMerchant", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/RegisterMerchantRequest" } }], "responses": { "200": { "description": "register Merchant response with Vendor Unique ID", "schema": { "$ref": "#/definitions/RegisterMerchantResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/RegisterMerchantResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/eligibility/ValidateResult": { "post": { "tags": ["WebSiteCore"], "summary": "Send Card validation details to Visa.", "description": "This resource returns information of the card products eligibility against a promotion and corresponding card details if configured for that program", "operationId": "WebSiteCore_ValidationResult", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "validationResultRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ValidationResultRequest" } }], "responses": { "200": { "description": "validateCardResponse response with eligibility information", "schema": { "$ref": "#/definitions/ValidationResultResponse" } }, "202": { "description": "Validation Failures", "schema": { "$ref": "#/definitions/ValidationResultResponse" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden Operation to requested resource" }, "500": { "description": "Temporary Downtime - retry operation after waiting" }, "503": { "description": "Temporary Downtime for maintenance - retry operation after waiting" } } } }, "/vces/services/v1/promo/iframeRedemption": { "post": { "tags": ["WebSiteCore"], "operationId": "WebSiteCore_IFrameRedemption", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "iframeRedeemRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IframeRedeemRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IframeRedeemResponse" } } } } }, "/vces/services/v1/registeriFrame/GetToken": { "post": { "tags": ["WebSiteCore"], "operationId": "WebSiteCore_GetToken", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "registeriFrameRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegisteriFrameRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RegisteriFrameResponse" } } } } }, "/cpvs/services/v1/GetVendorID": { "post": { "tags": ["WebSiteCore"], "operationId": "WebSiteCore_GetVendorID", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "vendorIDRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VendorIDRequest" } }], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VendorIDResponse" } } } } }, "/cpvs/services/v1/IsTokenValid": { "post": { "tags": ["WebSiteCore"], "operationId": "WebSiteCore_IsTokenValid", "consumes": ["application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"], "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [{ "name": "token", "in": "body", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } } }, "definitions": { "PrepayRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "permanentAccountNumber": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "tokenAccountNumber": { "type": "string" }, "aliasId": { "type": "string" } } }, "PrepayResponse": { "type": "object", "properties": { "CorrelationId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "hasPanMatched": { "type": "string" }, "aliasId": { "type": "string" } } }, "PrepayIframeRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "aliasID": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" } } }, "RedeemRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "permanentAccountNumber": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "mode": { "type": "string" }, "aliasId": { "type": "string" }, "tokenAccountNumber": { "type": "string" } } }, "RedeemResponse": { "type": "object", "properties": { "correlationId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "aliasID": { "type": "string" } } }, "RedeemIframeRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "mode": { "type": "string" }, "aliasId": { "type": "string" } } }, "ValidateRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "extendedData": { "type": "string" }, "PermanentAccountNumber": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "expirationDate": { "$ref": "#/definitions/ExpirationDate" }, "numberOfAdditionalRedemptions": { "format": "int32", "type": "integer" }, "aliasID": { "type": "string" }, "tokenAccountNumber": { "type": "string" } } }, "ExpirationDate": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "string" } } }, "ValidateResponse": { "type": "object", "properties": { "cardBenefits": { "type": "array", "items": { "$ref": "#/definitions/CardBenefit" } }, "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "CorrelationId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "issuerBid": { "type": "string" }, "productType": { "type": "string" }, "productSubType": { "type": "string" }, "countryCode": { "type": "string" }, "binIndicator": { "type": "string" }, "eligibilityLevel": { "type": "string" }, "isEligible": { "type": "string" }, "acctFundSrce": { "type": "string" }, "acctFundSrceSubTyp": { "type": "string" }, "cardId": { "type": "string" }, "aliasID": { "type": "string" }, "cardHolderId": { "type": "string" }, "rPin": { "type": "string" }, "redemptionDetails": { "$ref": "#/definitions/RedemptionDetails" }, "entityToBeBilled": { "$ref": "#/definitions/EntityToBeBilled" } } }, "CardBenefit": { "type": "object", "properties": { "BenefitName": { "type": "string" }, "BenefitDesc": { "type": "string" }, "PhoneNumberDetails": { "type": "string" }, "CardEnhanceTypeCode": { "type": "string" } } }, "RedemptionDetails": { "type": "object", "properties": { "isUnlimited": { "type": "string" }, "allowed": { "$ref": "#/definitions/AllowedRedemptionDetails" }, "used": { "$ref": "#/definitions/UsedRedemptionDetails" }, "pooled": { "type": "boolean" }, "eligibleRedemptions": { "$ref": "#/definitions/EligibleRedemptions" } } }, "EntityToBeBilled": { "type": "object", "properties": { "memberCharge": { "type": "string" }, "additionalRedemptionCharges": { "type": "array", "items": { "type": "string" } } } }, "AllowedRedemptionDetails": { "type": "object", "properties": { "count": { "type": "string" }, "duration": { "$ref": "#/definitions/RedemptionDuration" }, "additionalRedemptionsPerTransaction": { "format": "int32", "type": "integer" } } }, "UsedRedemptionDetails": { "type": "object", "properties": { "count": { "type": "string" }, "details": { "$ref": "#/definitions/RedemptionUsageDetails" }, "additionalRedemptions": { "format": "int32", "type": "integer" }, "additionalRedemptionDetails": { "$ref": "#/definitions/AdditionalRedemptionUsageDetails" } } }, "EligibleRedemptions": { "type": "object", "properties": { "count": { "format": "int32", "type": "integer" }, "requestedAdditionalRedemptions": { "format": "int32", "type": "integer" }, "coveredAdditionalRedemptions": { "format": "int32", "type": "integer" } } }, "RedemptionDuration": { "type": "object", "properties": { "value": { "type": "string" }, "type": { "type": "string" } } }, "RedemptionUsageDetails": { "type": "object", "properties": { "timeStamp": { "type": "array", "items": { "type": "string" } } } }, "AdditionalRedemptionUsageDetails": { "type": "object", "properties": { "timeStamp": { "type": "array", "items": { "type": "string" } } } }, "ValidateIframeRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "extendedData": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "numberOfAdditionalRedemptions": { "format": "int32", "type": "integer" }, "aliasID": { "type": "string" } } }, "ValidateCardLimitRequest": { "type": "object", "properties": { "ValidateCardRequest": { "$ref": "#/definitions/ValidateCardRequest" }, "VendorRequest": { "$ref": "#/definitions/VendorRequest" } } }, "ValidateCardRequest": { "type": "object", "properties": { "RequestSource": { "format": "int32", "enum": [0, 1, 2, 3], "type": "integer" }, "ApplicationName": { "type": "string" }, "VendorUniqueId": { "type": "string" }, "CorrelationId": { "type": "string" }, "PaymentCardAccountNumber": { "type": "string" }, "MessageId": { "type": "string" }, "ExtendedData": { "type": "string" }, "NumberOfAdditionalRedemptions": { "format": "int32", "type": "integer" }, "AliasId": { "type": "string" }, "TokenAccountNumber": { "type": "string" }, "RequestParam": { "type": "string" } } }, "VendorRequest": { "type": "object", "properties": { "UserAgent": { "type": "string" }, "IpAddress": { "type": "string" }, "RequestURL": { "type": "string" }, "VendorInfo": { "$ref": "#/definitions/VendorDetail" }, "RequestSource": { "format": "int32", "enum": [0, 1, 2, 3], "type": "integer" } } }, "VendorDetail": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "EncryptionKey": { "type": "string" }, "IVKey": { "type": "string" }, "ReqIndicator": { "type": "boolean" }, "RespIndicator": { "type": "boolean" }, "URLAddress": { "type": "string" }, "UniqueId": { "type": "string" }, "RetryCount": { "format": "int32", "type": "integer" }, "LockOutTime": { "format": "int32", "type": "integer" }, "ActiveStatus": { "type": "boolean" }, "CSSPath": { "type": "string" }, "OutcomeHandleMethod": { "type": "string" }, "ValueIfPANValid": { "type": "string" }, "IpAddress": { "type": "string" }, "ValueForPANInvalid": { "type": "string" }, "RecaptchaStartCount": { "format": "int32", "type": "integer" }, "NoOfSuccessfullValidationsAllowed": { "format": "int32", "type": "integer" }, "SuccessfullValidationPeriodInDays": { "format": "int32", "type": "integer" }, "NoOfsuccessfullRedemptionsAllowed": { "format": "int32", "type": "integer" }, "SuccessfullRedemptionsPeriodInDays": { "format": "int32", "type": "integer" }, "LanguageCode": { "type": "string" }, "IsVerboseRespRequired": { "type": "boolean" }, "ServiceTypeID": { "format": "int32", "type": "integer" }, "ServiceSubTypeID": { "format": "int32", "type": "integer" }, "VendorCreatedTimeStamp": { "format": "date-time", "type": "string" }, "IsMod10CheckRequired": { "type": "boolean" }, "IsRedemptionLevelConfigured": { "type": "boolean" }, "MerchantID": { "format": "int32", "type": "integer" }, "VndrIntgrtnId": { "type": "string" }, "IfrmIntgrtnInd": { "type": "string" }, "ISAuthChkReqd": { "type": "boolean" }, "IsPooled": { "type": "boolean" }, "NumberOfAdditionalRedemptionsAllowed": { "format": "int32", "type": "integer" }, "AdditionalRedemptionProgram": { "type": "boolean" } } }, "ValidateCardResponse": { "type": "object", "properties": { "StatusCode": { "type": "string" }, "ErrorDesc": { "type": "string" }, "CardID": { "format": "int32", "type": "integer" }, "ServiceTypeID": { "format": "int32", "type": "integer" }, "SuccessCount": { "format": "int32", "type": "integer" } } }, "ValidateCardEligibilityRequest": { "type": "object", "properties": { "VendorRequest": { "$ref": "#/definitions/VendorRequest" }, "CDIRequest": { "$ref": "#/definitions/CDIRequest" }, "VfsRequest": { "$ref": "#/definitions/VFSRequest" }, "AvsRequest": { "$ref": "#/definitions/AVSRequest" } } }, "CDIRequest": { "type": "object", "properties": { "ApplicationName": { "type": "string" }, "CorrelationId": { "type": "string" }, "PAN": { "type": "string" }, "IsProductRequired": { "type": "boolean" }, "IsRPINRequired": { "type": "boolean" }, "IsBIDRequired": { "type": "boolean" }, "IsGeoGraphyRequired": { "type": "boolean" }, "MessageId": { "type": "string" }, "UserId": { "type": "string" }, "UserBid": { "type": "string" }, "RequestDateTime": { "format": "date-time", "type": "string" }, "ServiceId": { "type": "string" }, "ExtendedData": { "type": "string" } } }, "VFSRequest": { "type": "object", "properties": { "RequestSource": { "format": "int32", "enum": [0, 1, 2, 3], "type": "integer" }, "VendorUniqueId": { "type": "string" }, "CorrelationId": { "type": "string" }, "PaymentCardAccountNumber": { "type": "string" }, "RequestTimestamp": { "type": "string" }, "ApplicationIDText": { "type": "string" }, "ApplicationID": { "type": "string" }, "UserID": { "type": "string" }, "AuditUserID": { "type": "string" }, "VfsVersion": { "type": "string" }, "VfsVersionSpecified": { "type": "string" }, "TestCode": { "type": "string" }, "ServiceId": { "type": "string" }, "MessageId": { "type": "string" }, "AsOfDate": { "type": "string" }, "Sta_Cd": { "type": "string" } } }, "AVSRequest": { "type": "object", "properties": { "applicationName": { "type": "string" }, "paymentCardAccountNumber": { "type": "string" }, "messageId": { "type": "string" }, "requestTimestamp": { "type": "string" }, "expirationDate": { "$ref": "#/definitions/ExpirationDate" } } }, "CPVSResponse": { "type": "object", "properties": { "CDIResponse": { "$ref": "#/definitions/CDIResponse" }, "VFSResponse": { "$ref": "#/definitions/VFSResponse" }, "TAQCResponse": { "$ref": "#/definitions/TAQCResponse" }, "EligibilityLevel": { "format": "int32", "type": "integer" }, "StatusCode": { "type": "string" }, "IsEligible": { "type": "boolean" }, "SuccessAttemptCount": { "format": "int32", "type": "integer" }, "EligibilErrorCode": { "type": "string" } } }, "CDIResponse": { "type": "object", "properties": { "IsProductValid": { "type": "boolean" }, "StatusCode": { "type": "string" }, "StatusDescripton": { "type": "string" }, "CDIGeographyResponse": { "$ref": "#/definitions/GeographyResponse" }, "CDIIssuerBIDResponse": { "$ref": "#/definitions/IssuerBIDResponse" }, "CDIProductResponse": { "$ref": "#/definitions/ProductResponse" }, "CDIRpinResponse": { "$ref": "#/definitions/RpinResponse" }, "ResponseTime": { "format": "date-time", "type": "string" }, "NoOfRows": { "format": "int32", "type": "integer" }, "StatusMessage": { "type": "string" }, "VerboseIndicator": { "$ref": "#/definitions/VerboseIndicator" }, "BINIndicator": { "type": "string" } } }, "VFSResponse": { "type": "object", "properties": { "StatusCode": { "type": "string" }, "ErrorDesc": { "type": "string" }, "CardBenefit": { "type": "array", "items": { "$ref": "#/definitions/CardBenefit" } }, "VFSCardEnhancement": { "type": "array", "items": { "$ref": "#/definitions/VFSCardEnhancement" } }, "CssPath": { "type": "string" } } }, "TAQCResponse": { "type": "object", "properties": { "CardHolderID": { "type": "string" }, "StatusCode": { "type": "string" }, "StatusDescription": { "type": "string" }, "ResponseTS": { "format": "date-time", "type": "string" }, "ResponseTSSpecified": { "type": "boolean" }, "RequestMessageID": { "type": "string" }, "CorrelationID": { "type": "string" }, "ResponseMessageID": { "type": "string" }, "NumOfRowsReturned": { "format": "int32", "type": "integer" }, "NumOfRowsReturnedSpecified": { "type": "boolean" } } }, "GeographyResponse": { "type": "object", "properties": { "AccountCtryCode": { "type": "string" }, "AccountRegionCode": { "type": "string" } } }, "IssuerBIDResponse": { "type": "object", "properties": { "AccountBID": { "type": "string" }, "AccountBusName": { "type": "string" }, "IsoBin": { "type": "string" } } }, "ProductResponse": { "type": "object", "properties": { "productID": { "type": "string" }, "productIDName": { "type": "string" }, "visDefaultProductIDInd": { "type": "boolean" }, "accountProductType": { "type": "string" }, "accountProductExtCd": { "type": "string" }, "prodIdSubtypeCode": { "type": "string" }, "prodIdSubtypeDesc": { "type": "string" }, "prodIdSubtypeExposInd": { "type": "string" }, "accountFundingSourceCd": { "type": "string" }, "accountFundingSourceSubtypeCd": { "type": "string" }, "brandCd": { "type": "string" }, "platformCd": { "type": "string" }, "AccountProductID": { "type": "string", "readOnly": true }, "ProdIdSubtypeCodeField": { "type": "string", "readOnly": true }, "AccountFundingSourceCdField": { "type": "string", "readOnly": true }, "AccountFundingSourceSubtypeCdField": { "type": "string", "readOnly": true } } }, "RpinResponse": { "type": "object", "properties": { "AccountRewardsProgramID": { "type": "string" }, "AccountRewardsProgramName": { "type": "string" } } }, "VerboseIndicator": { "type": "object", "properties": { "VendorUniqueId": { "format": "int32", "type": "integer" }, "IssuerBIDFlag": { "type": "boolean" }, "ProductTypeFlag": { "type": "boolean" }, "ProductSubTypeFlag": { "type": "boolean" }, "RPINFlag": { "type": "boolean" }, "CountryCodeFlag": { "type": "boolean" }, "BINIndicatorFlag": { "type": "boolean" }, "AcctFundSrceFlag": { "type": "boolean" }, "AcctFundSrceSubTypFlag": { "type": "boolean" }, "IsRedemptionDetailFlag": { "type": "boolean" } } }, "VFSCardEnhancement": { "type": "object", "properties": { "EnhancementTypeCode": { "type": "string" }, "EnhancementID": { "type": "string" } } }, "PrePaymentValidationRequest": { "type": "object", "properties": { "RequestSource": { "format": "int32", "enum": [0, 1, 2, 3], "type": "integer" }, "VendorUniqueId": { "type": "string" }, "CorrelationId": { "type": "string" }, "RequestTimeStamp": { "format": "date-time", "type": "string" }, "PaymentCardAccountNumber": { "type": "string" }, "ResponseTimeStamp": { "format": "date-time", "type": "string" }, "Alias": { "type": "string" }, "Requestparam": { "type": "string" }, "TokenAccountNumber": { "type": "string" } } }, "PrePaymentValidationResponse": { "type": "object", "properties": { "StatusCode": { "type": "string" }, "HasPANMatched": { "type": "boolean" }, "AliasId": { "type": "string" } } }, "RedemptionValidationRequest": { "type": "object", "properties": { "VendorRequest": { "$ref": "#/definitions/VendorRequest" }, "RedemptionRequest": { "$ref": "#/definitions/RedemptionRequest" } } }, "RedemptionRequest": { "type": "object", "properties": { "RequestSource": { "format": "int32", "enum": [0, 1, 2, 3], "type": "integer" }, "VendorUniqueId": { "type": "string" }, "CorrelationId": { "type": "string" }, "RequestTimeStamp": { "format": "date-time", "type": "string" }, "PaymentCardAccountNumber": { "type": "string" }, "MessageID": { "type": "string" }, "UserBid": { "type": "string" }, "UserId": { "type": "string" }, "ApplicationName": { "type": "string" }, "ExtendedData": { "type": "string" }, "mode": { "type": "string" }, "AliasId": { "type": "string" }, "RequestParam": { "type": "string" }, "TokenAccountNumber": { "type": "string" } } }, "RedemptionResponse": { "type": "object", "properties": { "StatusCode": { "type": "string" } } }, "ErrorMessage": { "type": "object", "properties": { "ErrorCode": { "type": "string" }, "LanguageCode": { "type": "string" }, "ErrorDescription": { "type": "string" }, "HttpStatusCode": { "type": "string" }, "HttpStatusDesc": { "type": "string" } } }, "ApplicationConfigurationRequest": { "type": "object", "properties": { "appid": { "type": "string" } } }, "VendorInformation": { "type": "object", "properties": { "VendorDetailList": { "type": "array", "items": { "$ref": "#/definitions/VendorDetail" } }, "VendorPreferenceList": { "type": "array", "items": { "$ref": "#/definitions/VendorPreference" } }, "VendorBrandingList": { "type": "array", "items": { "$ref": "#/definitions/VendorBranding" } }, "VendorIpDetailList": { "type": "array", "items": { "$ref": "#/definitions/VendorIpDetail" } }, "VendorDomainDetailList": { "type": "array", "items": { "$ref": "#/definitions/VendorDomainDetail" } } } }, "VendorPreference": { "type": "object", "properties": { "VendorId": { "format": "int32", "type": "integer" }, "PreferenceId": { "format": "int32", "type": "integer" }, "PreferenceValue": { "type": "string" } } }, "VendorBranding": { "type": "object", "properties": { "VendorId": { "format": "int32", "type": "integer" }, "BrandId": { "format": "int32", "type": "integer" }, "BrandValue": { "type": "string" } } }, "VendorIpDetail": { "type": "object", "properties": { "VendorId": { "format": "int32", "type": "integer" }, "IpAddress": { "type": "string" } } }, "VendorDomainDetail": { "type": "object", "properties": { "VendorId": { "format": "int32", "type": "integer" }, "DomainName": { "type": "string" } } }, "UpdateActivityRequest": { "type": "object", "properties": { "MessageId": { "type": "string" }, "ResponseCode": { "format": "int32", "type": "integer" }, "RespDescription": { "type": "string" } } }, "CardBenefitRequest": { "type": "object", "properties": { "CardId": { "format": "int32", "type": "integer" }, "VendorUniqueName": { "type": "string" }, "CorelationId": { "type": "string" } } }, "VendorLockedDateTime": { "type": "object", "properties": { "BrowserInfo": { "$ref": "#/definitions/BrowserInfo" }, "IsSuccess": { "type": "boolean" } } }, "BrowserInfo": { "type": "object", "properties": { "Platform": { "type": "string" }, "SystemLanguage": { "type": "string" }, "BrowserType": { "type": "string" }, "IPAddress": { "type": "string" }, "Version": { "type": "string" }, "Agent": { "type": "string" }, "ECMA": { "type": "string" }, "Cookies": { "type": "string" }, "Gateway": { "type": "string" }, "GatewayMinorVersion": { "type": "string" }, "GatewayMajorVersion": { "type": "string" }, "Beta": { "type": "string" }, "Win16": { "type": "string" }, "Win32": { "type": "string" }, "AolBrowser": { "type": "string" }, "FramesSupport": { "type": "string" }, "VBScriptSupport": { "type": "string" }, "BackgroundSounds": { "type": "string" }, "CanSendMail": { "type": "string" }, "HasBackButton": { "type": "string" }, "InputType": { "type": "string" }, "IsColor": { "type": "string" }, "JavaScript": { "type": "string" }, "UserId": { "type": "string" }, "CorrelationId": { "type": "string" }, "LockOutExpiry": { "type": "string" }, "UserRetryCount": { "type": "string" }, "VendorUniqueId": { "type": "string" }, "AppCodeName": { "type": "string" }, "AppName": { "type": "string" }, "AppVersion": { "type": "string" }, "CookieEnabled": { "type": "string" }, "MimeTypes": { "type": "string" }, "Online": { "type": "string" }, "OpsProfile": { "type": "string" }, "Plugins": { "type": "string" }, "UserLanguage": { "type": "string" }, "UserProfle": { "type": "string" }, "BrowserNM": { "type": "string" }, "CPUCls": { "type": "string" }, "HTMLTblInd": { "type": "string" }, "FlashInstInd": { "type": "string" }, "FlashVersion": { "type": "string" }, "JavaApltInd": { "type": "string" }, "ActivexCtrlInd": { "type": "string" } } }, "VendorStatus": { "type": "object", "properties": { "VendorUniqueId": { "type": "string" }, "SessionId": { "type": "string" } } }, "AuditRequest": { "type": "object", "properties": { "CorrelationId": { "type": "string" }, "ConfirmationId": { "type": "string" }, "PhoenixCorrelationId": { "type": "string" }, "RequestAcknowledgentUrl": { "type": "string" }, "VendorUniqueId": { "type": "string" }, "IsAckReceived": { "format": "int32", "type": "integer" } } }, "ActivityLogDetails": { "type": "object", "properties": { "UniqueId": { "type": "string" }, "CorrelationId": { "type": "string" }, "UserAgent": { "type": "string" }, "RequestURL": { "type": "string" }, "IpAddress": { "type": "string" }, "PAN": { "type": "string" }, "RequestDateTime": { "format": "date-time", "type": "string" }, "MessageId": { "type": "string" }, "RequestAcknowledgentUrl": { "type": "string" }, "IsAckReceived": { "format": "int32", "type": "integer" }, "ResponsePrfncId": { "format": "int32", "type": "integer" }, "ResponseText": { "type": "string" }, "ExtendedData": { "type": "string" }, "NumberOfAdditionalRedemptions": { "format": "int32", "type": "integer" }, "Alias": { "type": "string" }, "RequestParam": { "type": "string" } } }, "UserDetail": { "type": "object", "properties": { "UserId": { "type": "string" }, "corelationId": { "type": "string" } } }, "GetCardsRequest": { "type": "object", "properties": { "appId": { "type": "string" }, "vendorUniqueId": { "type": "string" }, "requestTimeStamp": { "type": "string" } } }, "GetCardsResponse": { "type": "object", "properties": { "permanentAccountNumbers": { "type": "array", "items": { "$ref": "#/definitions/PermanentAccountNumber" } }, "responseCode": { "type": "string" }, "responseMessage": { "type": "string" }, "responseTimeStamp": { "type": "string" } } }, "PermanentAccountNumber": { "type": "object", "properties": { "cardAccountNumber": { "type": "string" }, "ProductType": { "type": "string" }, "EligibilityLevel": { "type": "string" } } }, "RegisterMerchantRequest": { "type": "object", "properties": { "appId": { "type": "string" }, "requestTimeStamp": { "type": "string" } } }, "RegisterMerchantResponse": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "merchantId": { "type": "string" }, "responseCode": { "type": "string" }, "responseMessage": { "type": "string" } } }, "ValidationResultRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" } } }, "ValidationResultResponse": { "type": "object", "properties": { "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "correlationId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "eligibilityLevel": { "type": "string" }, "isEligible": { "type": "string" }, "issuerBid": { "type": "string" }, "productType": { "type": "string" }, "productSubType": { "type": "string" }, "countryCode": { "type": "string" }, "binIndicator": { "type": "string" }, "acctFundSrce": { "type": "string" }, "acctFundSrceSubTyp": { "type": "string" }, "cardId": { "type": "string" }, "cardHolderId": { "type": "string" }, "bin": { "type": "string" }, "rpin": { "type": "string" }, "redemptionDetails": { "$ref": "#/definitions/RedemptionDetails" }, "aliasId": { "type": "string" } } }, "IframeRedeemRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" }, "mode": { "type": "string" } } }, "IframeRedeemResponse": { "type": "object", "properties": { "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "correlationId": { "type": "string" }, "responseTimeStamp": { "type": "string" } } }, "RegisteriFrameRequest": { "type": "object", "properties": { "vendorUniqueId": { "type": "string" }, "extendedData": { "type": "string" }, "requestTimeStamp": { "type": "string" }, "correlationId": { "type": "string" } } }, "RegisteriFrameResponse": { "type": "object", "properties": { "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "correlationId": { "type": "string" }, "responseTimeStamp": { "type": "string" }, "token": { "type": "string" }, "expiresIn": { "type": "string" } } }, "VendorIDRequest": { "type": "object", "properties": { "Token": { "type": "string" } } }, "VendorIDResponse": { "type": "object", "properties": { "VendorId": { "type": "string" }, "correlationId": { "type": "string" }, "statusCode": { "type": "string" }, "statusDescription": { "type": "string" }, "extendedData": { "type": "string" } } } } }