{"openapi":"3.0.0","info":{"description":"These are the reward cards servicing APIs.","version":"1","title":"Rewards Card Processing Service"},"tags":[{"name":"activate"},{"name":"activateClosedLoop"},{"name":"activateClosedLoopCardsByRange"},{"name":"activateClosedLoopOrder"},{"name":"activationCodeRetrievalInfo"},{"name":"addMemo"},{"name":"cardBalance"},{"name":"cardDetails"},{"name":"cardHistoryByPid"},{"name":"cardHistoryByProxyNumber"},{"name":"cardsByCardholderName"},{"name":"cardsByCardholderPhoneNumber"},{"name":"cardsByPid"},{"name":"markLostStolen"},{"name":"orderActivationStatus"},{"name":"register"},{"name":"replace"},{"name":"suspend"},{"name":"updateCardholder"},{"name":"verify"},{"name":"voidEgift"}],"paths":{"/activate":{"post":{"tags":["activate"],"summary":"activate","description":"Given a card proxy number and expiration date, this sync/async service will activate a card","operationId":"doActivate","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activate/{transactionId}":{"get":{"tags":["activate"],"summary":"get activate status","description":"This service will provide the status of a previously issued activate request.","operationId":"getActivateStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoop":{"post":{"tags":["activateClosedLoop"],"summary":"ClosedLoopActivate","description":"Given a card number this sync/async service will activate a card","operationId":"doActivateCardNumber","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/ClosedLoopActivateRequest"},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoop/{transactionId}":{"get":{"tags":["activateClosedLoop"],"summary":"get activate status","description":"This service will provide the status of a previously issued activate request.","operationId":"getClosedLoopActivateStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoopCardsByRange":{"get":{"tags":["activateClosedLoopCardsByRange"],"summary":"cardProcessingData","description":"Get the card processing details information by passing request id","operationId":"getCardProcessingDataByRequestId","parameters":[{"name":"processingRequestId","in":"query","description":"processingRequestId","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["activateClosedLoopCardsByRange"],"summary":"ClosedLoopActivateByCardRange","description":"Given a card number range this sync/async service will activate a card","operationId":"doActivateCardsByRange","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateCardNumRangeRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoopCardsByRange/{transactionId}":{"get":{"tags":["activateClosedLoopCardsByRange"],"summary":"get activate card range status","description":"This service will provide the status of a previously issued activate request.","operationId":"getActivateCardRangeStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoopOrder":{"post":{"tags":["activateClosedLoopOrder"],"summary":"ClosedLoopActivateOrder","description":"Given a orderNumber this async service will activate  cards for the order","operationId":"doActivateByOrderNumber","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/ClosedLoopActivateRequest"},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateOrderResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateOrderResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activateClosedLoopOrder/{transactionId}":{"get":{"tags":["activateClosedLoopOrder"],"summary":"get activate status","description":"This service will provide the status of a previously issued activate request.","operationId":"getClosedLoopOrderActivateStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateOrderTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateOrderTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/activationCodeRetrievalInfo/byKeys":{"get":{"tags":["activationCodeRetrievalInfo"],"summary":"byKeys","description":"Get the Activation Code retrieval information by passing orderNumber or requestId and clientProgramNumber or proxyNumber","operationId":"getActivationCodeInfoByKeys","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":false,"schema":{"type":"string"}},{"name":"proxyNumber","in":"query","description":"proxyNumber.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"requestId.","required":false,"schema":{"type":"string"}},{"name":"clientProgramNumber","in":"query","description":"clientProgramNumber.","required":false,"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationCodeRetrievalInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationCodeRetrievalInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/addMemo":{"post":{"tags":["addMemo"],"summary":"addMemo","description":"This sync/async service will add a memo to a card. The note will be visible on the card account to customer service representatives and account managers. Add a memo when updating card status.","operationId":"doAddMemo","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMemoRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMemoResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMemoResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/addMemo/{transactionId}":{"get":{"tags":["addMemo"],"summary":"get add memo status","description":"this service will provide the status of a previously issued add memo request","operationId":"getAddMemoStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMemoTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMemoTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardBalance":{"get":{"tags":["cardBalance"],"summary":"cardBalance","description":"Retrieve the balance for a physical or digital closed loop merchant gift card by passing the card account number","operationId":"getCardBalanceByAccountNumber","parameters":[{"name":"accountNumber","in":"query","description":"accountNumber","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardDetails/byKeys":{"get":{"tags":["cardDetails"],"summary":"byKeys","description":"Get the card details information by passing either proxy number or productId and pid","operationId":"getCardDetailsByKeys","parameters":[{"name":"proxyNumber","in":"query","description":"proxyNumber","required":false,"schema":{"type":"string"}},{"name":"productId","in":"query","description":"productId","required":false,"schema":{"type":"string"}},{"name":"pid","in":"query","description":"pid","required":false,"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardHistoryByPid":{"get":{"tags":["cardHistoryByPid"],"summary":"cardHistoryByPid","description":"Get the card summary by passing pid and productId","operationId":"queryCardHistoryByPid","parameters":[{"name":"pid","in":"query","description":"pid","required":true,"schema":{"type":"string"}},{"name":"productId","in":"query","description":"productId","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSummary"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSummary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardHistoryByProxyNumber":{"get":{"tags":["cardHistoryByProxyNumber"],"summary":"cardHistoryByProxyNumber","description":"Get the card summary by passing proxy number","operationId":"queryCardHistoryByProxyNumber","parameters":[{"name":"proxyNumber","in":"query","description":"proxyNumber","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSummary"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSummary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardsByCardholderName":{"get":{"tags":["cardsByCardholderName"],"summary":"cardsByCardholderName","description":"Get the cards by passing card holder first and last name","operationId":"queryCardsByCardholderName","parameters":[{"name":"firstName","in":"query","description":"firstName","required":true,"schema":{"type":"string"}},{"name":"lastName","in":"query","description":"lastName","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardsByCardholderPhoneNumber":{"get":{"tags":["cardsByCardholderPhoneNumber"],"summary":"cardsByCardholderPhoneNumber","description":"Get the cards by passing card holder phone number","operationId":"queryCardsByCardholderPhoneNumber","parameters":[{"name":"phoneNumber","in":"query","description":"phoneNumber","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/cardsByPid":{"get":{"tags":["cardsByPid"],"summary":"cardsByPid","description":"Get the cards by passing pid and productId","operationId":"queryCardsByPid","parameters":[{"name":"pid","in":"query","description":"pid","required":true,"schema":{"type":"string"}},{"name":"productId","in":"query","description":"productId","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/markLostStolen":{"post":{"tags":["markLostStolen"],"summary":"markLostStolen","description":"This sync/async service updates the card status to Lost or Not Received and prevents further account activity. The card must currently have a status of Replaced, Closed or Expired.","operationId":"doMarkLostStolen","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkLostStolenRequest"}}},"required":true},"responses":{"200":{"description":"Operation succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkLostStolenResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkLostStolenResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/markLostStolen/{transactionId}":{"get":{"tags":["markLostStolen"],"summary":"Get mark lost/stolen status","description":"This service will provide the status of a previously issued mark lost/stolen request","operationId":"getMarkLostStolenStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkLostStolenTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkLostStolenTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/orderActivationStatus":{"get":{"tags":["orderActivationStatus"],"summary":"byKeys","description":"Get the Bulk Activation status information by passing orderNumber or requestId and clientProgramNumber","operationId":"getBulkActivationInfoByKeys","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"requestId.","required":false,"schema":{"type":"string"}},{"name":"clientProgramNumber","in":"query","description":"clientProgramNumber.","required":false,"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderActivationStatusResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderActivationStatusResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/register":{"post":{"tags":["register"],"summary":"register","description":"This sync/async service will register cardholder information for the given card","operationId":"doRegister","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/register/{transactionId}":{"get":{"tags":["register"],"summary":"get register status","description":"This service will provide the status of a previously issued register request.","operationId":"getRegisterStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/replace":{"post":{"tags":["replace"],"summary":"replace","description":"This sync/async service will replace a card based on supplied card identifier.","operationId":"doReplace","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/replace/{transactionId}":{"get":{"tags":["replace"],"summary":"get replace status","description":"This service will provide the status of a previously issued replace request.","operationId":"getReplaceStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suspend":{"post":{"tags":["suspend"],"summary":"suspend","description":"This sync/async service will suspend or unsuspend card based on the supplied criteria.","operationId":"doSuspend","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/suspend/{transactionId}":{"get":{"tags":["suspend"],"summary":"get suspend status","description":"This service will provide the status of a previously issued suspend request.","operationId":"getSuspendStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuspendTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/updateCardholder":{"post":{"tags":["updateCardholder"],"summary":"updateCardholder","description":"This sync/async service will update the cardholder details based on the supplied criteria","operationId":"doUpdateCardholder","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/updateCardholder/{transactionId}":{"get":{"tags":["updateCardholder"],"summary":"get update cardholder status","description":"This service will provide the status of a previously issued update cardholder request.","operationId":"getUpdateCardholderStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/verify":{"post":{"tags":["verify"],"summary":"verify","description":"This asynchronous service will verify card information and return the proxy if valid.","operationId":"doVerifyCard","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verifyResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/verify/{transactionId}":{"get":{"tags":["verify"],"summary":"get update cardholder status","description":"This service will provide the status of a previously issued verify request.","operationId":"getVerifyStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardholderTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/voidEgift":{"post":{"tags":["voidEgift"],"summary":"VoidEgift","description":"Given a card number this sync/async service will void the card","operationId":"doVoidEgift","parameters":[{"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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEgiftRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEgiftResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEgiftResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/voidEgift/{transactionId}":{"get":{"tags":["voidEgift"],"summary":"get activate status","description":"This service will provide the status of a previously issued activate request.","operationId":"getVoidEgiftStatus","parameters":[{"name":"transactionId","in":"path","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"}},{"name":"previousAttempts","in":"header","description":"The number of times this request has been unsuccessfully attempted before.","required":false,"schema":{"type":"integer"}},{"name":"millisecondsToWait","in":"header","description":"A value between 0 - 30000 indicating how long the client is willing to wait for the transaction to complete before receiving the result.","required":false,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEgiftTransaction"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEgiftTransaction"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://apipp.blackhawknetwork.com/rewardsCardProcessing/v1"}],"components":{"requestBodies":{"ClosedLoopActivateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedLoopActivateRequest"}}},"required":true}},"schemas":{"ActivateRequest":{"type":"object","required":["expirationMonth","expirationYear","proxyNumber"],"properties":{"proxyNumber":{"type":"string","example":"1234567890123456789","description":"The proxy number corresponding to the card."},"expirationMonth":{"type":"integer","format":"int32","example":10,"description":"The expiration month on the card."},"expirationYear":{"type":"integer","format":"int32","example":2018,"description":"The four-digit expiration year on the card."}},"description":"Identifies a card to activate."},"ActivateResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the ActivateRequest transaction was successful.","default":false}}},"ActivateTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/ActivateRequest"},"response":{"$ref":"#/components/schemas/ActivateResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"ActivationCode":{"type":"object","properties":{"proxyNumber":{"type":"string","description":"Proxy number."},"pid":{"type":"string","description":"Pid"},"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"activationCode":{"type":"string","description":"activationCode."},"amount":{"type":"number","description":"Amount."}},"description":"activationCode."},"ActivationCodeRetrievalInfo":{"type":"object","properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"orderNumber":{"type":"string","description":"Order number."},"orderStatus":{"type":"string","description":"Order status."},"quantity":{"type":"integer","format":"int32","description":"Quantity."},"activationCodes":{"type":"array","description":"Egifts.","items":{"$ref":"#/components/schemas/ActivationCode"}},"orderErrorList":{"type":"array","description":"List of activation response.","items":{"$ref":"#/components/schemas/CardError"}}},"description":"activationCode."},"AddMemoRequest":{"type":"object","required":["comment","pidCriteria","proxyNumber"],"properties":{"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"comment":{"type":"string","description":"The memo to be added to the cardholder account, up to 255 characters."}},"description":"Identifies a cardholder and memo to add to the cardholder account. One of <code>PidCriteria</code> or <code>proxyNumber</code> is required."},"AddMemoResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the add memo request was successful.","default":false}}},"AddMemoTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/AddMemoRequest"},"response":{"$ref":"#/components/schemas/AddMemoResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"Address":{"type":"object","required":["addressLine1","city","country","postalCode","region"],"properties":{"addressLine1":{"type":"string","description":"Address Line 1"},"addressLine2":{"type":"string","description":"Address Line 2"},"city":{"type":"string","description":"City"},"region":{"type":"string","description":"Region, state, or province."},"postalCode":{"type":"string","description":"Zip Code or Postal Code."},"country":{"type":"string","example":"USA for United States, CAN for Canada, BRA for Brazil","description":"Three-letter alphabetic ISO code corresponding to the country."}},"description":"Used in various requests to update or view a cardholder's address."},"Card":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"firstName":{"type":"string"},"middleInitial":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"pid":{"type":"string"},"proxyNumber":{"type":"string"},"maskedCardNumber":{"type":"string"},"expirationMonth":{"type":"integer","format":"int32"},"expirationYear":{"type":"integer","format":"int32"},"cardStatus":{"type":"string"},"productId":{"type":"integer","format":"int64"},"programName":{"type":"string"},"balance":{"type":"number"},"orderNumber":{"type":"integer","format":"int64"},"orderDate":{"type":"string","format":"date-time"},"original":{"type":"boolean","default":false},"current":{"type":"boolean","default":false}}},"CardBalance":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"balance":{"type":"number"},"balanceAsOf":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string"},"balanceStale":{"type":"boolean","default":false}}},"CardError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}},"CardProcessingData":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"orderNumber":{"type":"string"},"proxyCardNumber":{"type":"string"},"operationType":{"type":"string"},"status":{"type":"string"},"statusDetails":{"type":"string"},"activationDate":{"type":"string","format":"date-time"}}},"CardSummary":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"proxyNumber":{"type":"string","description":"Proxy number."},"maskedCardNumber":{"type":"string","description":"Masked card number."},"expirationMonth":{"type":"integer","format":"int32","description":"Expiration month."},"expirationYear":{"type":"integer","format":"int32","description":"Expiration Year."},"cardStatus":{"type":"string","description":"Card Status."},"issueDate":{"type":"string","format":"date-time","description":"Issue Date."}},"description":"Response object containing an individual card on an account."},"ClosedLoopActivateCardNumRangeRequest":{"type":"object","required":["fromCardNumber","toCardNumber"],"properties":{"fromCardNumber":{"type":"string","example":"1234567890123456789","description":"The proxy number corresponding to the card."},"toCardNumber":{"type":"string","example":"1234567890123456789","description":"The proxy number corresponding to the card."}},"description":"Identifies a cards to activate for closed loop."},"ClosedLoopActivateOrderResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the ActivateRequest transaction was successful.","default":false},"activationRequestState":{"type":"string","description":"Indicates whether the ActivateRequest transaction was complete."},"progressMessage":{"type":"string","description":"Indicates how many cards are activated."},"progressDatetime":{"type":"string","description":"Activation progress time."},"errors":{"type":"array","description":"List of activation response.","items":{"$ref":"#/components/schemas/CardError"}}}},"ClosedLoopActivateOrderTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/ClosedLoopActivateRequest"},"response":{"$ref":"#/components/schemas/ClosedLoopActivateOrderResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"ClosedLoopActivateRequest":{"type":"object","required":["cardNumber"],"properties":{"cardNumber":{"type":"string","example":"1234567890123456789","description":"The proxy number corresponding to the card."}},"description":"Identifies a card to activate for closed loop."},"ClosedLoopActivateResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the ActivateRequest transaction was successful.","default":false},"processingRequestId":{"type":"string"}}},"ClosedLoopActivateTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/ClosedLoopActivateRequest"},"response":{"$ref":"#/components/schemas/ClosedLoopActivateResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"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"}}}},"MarkLostStolenRequest":{"type":"object","required":["pidCriteria","proxyNumber"],"properties":{"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"reason":{"type":"string","description":"reason","enum":["lost","notreceived"]}},"description":"Used to identify a card account lost or stolen. One of <code>PidCriteria</code> or <code>proxyNumber</code> is required."},"MarkLostStolenResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","default":false}}},"MarkLostStolenTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/MarkLostStolenRequest"},"response":{"$ref":"#/components/schemas/MarkLostStolenResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"OrderActivationStatusResponse":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"activationRequestState":{"type":"string","description":"Indicates whether the ActivateRequest transaction was complete."},"progressMessage":{"type":"string","description":"Indicates how many cards are activated."},"progressDatetime":{"type":"string","description":"Activation progress time."},"errors":{"type":"array","description":"List of activation response.","items":{"$ref":"#/components/schemas/CardError"}}}},"PidCriteria":{"type":"object","required":["pid","productId"],"properties":{"productId":{"type":"integer","format":"int64","description":"The numeric client-specific product identifier associated with this cardholder."},"pid":{"type":"string","description":"The unique, alphanumeric participant identifier associated with the cardholder. Maximum 30 characters."}}},"ProcessingStep":{"type":"object","properties":{"descriptionTag":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"errors":{"$ref":"#/components/schemas/ErrorResponse"},"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"}}},"RegisterRequest":{"type":"object","required":["address","firstName","lastName","pidCriteria","proxyNumber"],"properties":{"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"firstName":{"type":"string","description":"Cardholder first name."},"lastName":{"type":"string","description":"Cardholder last name"},"middleInitial":{"type":"string","description":"First letter of the cardholder's middle name."},"phoneNumber":{"type":"string","example":"13145551212","description":"Cardholder's phone number. Up to 23 digits, numbers only, no punctuation."},"emailAddress":{"type":"string","example":"name@example.com","description":"Cardholder's email address."},"address":{"$ref":"#/components/schemas/Address"}},"description":"Used to identify the cardholder and provide demographic information for registering a card."},"RegisterResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","default":false}}},"RegisterTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/RegisterRequest"},"response":{"$ref":"#/components/schemas/RegisterResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"ReplaceRequest":{"type":"object","required":["comment","reason"],"properties":{"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"reason":{"type":"string","description":"The code corresponding to the reason for replacement.","enum":["lost","notreceived"]},"comment":{"type":"string","description":"Required comment regarding the card replacement."}},"description":"Used to replace an existing card. Either pidCriteria or proxyNumber is required."},"ReplaceResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"proxyNumber":{"type":"string"},"maskedCardNumber":{"type":"string"},"expirationMonth":{"type":"integer","format":"int32"},"expirationYear":{"type":"integer","format":"int32"}}},"ReplaceTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/ReplaceRequest"},"response":{"$ref":"#/components/schemas/ReplaceResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"RequestContext":{"type":"object","properties":{"merchantId":{"type":"string"},"tenantId":{"type":"string"},"roleId":{"type":"string"},"certificateId":{"type":"string"},"correlationId":{"type":"string"},"agent":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"requestId":{"type":"string"},"previousAttempts":{"type":"integer","format":"int32"},"millisecondsToWait":{"type":"integer","format":"int32"}}},"SuspendRequest":{"type":"object","required":["comment","reason","status"],"properties":{"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"reason":{"type":"string","description":"Reason for the suspension. Use Per cardholder Request or Per Client Request when unsuspending. Use Card Delivery Problem, Misuse, Per Cardholder Request, or Per Client Request when suspending.","enum":["Per cardholder Request","Per Client Request","Card Delivery Problem","Misuse"]},"comment":{"type":"string","description":"Required additional comment regarding the suspension. Maximum length is 255 characters."},"status":{"type":"string","description":"The action to take on the card account. <code>suspend</code> is valid for active cards, <code>unsuspend</code> is valid only for cards currently in Suspended status.","enum":["suspend","unsuspend"]}},"description":"Used to suspend a card and prevent any further activity, or to unsuspend a card. Either PidCriteria or proxyNumber is required."},"SuspendResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","default":false}}},"SuspendTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/SuspendRequest"},"response":{"$ref":"#/components/schemas/SuspendResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"UpdateCardholderRequest":{"type":"object","required":["pidCriteria","proxyNumber"],"properties":{"proxyNumber":{"type":"string","example":"1234567890123456789","description":"Used to identify the cardholder by card proxy number."},"pidCriteria":{"$ref":"#/components/schemas/PidCriteria"},"firstName":{"type":"string","description":"Provide to update the cardholder's first name."},"middleInitial":{"type":"string","description":"Provide to update the cardholder's middle initial."},"lastName":{"type":"string","description":"Provide to update the cardholder's last name."},"phoneNumber":{"type":"string","description":"Provide to update the cardholder's phone number."},"email":{"type":"string","description":"Provide to update the cardholder's email address."},"address":{"$ref":"#/components/schemas/Address"}},"description":"Contains the attributes for updating cardholder demographic data. Either <code>proxyNumber</code> or <code>pidCriteria</code> is required to identify the cardholder. At least one property to be updated must be provided. Properties not provided will not be changed."},"UpdateCardholderResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"card":{"$ref":"#/components/schemas/Card"}}},"UpdateCardholderTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/UpdateCardholderRequest"},"response":{"$ref":"#/components/schemas/UpdateCardholderResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"VerifyRequest":{"type":"object","required":["cardNumber","cvv","expirationMonth","expirationYear"],"properties":{"cardNumber":{"type":"string","example":"5111111111111111"},"cvv":{"type":"string","example":"1234"},"expirationMonth":{"type":"integer","format":"int32","example":11},"expirationYear":{"type":"integer","format":"int32","example":2017}},"description":"Used to validate a card by card number, expiration date, and CVV."},"VoidEgiftRequest":{"type":"object","required":["cardNumber"],"properties":{"cardNumber":{"type":"string","example":"1234567890123456789","description":"The proxy number corresponding to the card."}},"description":"Voids a egift clsoed loop card ."},"VoidEgiftResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the ActivateRequest transaction was successful.","default":false},"notes":{"type":"string"},"giftFrom":{"type":"string"},"giftTo":{"type":"string"},"giftMessage":{"type":"string"},"giftAmount":{"type":"number"},"giftCurrency":{"type":"string"},"retrievalReferenceNumber":{"type":"string"},"status":{"type":"string"},"productConfigurationId":{"type":"string"},"accountId":{"type":"string"},"isVoid":{"type":"boolean","default":false},"recipientId":{"type":"string"},"purchaserId":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CardError"}}}},"VoidEgiftTransaction":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"completionTime":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"status":{"type":"string","enum":["QUEUED","PROCESSING","COMPLETED","FAILED"]},"isReversible":{"type":"boolean","default":false},"wasReversed":{"type":"boolean","default":false},"context":{"$ref":"#/components/schemas/RequestContext"},"request":{"$ref":"#/components/schemas/VoidEgiftRequest"},"response":{"$ref":"#/components/schemas/VoidEgiftResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"verifyResponse":{"type":"object","properties":{"proxyNumber":{"type":"string"},"cardStatus":{"type":"string"}}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}