{"openapi":"3.0.0","info":{"description":"These are the reward catalog APIs.","version":"1","title":"Rewards Catalog Processing Service"},"tags":[{"name":"clientProgram"},{"name":"clientProgramsBySubOrg"}],"paths":{"/clientProgram/byKey":{"get":{"tags":["clientProgram"],"summary":"clientProgram","description":"Get the client program information by passing Client Program ID","operationId":"getClientProgramByKey","parameters":[{"name":"clientProgramId","in":"query","description":"Client Program ID","required":true,"schema":{"type":"string"}},{"name":"MerchantId","in":"header","description":"A string identifier issued by BHN to each contractual legal entity for billing purposes","required":true,"schema":{"type":"string"}},{"name":"RequestId","in":"header","description":"A globally unique string identifier specified by the application making the request to be used during reconciliation and to facilitate idempotence.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProgram"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProgram"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/clientProgramsBySubOrg":{"get":{"tags":["clientProgramsBySubOrg"],"summary":"clientProgramsBySubOrg","description":"Get the client program by passing Sub Organization ID","operationId":"queryClientProgramsBySubOrg","parameters":[{"name":"subOrgId","in":"query","description":"Sub Organization ID","required":true,"schema":{"type":"string"}},{"name":"MerchantId","in":"header","description":"A string identifier issued by BHN to each contractual legal entity for billing purposes","required":true,"schema":{"type":"string"}},{"name":"RequestId","in":"header","description":"A globally unique string identifier specified by the application making the request to be used during reconciliation and to facilitate idempotence.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProgram"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientProgram"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://apipp.blackhawknetwork.com/rewardsCatalogProcessing/v1"}],"components":{"schemas":{"CardholderFee":{"type":"object","properties":{"calculationType":{"type":"string","description":"Calculation type","enum":["AMOUNT","PERCENT"]},"name":{"type":"string","description":"Name"},"amount":{"type":"number","description":"Amount"},"percent":{"type":"number","description":"Percent"}},"description":"Cardholder fee information."},"ClientProgram":{"type":"object","properties":{"clientProgramId":{"type":"integer","format":"int64","description":"Client program ID"},"programName":{"type":"string","description":"Program name"},"programType":{"type":"string","description":"Program type","enum":["PHYSICAL","DIGITAL"]},"currency":{"type":"string","description":"Currency"},"products":{"type":"array","description":"List of products","items":{"$ref":"#/components/schemas/Product"}}},"description":"Response object containing Client Program information."},"ErrorDetails":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string","format":"uri"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"additionalInfo":{"type":"object","additionalProperties":{"type":"string"}}}},"Expiration":{"type":"object","properties":{"type":{"type":"string","description":"Type","enum":["ROLLING","STATIC"]},"numberOfMonths":{"type":"integer","format":"int32","description":"Number of months"},"date":{"type":"string","format":"date-time","description":"Date"}},"description":"Expiration information."},"Product":{"type":"object","properties":{"contentProviderCode":{"type":"string","description":"Content provider code"},"productName":{"type":"string","description":"Product name"},"productDescription":{"type":"string","description":"Product description"},"parentBrandName":{"type":"string","description":"Parent brand name"},"redemptionInfo":{"type":"string","description":"Redemption info"},"termsAndConditions":{"$ref":"#/components/schemas/TermsAndConditions"},"productImage":{"type":"string","description":"Product image"},"logoImage":{"type":"string","description":"Logo image"},"valueRestrictions":{"$ref":"#/components/schemas/ValueRestrictions"},"offFaceDiscountPercent":{"type":"number","description":"Off face discount percent"},"expirationDescription":{"type":"string","description":"Expiration description"},"expiration":{"$ref":"#/components/schemas/Expiration"},"cardholderFees":{"type":"array","description":"List of card holder fees","items":{"$ref":"#/components/schemas/CardholderFee"}},"isSweep":{"type":"boolean","description":"Is sweep","default":false},"locale":{"type":"string","description":"Locale"}},"description":"Product information."},"TermsAndConditions":{"type":"object","properties":{"type":{"type":"string","description":"Terms and conditions type","enum":["INLINE","LINK"]},"url":{"type":"string","description":"URL"},"text":{"type":"string","description":"Text"}},"description":"Terms and conditions."},"ValueRestrictions":{"type":"object","properties":{"minimum":{"type":"number","description":"Minimum value"},"maximum":{"type":"number","description":"Maximum value"},"exclusivelyAllowedValues":{"type":"array","description":"List of exclusive allowed values","items":{"type":"number"}}},"description":"Value restrictions."}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}