{"openapi":"3.0.0","info":{"description":"These are the reward order servicing APIs.","version":"1","title":"Rewards Order Processing Service"},"tags":[{"name":"cache"},{"name":"drawDownAccountBalance"},{"name":"eGiftBulkCodeRetrievalInfo"},{"name":"monitor"},{"name":"orderInfo"},{"name":"queryEmailTemplates"},{"name":"queryShippingFullInfo"},{"name":"queryShippingInfo"},{"name":"submitAnonymousInstantIssueFunding"},{"name":"submitClosedLoopAnonymous"},{"name":"submitClosedLoopIndividual"},{"name":"submitDemographicUpdate"},{"name":"submitEgiftBulk"},{"name":"submitEgiftIndividual"},{"name":"submitFunding"},{"name":"submitOpenLoopAnonymous"},{"name":"submitOpenLoopPersonalizedBulk"},{"name":"submitOpenLoopPersonalizedIndividual"},{"name":"submitPersonalizedInstantIssueFunding"},{"name":"submitRealTimeEgiftBulk"},{"name":"submitRealTimeEgiftIndividual"},{"name":"submitRealTimeFunding"},{"name":"submitRealTimeVirtualBulk"},{"name":"submitRealTimeVirtualIndividual"},{"name":"submitReversal"},{"name":"submitVirtualBulk"},{"name":"submitVirtualIndividual"},{"name":"virtualCodeRetrievalInfo"}],"paths":{"/drawDownAccountBalance":{"get":{"tags":["drawDownAccountBalance"],"summary":"getDrawDownAccountBalance","description":"Get the draw down account balance by providing the financial_account_id","operationId":"getDrawDownAccountBalance","parameters":[{"name":"financial_account_id","in":"query","description":"Financial Account 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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/DrawDownAccountBalanceInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/eGiftBulkCodeRetrievalInfo/byKeys":{"get":{"tags":["eGiftBulkCodeRetrievalInfo"],"summary":"byKeys","description":"Get the eGift bulk code retrieval information by passing orderNumber or requestId and clientProgramNumber","operationId":"getBulkEGiftInfoByKeys","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"A unique string identifier specified by the application making the request.","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/EGiftBulkCodeRetrievalInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EGiftBulkCodeRetrievalInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/monitor":{"get":{"tags":["monitor"],"summary":"getMonitoringStatus","description":"Shows if the order processing api is up and running","operationId":"getMonitoringStatus","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/orderInfo/byKeys":{"get":{"tags":["orderInfo"],"summary":"byKeys","description":"Get the order information by passing orderNumber or requestId and clientProgramNumber","operationId":"getThingByKeys","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"A unique string identifier specified by the application making the request.","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/OrderInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/queryEmailTemplates":{"get":{"tags":["queryEmailTemplates"],"summary":"queryEmailTemplatesInfoByClientProgram","description":"Get the email template info by passing clientProgramNumber","operationId":"queryEmailTemplatesInfoByClientProgram","parameters":[{"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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/EmailTemplateInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/queryShippingFullInfo":{"get":{"tags":["queryShippingFullInfo"],"summary":"queryShippingFullInfoByOrder","description":"Get the shipping full information with PID and proxy Number by passing orderNumber, cardholderFirstName, cardholderLastName. Ex:- ?orderNumber=&firstName=&lastName=","operationId":"queryShippingFullInfoByOrder","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":true,"schema":{"type":"string"}},{"name":"firstName","in":"query","description":"Card holder first name.","required":false,"schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Card holder last name.","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/ShippingFullInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingFullInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/queryShippingInfo":{"get":{"tags":["queryShippingInfo"],"summary":"queryShippingInfoByOrder","description":"Get the shipping information by passing orderNumber, cardholderFirstName, cardholderLastName. Ex:- ?orderNumber=&firstName=&lastName=","operationId":"queryShippingInfoByOrder","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":true,"schema":{"type":"string"}},{"name":"firstName","in":"query","description":"Card holder first name.","required":false,"schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Card holder last name.","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/ShippingInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitAnonymousInstantIssueFunding":{"post":{"tags":["submitAnonymousInstantIssueFunding"],"summary":"SubmitAnonymousInstantIssueFunding","description":"This sync/async service submits anonymous instant issue funding order","operationId":"doSubmitAnonymousInstantIssueFunding","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitAnonymousInstantIssueFundingRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAnonymousInstantIssueFundingResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAnonymousInstantIssueFundingResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAnonymousInstantIssueFundingResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitClosedLoopAnonymous":{"post":{"tags":["submitClosedLoopAnonymous"],"summary":"SubmitClosedLoopAnonymousRequest","description":"This service submits a closed loop anonymous order","operationId":"doSubmitClosedLoopAnonymous","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitClosedLoopAnonymousRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopAnonymousResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopAnonymousResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopAnonymousResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitClosedLoopIndividual":{"post":{"tags":["submitClosedLoopIndividual"],"summary":"SubmitClosedLoopIndividualRequest","description":"This service submits a closed loop individual order","operationId":"doSubmitClosedLoopPersonalized","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitClosedLoopIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitDemographicUpdate":{"post":{"tags":["submitDemographicUpdate"],"summary":"SubmitDemographicUpdate","description":"This service submits a demopgraphic update order","operationId":"doSubmitDemographicUpdate","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitDemographicUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDemographicUpdateResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDemographicUpdateResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDemographicUpdateResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitEgiftBulk":{"post":{"tags":["submitEgiftBulk"],"summary":"submitEGiftBulk","description":"This service will provide to submit EGift bulk order","operationId":"doSubmitEGiftBulk","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitEGiftBulkRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftBulkResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftBulkResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftBulkResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitEgiftIndividual":{"post":{"tags":["submitEgiftIndividual"],"summary":"submitEGiftIndividual","description":"This service will provide to submit EGift individual order","operationId":"doSubmitEGiftIndividual","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitEGiftIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEGiftIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitFunding":{"post":{"tags":["submitFunding"],"summary":"SubmitFunding","description":"This sync/async service submits funding order","operationId":"doSubmitFunding","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitFundingRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitFundingResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitFundingResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitFundingResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitOpenLoopAnonymous":{"post":{"tags":["submitOpenLoopAnonymous"],"summary":"submitOpenLoopAnonymous","description":"This service submits open loop anonymous order","operationId":"doSubmitOpenLoopAnonymous","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitOpenLoopAnonymousRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopAnonymousResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopAnonymousResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopAnonymousResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitOpenLoopPersonalizedBulk":{"post":{"tags":["submitOpenLoopPersonalizedBulk"],"summary":"SubmitOpenLoopPersonalizedBulk","description":"This service submits a personalized order.","operationId":"doSubmitOpenLoopPersonalizedBulk","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitOpenLoopPersonalizedBulkRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedBulkResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedBulkResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitOpenLoopPersonalizedIndividual":{"post":{"tags":["submitOpenLoopPersonalizedIndividual"],"summary":"SubmitOpenLoopPersonalizedIndividual","description":"This service submits a open loop personalized order","operationId":"doSubmitOpenLoopPersonalizedIndividual","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitPersonalizedInstantIssueFunding":{"post":{"tags":["submitPersonalizedInstantIssueFunding"],"summary":"SubmitPersonalizedInstantIssueFunding","description":"This sync/async service submits personalized instant issue funding order","operationId":"doSubmitInstantIssueFunding","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitPersonalizedInstantIssueFundingRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPersonalizedInstantIssueFundingResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPersonalizedInstantIssueFundingResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPersonalizedInstantIssueFundingResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitRealTimeEgiftBulk":{"post":{"tags":["submitRealTimeEgiftBulk"],"summary":"submitRealTimeEGiftBulk","description":"This service submits EGift real time bulk order","operationId":"doSubmitRealTimeEGiftBulk","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftBulkRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftBulkResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftBulkResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftBulkResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitRealTimeEgiftIndividual":{"post":{"tags":["submitRealTimeEgiftIndividual"],"summary":"submitRealTimeEGiftIndividual","description":"This service submits EGift real time individual order","operationId":"doSubmitRealTimeEGiftIndividual","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitRealTimeFunding":{"post":{"tags":["submitRealTimeFunding"],"summary":"SubmitRealTimeFunding","description":"This service submits real time funding order","operationId":"doSubmitRealTimeFunding","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeFundingRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeFundingResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeFundingResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeFundingResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitRealTimeVirtualBulk":{"post":{"tags":["submitRealTimeVirtualBulk"],"summary":"submitRealTimeVirtualBulk","description":"This service submits real time virtual bulk order","operationId":"doSubmitRealTimeVirtualBulk","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeVirtualBulkRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeVirtualBulkResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeVirtualBulkResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeVirtualBulkResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitRealTimeVirtualIndividual":{"post":{"tags":["submitRealTimeVirtualIndividual"],"summary":"submitRealTimeVirtualIndividual","description":"This service submits real time virtual individual order","operationId":"doSubmitRealTimeVirtualIndividual","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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"}},{"name":"SYNCHRONOUS_ONLY","in":"header","description":"true/false - Applies only to real-time orders against certain clientPrograms processed by Blackhawk Network. Default value is false. If the value is true and the order processing is not completed within the initial order request's millisecondsToWait time, then the order will be cancelled.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeVirtualIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitReversal":{"post":{"tags":["submitReversal"],"summary":"SubmitReversal","description":"This service submits reversal order","operationId":"doSubmitReversal","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitReversalRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitReversalResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitReversalResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitReversalResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitVirtualBulk":{"post":{"tags":["submitVirtualBulk"],"summary":"submitVirtualBulk","description":"This service submits virtual bulk order","operationId":"doSubmitVirtualBulk","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitVirtualBulkRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualBulkResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualBulkResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualBulkResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/submitVirtualIndividual":{"post":{"tags":["submitVirtualIndividual"],"summary":"submitVirtualIndividual","description":"This service submits virtual individual order","operationId":"doSubmitVirtualIndividual","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/SubmitVirtualIndividualRequest"}}},"required":true},"responses":{"200":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualIndividualResponse"}}}},"201":{"description":"Operation complete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualIndividualResponse"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitVirtualIndividualResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/virtualCodeRetrievalInfo/byKeys":{"get":{"tags":["virtualCodeRetrievalInfo"],"summary":"byKeys","description":"Get the virtual code retrieval information by passing orderNumber or requestId and clientProgramNumber","operationId":"getVirtualCardRetrievalCodeInfoByKeys","parameters":[{"name":"orderNumber","in":"query","description":"orderNumber.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"A unique string identifier specified by the application making the request.","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 unique string identifier specified by the application making the request.","required":true,"schema":{"type":"string"}},{"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/VirtualCodeRetrievalInfo"}}}},"202":{"description":"Operation is in process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCodeRetrievalInfo"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1"}],"components":{"schemas":{"AdditionalInfo":{"type":"object","properties":{"info1":{"type":"string","description":"Info1 must be 20 characters or less."},"info2":{"type":"string","description":"Info2 must be 20 characters or less."},"info3":{"type":"string","description":"Info3 must be 20 characters or less."},"info4":{"type":"string","description":"Info4 must be 20 characters or less."},"info5":{"type":"string","description":"Info5 must be 20 characters or less."}},"description":"Used to send the additional information to order line."},"AnonymousInstantIssueFundingOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"answers":{"$ref":"#/components/schemas/Answers"},"recipient":{"$ref":"#/components/schemas/AnonymousInstantIssueRecipient"}},"description":"Used the send the anonymous instant issue order line information."},"AnonymousInstantIssueRecipient":{"type":"object","required":["address","firstName","lastName"],"properties":{"proxyNumber":{"type":"string","description":"Proxy number."},"cardNumber":{"type":"string","description":"Card number."},"id":{"type":"string","description":"Id must be 30 characters or less."},"firstName":{"type":"string","description":"First name must be 25 characters or less."},"lastName":{"type":"string","description":"Last name must be 25 characters or less."},"prefix":{"type":"string","description":"Prefix must be 5 characters or less. Available options are: Mr, Mrs, Miss, Ms or blank."},"middleName":{"type":"string","description":"Middle name must be 25 characters or less."},"suffix":{"type":"string","description":"Suffix must be 5 characters or less."},"address":{"$ref":"#/components/schemas/RecipientAddress"},"phoneNumber":{"type":"string","description":"Phone number."},"email":{"type":"string","description":"Email must be 254 characters or less."}},"description":"Used the anonymous instant issue recipient information."},"AnonymousOrderLine":{"type":"object","required":["amount","deliveryAddress","quantity"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"id":{"type":"string","description":"Line id or Pid."},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"quantity":{"type":"integer","format":"int32","description":"Quantity must be greater than 0."},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]}},"description":"Used the send the order line information."},"Answers":{"type":"object","properties":{"answer1":{"type":"string","description":"Answer1 must be 255 characters or less."},"answer2":{"type":"string","description":"Answer2 must be 255 characters or less."},"answer3":{"type":"string","description":"Answer3 must be 255 characters or less."},"answer4":{"type":"string","description":"Answer4 must be 255 characters or less."},"answer5":{"type":"string","description":"Answer5 must be 255 characters or less."}},"description":"Used to send the answers to order line."},"ClosedLoopAnonymousOrderLine":{"type":"object","required":["amount","deliveryAddress","quantity"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"id":{"type":"string","description":"Line id or Pid."},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"quantity":{"type":"integer","format":"int32","description":"Quantity must be greater than 0."},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]},"contentProvider":{"type":"string","description":"Content provider."}},"description":"Used the send the order line information."},"ClosedLoopBulkOrderLine":{"type":"object","required":["amount","deliveryAddress","quantity","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/PersonalizedRecipient"},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]},"contentProvider":{"type":"string","description":"Content provider."},"groupingId":{"type":"string","description":"Grouping id must be 50 characters or less."},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"quantity":{"type":"integer","format":"int32","description":"Quantity must be greater than 0."}},"description":"Used the send the order line information."},"ClosedLoopIndividualOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/PersonalizedRecipient"},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]},"contentProvider":{"type":"string","description":"Content provider."},"groupingId":{"type":"string","description":"Grouping id must be 50 characters or less."}},"description":"Used the send the order line information."},"DeliveryAddress":{"type":"object","required":["city","country","firstName","lastName","line1","postalCode","region"],"properties":{"firstName":{"type":"string","description":"First name must be 45 characters or less."},"lastName":{"type":"string","description":"Last name must be 45 characters or less."},"company":{"type":"string","description":"Company must be 35 characters or less."},"line1":{"type":"string","description":"Line1 must be 35 characters or less."},"line2":{"type":"string","description":"Line2 must be 35 characters or less."},"line3":{"type":"string","description":"Line3 must be 35 characters or less."},"city":{"type":"string","description":"City must be 30 characters or less."},"region":{"type":"string","description":"Address region must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters."},"postalCode":{"type":"string","description":"Postal code must be 10 characters or less."},"postalCodeExt":{"type":"string","description":"Postal code ext must be 4 characters or less."},"country":{"type":"string","description":"Country must be the 3 alphabetic ISO code corresponding to the country."}},"description":"Used the send the delivery address."},"DemographicRecipient":{"type":"object","required":["address","firstName","id","lastName"],"properties":{"firstName":{"type":"string","description":"First name must be 25 characters or less."},"lastName":{"type":"string","description":"Last name must be 25 characters or less."},"company":{"type":"string"},"id":{"type":"string","description":"Id must be 30 characters or less."},"prefix":{"type":"string","description":"Prefix must be 5 characters or less. Available options are: Mr, Mrs, Miss, Ms or blank."},"middleName":{"type":"string","description":"Middle name must be 25 characters or less."},"suffix":{"type":"string","description":"Suffix must be 5 characters or less."},"address":{"$ref":"#/components/schemas/RecipientAddress"},"phoneNumber":{"type":"string","description":"Phone number."},"email":{"type":"string","description":"Email must be 254 characters or less."}},"description":"Recipient information."},"DemographicUpdateOrderLine":{"type":"object","required":["recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/DemographicRecipient"},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"programParticipationStatus":{"type":"string","description":"Program participation status.","enum":["ACTIVE","INACTIVE","CANCELLED","SUSPENDED","UNDER_REVIEW","VIP"]}},"description":"Used the send the demographic update order details information."},"DrawDownAccountBalanceInfo":{"type":"object","properties":{"entityId":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"updatedTimestamp":{"type":"string","format":"date-time"},"financial_account_id":{"type":"integer","format":"int64"},"balance":{"type":"number"},"balance_as_of":{"type":"string"},"currency":{"type":"string"}}},"EGift":{"type":"object","properties":{"url":{"type":"string","description":"URL."},"contentProviderCode":{"type":"string","description":"Content provider."},"amount":{"type":"number","description":"Amount."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"pin":{"type":"string","description":"Pin."},"cardNumber":{"type":"string","description":"Card number."},"barCodeValue":{"type":"string","description":"Bar code value."},"activationAccountNumber":{"type":"string","description":"Activation Account Number"},"securityCode":{"type":"string","description":"Security Code"}},"description":"Egift."},"EGiftBulkCodeRetrievalInfo":{"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."},"eGifts":{"type":"array","description":"Egifts.","items":{"$ref":"#/components/schemas/EGift"}}},"description":"Egift bulk info."},"EGiftBulkOrderLine":{"type":"object","required":["amount","quantity"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"quantity":{"type":"integer","format":"int32","description":"Quantity must be greater than 0."},"amount":{"type":"number","description":"Amount entered is invalid."},"contentProvider":{"type":"string","description":"Content provider must be 118 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"description":{"type":"string","description":"Description must be 40 characters or less."}},"description":"Used the send the EGift bulk OrderLine information."},"EGiftIndividualOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/VirtualIndividualRecipient"},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"contentProvider":{"type":"string","description":"Content provider must be 118 characters or less."}},"description":"Egift individual order line."},"EmailContent":{"type":"object","required":["unsubscribeData"],"properties":{"senderName":{"type":"string","description":"SenderName is required and cannot exceed 50 characters."},"senderEmail":{"type":"string","description":"SenderEmail is required and cannot exceed 254 characters."},"subject":{"type":"string","description":"Subject is required and cannot exceed 256 characters."},"emailMessage":{"type":"string","description":"EmailMessage is required and cannot exceed 10,000 characters."},"unsubscribeData":{"$ref":"#/components/schemas/UnsubscribeData"},"isDefaultTemplate":{"type":"boolean","description":"Indicates whether to save this email template as default.","default":false},"emailTemplateId":{"type":"string","description":"Email template id."}},"description":"Email content information."},"EmailTemplateInfo":{"type":"object","properties":{"emailTemplateId":{"type":"integer","format":"int64","description":"Email template id."},"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"isDefault":{"type":"boolean","description":"Indicates whether to save this email template as default.","default":false},"emailTemplateName":{"type":"string","description":"Email template name."}},"description":"Response of the order info query."},"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"}}}},"FundingOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/Recipient"},"amount":{"type":"number","description":"Amount should be greater than 0 and maximum 99999."},"description":{"type":"string","description":"Description must be 40 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"}},"description":"Used the send the funding order details information."},"OrderInfo":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number."},"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"requestId":{"type":"string","description":"A unique string identifier specified by the application making the request."},"proxyCardNumber":{"type":"string","description":"ProxyCardNumber."},"operationType":{"type":"string","description":"operationType."},"orderStatus":{"type":"string","description":"Order status."},"dateSubmitted":{"type":"string","format":"date-time","description":"Submitted date."},"completedDate":{"type":"string","description":"Completed date."},"numberOfCards":{"type":"integer","format":"int32","description":"No of cards."},"numberOfCardsErrored":{"type":"integer","format":"int32","description":"No of cards errored."},"totalCost":{"type":"number","description":"Total cost."},"errors":{"type":"array","description":"errors","items":{"$ref":"#/components/schemas/ErrorDetails"}},"cardErrors":{"type":"array","description":"cardErrors","items":{"$ref":"#/components/schemas/ErrorDetails"}},"totalCardValue":{"type":"number","description":"totalCardValue"},"totalCardFees":{"type":"number","description":"totalCardFees"},"totalDiscounts":{"type":"number","description":"totalDiscounts"},"totalShipping":{"type":"number","description":"totalShipping"},"totalTaxes":{"type":"number","description":"totalTaxes"}},"description":"Response of the order info query."},"PersonalizedBulkOrderLine":{"type":"object","required":["amount","deliveryAddress","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]},"recipient":{"$ref":"#/components/schemas/PersonalizedRecipient"},"activationCode":{"type":"string","description":"activationCode."},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"}},"description":"Used the send the personalized bulk order line information."},"PersonalizedInstantIssueFundingOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"answers":{"$ref":"#/components/schemas/Answers"},"recipient":{"$ref":"#/components/schemas/PersonalizedInstantIssueRecipient"}},"description":"Used the send the personalized instant issue order line information."},"PersonalizedInstantIssueRecipient":{"type":"object","required":["address","firstName","lastName"],"properties":{"firstName":{"type":"string","description":"First name must be 25 characters or less."},"lastName":{"type":"string","description":"Last name must be 25 characters or less."},"company":{"type":"string"},"id":{"type":"string","description":"Id must be 30 characters or less."},"prefix":{"type":"string","description":"Prefix must be 5 characters or less. Available options are: Mr, Mrs, Miss, Ms or blank."},"middleName":{"type":"string","description":"Middle name must be 25 characters or less."},"suffix":{"type":"string","description":"Suffix must be 5 characters or less."},"address":{"$ref":"#/components/schemas/RecipientAddress"},"phoneNumber":{"type":"string","description":"Phone number."},"email":{"type":"string","description":"Email must be 254 characters or less."},"proxyNumber":{"type":"string","description":"Proxy number."},"cardNumber":{"type":"string","description":"Card number."}},"description":"Used the personalized instant issue recipient information."},"PersonalizedOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"fourthLineEmbossText":{"type":"string","description":"Fourth line emboss text must be 21 characters or less."},"cardCarrierMessage":{"type":"string","description":"Card carrier message must be 80 characters or less."},"shippingMethod":{"type":"string","description":"Shipping method.","enum":["USPS_FIRST_CLASS","UPS_SECOND_DAY","UPS_NEXT_DAY","DHL_INTERNATIONAL","UPS_GROUND","USPS_FIRST_CLASS_PACKAGE","USPS_STANDARD_MAIL","USPS_FIRST_CLASS_INTERNATIONAL","USPS_PRIORITY_SIG","USPS_PRIORITY_MAIL","UPS_NEXT_DAY_SIGNATURE","UPS_SECOND_DAY_SIGNATURE","UPS_GROUND_SIGNATURE","FEDEX_GROUND","FEDEX_EXPRESS_SAVER","FEDEX_2DAY","FEDEX_STANDARD_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_GROUND_SIG","FEDEX_EXPRESS_SAVER_SIG","FEDEX_2DAY_SIG","FEDEX_STANDARD_OVERNIGHT_SIG","FEDEX_PRIORITY_OVERNIGHT_SIG"]},"recipient":{"$ref":"#/components/schemas/PersonalizedRecipient"},"activationCode":{"type":"string","description":"activationCode."}},"description":"Used the send the personalized order line information."},"PersonalizedRecipient":{"type":"object","required":["address","firstName","lastName"],"properties":{"firstName":{"type":"string","description":"First name must be 25 characters or less."},"lastName":{"type":"string","description":"Last name must be 25 characters or less."},"company":{"type":"string"},"id":{"type":"string","description":"Id must be 30 characters or less."},"prefix":{"type":"string","description":"Prefix must be 5 characters or less. Available options are: Mr, Mrs, Miss, Ms or blank."},"middleName":{"type":"string","description":"Middle name must be 25 characters or less."},"suffix":{"type":"string","description":"Suffix must be 5 characters or less."},"address":{"$ref":"#/components/schemas/RecipientAddress"},"phoneNumber":{"type":"string","description":"Phone number."},"email":{"type":"string","description":"Email must be 254 characters or less."}},"description":"Recipient information."},"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"}}},"Recipient":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id must be 30 characters or less."}},"description":"Recipient information."},"RecipientAddress":{"type":"object","required":["city","country","line1","postalCode","region"],"properties":{"line1":{"type":"string","description":"Line1 must be 35 characters or less."},"line2":{"type":"string","description":"Line2 must be 35 characters or less."},"line3":{"type":"string","description":"Line3 must be 35 characters or less."},"city":{"type":"string","description":"City must be 30 characters or less."},"region":{"type":"string","description":"Address region must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters."},"postalCode":{"type":"string","description":"Postal code must be 10 characters or less."},"postalCodeExt":{"type":"string","description":"Postal code ext must be 4 characters or less."},"country":{"type":"string","description":"Country must be the 3 alphabetic ISO code corresponding to the country."}},"description":"Used to send the recipient address."},"RecipientAddressForVolEgift":{"type":"object","properties":{"line1":{"type":"string","description":"Line1 must be 35 characters or less."},"line2":{"type":"string","description":"Line2 must be 35 characters or less."},"line3":{"type":"string","description":"Line3 must be 35 characters or less."},"city":{"type":"string","description":"City must be 30 characters or less."},"region":{"type":"string","description":"Address region must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters."},"postalCode":{"type":"string","description":"Postal code must be 10 characters or less."},"postalCodeExt":{"type":"string","description":"Postal code ext must be 4 characters or less."},"country":{"type":"string","description":"Country must be the 3 alphabetic ISO code corresponding to the country."}},"description":"Used to send the recipient address."},"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"},"millisecondsToWait":{"type":"integer","format":"int32"}}},"Response":{"type":"object","properties":{"entity":{"type":"object"},"metadata":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"status":{"type":"integer","format":"int32"}}},"ReversalOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"amount":{"type":"number","description":"Your reversal will be processed if it's submitted within the stipulated 10-day window after initial funding. It should match the funding amount."},"description":{"type":"string","description":"Description must be 40 characters or less."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"recipient":{"$ref":"#/components/schemas/Recipient"}},"description":"Used the send the reversal order line information."},"SMSContent":{"type":"object","required":["companyName"],"properties":{"smsMessage":{"type":"string","description":"SMS message cannot exceed 140 characters."},"companyName":{"type":"string","description":"Company must be 50 characters or less."}},"description":"SMS content information."},"ShippingFullInfo":{"type":"object","properties":{"message":{"type":"string","description":"message."},"shipDate":{"type":"string","format":"date-time","description":"Shipping date."},"shipMethod":{"type":"string","description":"Shipping method."},"trackingNumber":{"type":"string","description":"Tracking number."},"orderStatus":{"type":"string","description":"Order status."},"proxyNumber":{"type":"string","description":"Proxy number."},"pid":{"type":"string","description":"Pid"}},"description":"Response of the submit shipping info query."},"ShippingInfo":{"type":"object","properties":{"message":{"type":"string","description":"message."},"shipDate":{"type":"string","format":"date-time","description":"Shipping date."},"shipMethod":{"type":"string","description":"Shipping method."},"trackingNumber":{"type":"string","description":"Tracking number."},"orderStatus":{"type":"string","description":"Order status."}},"description":"Response of the submit shipping info query."},"SubmitAnonymousInstantIssueFundingRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["DRAW_DOWN"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Instant issue funding order line.","items":{"$ref":"#/components/schemas/AnonymousInstantIssueFundingOrderLine"}}},"description":"Submits a anonymous instant issue funding order."},"SubmitAnonymousInstantIssueFundingResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Anonymous instant issue funding response of the submitted order."},"SubmitAnonymousInstantIssueFundingTransaction":{"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/SubmitAnonymousInstantIssueFundingRequest"},"response":{"$ref":"#/components/schemas/SubmitAnonymousInstantIssueFundingResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitClosedLoopAnonymousRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Order line.","items":{"$ref":"#/components/schemas/ClosedLoopAnonymousOrderLine"}},"loadValuePhase":{"type":"string","description":"LoadValuePhase type.","enum":["ON_ISSUANCE","ON_SHIPMENT","ON_REQUEST"]}},"description":"Submits closed loop anonymous request."},"SubmitClosedLoopAnonymousResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Submit closed loop anonymous response."},"SubmitClosedLoopAnonymousTransaction":{"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/SubmitClosedLoopAnonymousRequest"},"response":{"$ref":"#/components/schemas/SubmitClosedLoopAnonymousResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitClosedLoopIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Closed loop individual order line.","items":{"$ref":"#/components/schemas/ClosedLoopIndividualOrderLine"}},"loadValuePhase":{"type":"string","description":"LoadValuePhase type.","enum":["ON_ISSUANCE","ON_SHIPMENT","ON_REQUEST"]}},"description":"Submits closed loop individual request."},"SubmitClosedLoopIndividualResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Submit closed loop individual response."},"SubmitClosedLoopIndividualTransaction":{"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/SubmitClosedLoopIndividualRequest"},"response":{"$ref":"#/components/schemas/SubmitClosedLoopIndividualResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitDemographicUpdateRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"orderDetails":{"type":"array","description":"Demographic update order line.","items":{"$ref":"#/components/schemas/DemographicUpdateOrderLine"}},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"}},"description":"Submits a demographic update order."},"SubmitDemographicUpdateResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Response of the submitted order."},"SubmitDemographicUpdateTransaction":{"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/SubmitDemographicUpdateRequest"},"response":{"$ref":"#/components/schemas/SubmitDemographicUpdateResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitEGiftBulkRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"returnCardNumberAndPIN":{"type":"boolean","description":"Return card number and PIN.","default":false},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"recipient":{"$ref":"#/components/schemas/VirtualRecipient"},"orderDetails":{"type":"array","description":"Egift bulk order line.","items":{"$ref":"#/components/schemas/EGiftBulkOrderLine"}}},"description":"Submits a eGift bulk order."},"SubmitEGiftBulkResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"EGfit bulk Response of the submitted order."},"SubmitEGiftBulkTransaction":{"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/SubmitEGiftBulkRequest"},"response":{"$ref":"#/components/schemas/SubmitEGiftBulkResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitEGiftIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"returnCardNumberAndPIN":{"type":"boolean","description":"Return card number and PIN.","default":false},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"smsContent":{"$ref":"#/components/schemas/SMSContent"},"rewardDeliveryMethod":{"type":"string","description":"Reward delivery method can be either Email or SMS","enum":["EMAIL","SMS"]},"emailContent":{"$ref":"#/components/schemas/EmailContent"},"orderDetails":{"type":"array","description":"Used the send the EGift individual OrderLine information.","items":{"$ref":"#/components/schemas/EGiftIndividualOrderLine"}}},"description":"Submits a eGift individual order."},"SubmitEGiftIndividualResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"EGfit individual Response of the submitted order."},"SubmitEGiftIndividualTransaction":{"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/SubmitEGiftIndividualRequest"},"response":{"$ref":"#/components/schemas/SubmitEGiftIndividualResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitFundingRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Funding order line.","items":{"$ref":"#/components/schemas/FundingOrderLine"}}},"description":"Submits a funding order."},"SubmitFundingResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Funding only Response of the submitted order."},"SubmitFundingTransaction":{"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/SubmitFundingRequest"},"response":{"$ref":"#/components/schemas/SubmitFundingResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitOpenLoopAnonymousRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Anonymous order line.","items":{"$ref":"#/components/schemas/AnonymousOrderLine"}}},"description":"Submits open loop anonymous request."},"SubmitOpenLoopAnonymousResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Submit open loop anonymous response."},"SubmitOpenLoopAnonymousTransaction":{"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/SubmitOpenLoopAnonymousRequest"},"response":{"$ref":"#/components/schemas/SubmitOpenLoopAnonymousResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitOpenLoopPersonalizedBulkRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Personalized bulk order line.","items":{"$ref":"#/components/schemas/PersonalizedBulkOrderLine"}}},"description":"Submits open loop personalized bulk order."},"SubmitOpenLoopPersonalizedBulkResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Response of the submitted open loop personalized bulk order."},"SubmitOpenLoopPersonalizedBulkTransaction":{"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/SubmitOpenLoopPersonalizedBulkRequest"},"response":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedBulkResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitOpenLoopPersonalizedIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Personalized Order Line.","items":{"$ref":"#/components/schemas/PersonalizedOrderLine"}}},"description":"Submits open loop personalized individual order."},"SubmitOpenLoopPersonalizedIndividualResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Response of the submitted open loop personalized individual order."},"SubmitOpenLoopPersonalizedIndividualTransaction":{"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/SubmitOpenLoopPersonalizedIndividualRequest"},"response":{"$ref":"#/components/schemas/SubmitOpenLoopPersonalizedIndividualResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitPersonalizedInstantIssueFundingRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["POST_PAY","DRAW_DOWN"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"type":"array","description":"Instant issue funding order line.","items":{"$ref":"#/components/schemas/PersonalizedInstantIssueFundingOrderLine"}}},"description":"Submits a personalized instant issue funding order."},"SubmitPersonalizedInstantIssueFundingResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Personalized instant issue funding response of the submitted order."},"SubmitPersonalizedInstantIssueFundingTransaction":{"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/SubmitPersonalizedInstantIssueFundingRequest"},"response":{"$ref":"#/components/schemas/SubmitPersonalizedInstantIssueFundingResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitRealTimeEGiftBulkRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"returnCardNumberAndPIN":{"type":"boolean","description":"Return card number and PIN.","default":false},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"recipient":{"$ref":"#/components/schemas/VirtualRecipient"},"orderDetails":{"type":"array","description":"Egift bulk order line.","items":{"$ref":"#/components/schemas/EGiftBulkOrderLine"}}},"description":"Submits a real time eGift bulk order."},"SubmitRealTimeEGiftBulkResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."},"contentProviderCode":{"type":"string","description":"Content provider."},"transactionAmount":{"type":"number","description":"Transaction amount."},"cardNumber":{"type":"string","description":"Card number."},"pin":{"type":"string","description":"Pin."},"url":{"type":"string","description":"URL."},"barCodeValue":{"type":"string","description":"Bar code value."},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date."},"activationAccountNumber":{"type":"string","description":"Activation Account Number"},"securityCode":{"type":"string","description":"Security Code"}},"description":"Real time EGfit bulk Response of the submitted order."},"SubmitRealTimeEGiftBulkTransaction":{"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/SubmitRealTimeEGiftBulkRequest"},"response":{"$ref":"#/components/schemas/SubmitRealTimeEGiftBulkResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitRealTimeEGiftIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"returnCardNumberAndPIN":{"type":"boolean","description":"Return card number and PIN.","default":false},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"smsContent":{"$ref":"#/components/schemas/SMSContent"},"rewardDeliveryMethod":{"type":"string","description":"Reward delivery method can be either Email or SMS","enum":["EMAIL","SMS"]},"emailContent":{"$ref":"#/components/schemas/EmailContent"},"orderDetails":{"type":"array","description":"Used the send the EGift individual OrderLine information.","items":{"$ref":"#/components/schemas/EGiftIndividualOrderLine"}}},"description":"Submits a real time eGift individual order."},"SubmitRealTimeEGiftIndividualResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Egift real time individual Response of the submitted order."},"SubmitRealTimeEGiftIndividualTransaction":{"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/SubmitRealTimeEGiftIndividualRequest"},"response":{"$ref":"#/components/schemas/SubmitRealTimeEGiftIndividualResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}},"description":"Real time EGfit individual transaction Response of the submitted order"},"SubmitRealTimeFundingRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"orderDetails":{"$ref":"#/components/schemas/FundingOrderLine"}},"description":"Submits a real time funding order."},"SubmitRealTimeFundingResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Real time funding only Response of the submitted order."},"SubmitRealTimeFundingTransaction":{"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/SubmitRealTimeFundingRequest"},"response":{"$ref":"#/components/schemas/SubmitRealTimeFundingResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitRealTimeVirtualBulkRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"recipient":{"$ref":"#/components/schemas/VirtualRecipient"},"orderDetails":{"type":"array","description":"Used the send the EGift bulk OrderLine information.","items":{"$ref":"#/components/schemas/VirtualBulkOrderLine"}}},"description":"Submits a real time virtual bulk order request."},"SubmitRealTimeVirtualBulkResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."},"virtualItemList":{"type":"array","description":"Virtual item list.","items":{"$ref":"#/components/schemas/VirtualItem"}}},"description":"Real time virtual bulk Response of the submitted order."},"SubmitRealTimeVirtualBulkTransaction":{"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/SubmitRealTimeVirtualBulkRequest"},"response":{"$ref":"#/components/schemas/SubmitRealTimeVirtualBulkResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitRealTimeVirtualIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"rewardDeliveryMethod":{"type":"string","description":"Reward delivery method can be either Email or SMS","enum":["EMAIL","SMS"]},"emailContent":{"$ref":"#/components/schemas/EmailContent"},"smsContent":{"$ref":"#/components/schemas/SMSContent"},"orderDetails":{"type":"array","description":"Used the send the virtual individual orderLine information.","items":{"$ref":"#/components/schemas/VirtualIndividualOrderLine"}}},"description":"Submits a real time virtual individual order."},"SubmitReversalRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"orderDetails":{"type":"array","description":"Reversal order line.","items":{"$ref":"#/components/schemas/ReversalOrderLine"}}},"description":"Submits a reversal order."},"SubmitReversalResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Response of the submitted reversal order."},"SubmitReversalTransaction":{"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/SubmitReversalRequest"},"response":{"$ref":"#/components/schemas/SubmitReversalResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitVirtualBulkRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"recipient":{"$ref":"#/components/schemas/VirtualRecipient"},"orderDetails":{"type":"array","description":"Used the send the EGift bulk OrderLine information.","items":{"$ref":"#/components/schemas/VirtualBulkOrderLine"}}},"description":"Submits a virtual bulk order request."},"SubmitVirtualBulkResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Virtual bulk Response of the submitted order."},"SubmitVirtualBulkTransaction":{"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/SubmitVirtualBulkRequest"},"response":{"$ref":"#/components/schemas/SubmitVirtualBulkResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"SubmitVirtualIndividualRequest":{"type":"object","required":["clientProgramNumber","orderDetails"],"properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"financialAccountId":{"type":"string","description":"Financial Account Id."},"paymentType":{"type":"string","description":"Payment type.","enum":["ACH_DEBIT","WIRE_TRANSFER","BUSINESS_CHECK","ACH_CREDIT","POST_PAY","DRAW_DOWN","INTER_COMPANY","CREDIT_TERMS","CODE_REDEMPTION","BANK_TRANSFER"]},"poNumber":{"type":"string","description":"PO number must be 50 characters or less."},"thirdPartyInfo":{"$ref":"#/components/schemas/ThirdPartyInfo"},"rewardDeliveryMethod":{"type":"string","description":"Reward delivery method can be either Email or SMS","enum":["EMAIL","SMS"]},"emailContent":{"$ref":"#/components/schemas/EmailContent"},"smsContent":{"$ref":"#/components/schemas/SMSContent"},"orderDetails":{"type":"array","description":"Used the send the virtual individual orderLine information.","items":{"$ref":"#/components/schemas/VirtualIndividualOrderLine"}}},"description":"Submits a virtual individual order."},"SubmitVirtualIndividualResponse":{"type":"object","properties":{"transactionId":{"type":"string"},"isCompleted":{"type":"boolean","default":false},"percentComplete":{"type":"integer","format":"int32"},"success":{"type":"boolean","description":"Indicates whether the submit request was successful.","default":false},"orderNumber":{"type":"string","description":"Submitted order number."}},"description":"Virtual individual Response of the submitted order."},"SubmitVirtualIndividualTransaction":{"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/SubmitVirtualIndividualRequest"},"response":{"$ref":"#/components/schemas/SubmitVirtualIndividualResponse"},"stepsCompleted":{"type":"integer","format":"int32"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingStep"}}}},"ThirdPartyAddress":{"type":"object","properties":{"company":{"type":"string","description":"Company must be 60 characters or less."},"contact":{"type":"string","description":"Contact must be 35 characters or less."},"line1":{"type":"string","description":"Line1 must be 35 characters or less."},"line2":{"type":"string","description":"Line2 must be 35 characters or less."},"line3":{"type":"string","description":"Line3 must be 35 characters or less."},"city":{"type":"string","description":"City must be 30 characters or less."},"region":{"type":"string","description":"Address region must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters."},"postalCode":{"type":"string","description":"Postal code must be 10 characters or less."},"postalCodeExt":{"type":"string","description":"Postal code ext must be 4 characters or less."},"country":{"type":"string","description":"Country must be the 3 alphabetic ISO code corresponding to the country."}},"description":"Used to send the third party address."},"ThirdPartyInfo":{"type":"object","required":["taxId"],"properties":{"address":{"$ref":"#/components/schemas/ThirdPartyAddress"},"taxId":{"type":"string","description":"Tax id must be 12 digits."}},"description":"Used to send the third party information."},"UnsubscribeData":{"type":"object","required":["methodType"],"properties":{"companyName":{"type":"string","description":"Company must be 50 characters or less."},"addressLine1":{"type":"string","description":"Address line1 is required and cannot exceed 200 characters."},"addressCity":{"type":"string","description":"Address city is required and cannot exceed 100 characters."},"addressState":{"type":"string","description":"Address state must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters."},"addressZip":{"type":"string","description":"AddressZip must be a valid 5-digit U.S. zip code or a valid international postal code less than 11 characters."},"addressCountry":{"type":"string","description":"Address country is required and must be either UNITED STATES or CANADA."},"methodType":{"type":"string","description":"Method is required and can be Email Or WebSite..","enum":["EMAIL","WEBSITE","NONE"]},"value":{"type":"string","description":"Value cannot exceed 255 characters."}},"description":"Used the send unsubscribe data of email content."},"VirtualBulkOrderLine":{"type":"object","required":["amount","quantity"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"quantity":{"type":"integer","format":"int32","description":"Must be 1 for real-time orders."},"amount":{"type":"number","description":"Amount entered is invalid."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"description":{"type":"string","description":"Description must be 40 characters or less."}},"description":"Virtual bulk order line."},"VirtualCode":{"type":"object","properties":{"code":{"type":"string","description":"Virtual Code."},"amount":{"type":"number","description":"Amount."},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"}},"description":"Virtual Code."},"VirtualCodeRetrievalInfo":{"type":"object","properties":{"clientProgramNumber":{"type":"integer","format":"int64","description":"Client program number."},"orderNumber":{"type":"string","description":"Order number."},"quantity":{"type":"integer","format":"int32","description":"Quantity."},"orderStatus":{"type":"string","description":"Order status."},"virtualCodes":{"type":"array","description":"Virtual Codes.","items":{"$ref":"#/components/schemas/VirtualCode"}}},"description":"Virtual code retrieval info."},"VirtualIndividualOrderLine":{"type":"object","required":["amount","recipient"],"properties":{"clientRefId":{"type":"string","description":"Unique Client Reference Id to identify duplicates."},"extraAttributes":{"type":"array","description":"Extra Field","items":{"type":"object","additionalProperties":{"type":"string"}}},"recipient":{"$ref":"#/components/schemas/VirtualIndividualRecipient"},"additionalInfo":{"$ref":"#/components/schemas/AdditionalInfo"},"amount":{"type":"number","description":"Amount entered is invalid."},"description":{"type":"string","description":"Description must be 40 characters or less."}},"description":"Virtual individual order line."},"VirtualIndividualRecipient":{"type":"object","required":["firstName","lastName"],"properties":{"id":{"type":"string","description":"Id must be 30 characters or less."},"firstName":{"type":"string","description":"First name must be 50 characters or less."},"lastName":{"type":"string","description":"Last name must be 50 characters or less."},"email":{"type":"string","description":"Email must be 254 characters or less."},"address":{"$ref":"#/components/schemas/RecipientAddressForVolEgift"},"phoneNumber":{"type":"string","description":"Phone number."}},"description":"Used the virtual recipient information."},"VirtualItem":{"type":"object","properties":{"code":{"type":"string","description":"Virtual code."},"amount":{"type":"string","description":"Amount."}},"description":"Virtual item."},"VirtualRecipient":{"type":"object","required":["firstName","lastName"],"properties":{"id":{"type":"string","description":"Id must be 30 characters or less."},"firstName":{"type":"string","description":"First name must be 50 characters or less."},"lastName":{"type":"string","description":"Last name must be 50 characters or less."},"email":{"type":"string","description":"Email must be 254 characters or less."}},"description":"Used the virtual recipient information."}}}}