{"items":[{"type":"link","label":"Shift4 Payment API","link":"/apis/payments-platform-rest/openapi","routeSlug":"/apis/payments-platform-rest/openapi","content":{"contentType":"overview","meta":{"name":"Shift4 Payment API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.shift4.com/contact-us/","url":"https://www.shift4.com/contact-us/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shift4 Payment API (1.7.61)","showPageActions":true}],"sectionId":"/apis/payments-platform-rest/openapi"}]}]}},{"type":"group","label":"Credentials","link":"/apis/payments-platform-rest/openapi/credentials","routeSlug":"/apis/payments-platform-rest/openapi/credentials","items":[{"label":"Access Token Exchange","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange","routeSlug":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange","metadata":{"seo":{"title":"Access Token Exchange","description":"This function is used to request exchanging a Client GUID and Auth Token for an Access Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"accesstokenexchange","name":"Access Token Exchange","isWebhook":false,"pointer":"/paths/~1credentials~1accesstoken/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Token Exchange","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request exchanging a Client GUID and Auth Token for an Access Token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credentials~1accesstoken/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222"}},"schemaId":"schema_222","pointer":"/paths/~1credentials~1accesstoken/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credentials/accesstoken","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_222"}},"responseCodes":["200","400","504"],"pointer":"/credentials/accesstoken","href":"credentials/accesstokenexchange","openApiOperationId":"accesstokenexchange","summary":"Access Token Exchange"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_222","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AccessToken request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223"}},"schemaId":"schema_223"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1credentials~1accesstoken/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_223","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/accesstokenexchange"}],"panels":[]}]},"httpPath":"/credentials/accesstoken"}],"content":{"contentType":"group","meta":{"name":"Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credentials/accesstoken","summary":"Access Token Exchange","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credentials/accesstokenexchange","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/apis/payments-platform-rest/openapi/transactions","routeSlug":"/apis/payments-platform-rest/openapi/transactions","items":[{"label":"Authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/transactionsauthorization","routeSlug":"/apis/payments-platform-rest/openapi/transactions/transactionsauthorization","metadata":{"seo":{"title":"Authorization","description":"Used to request processor approval for an authorization. If the invoice number already exists, the amount requested will be compared to the approved amount on file, and Shift4 will request approval for the additional amount only. If approved, an updated transaction will be displayed in Lighthouse Transaction Manager.  This step does NOT close and capture the funds, only authorizes the payment request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactionsauthorization","name":"Authorization","isWebhook":false,"pointer":"/paths/~1transactions~1authorization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request processor approval for an authorization. If the invoice number already exists, the amount requested will be compared to the approved amount on file, and Shift4 will request approval for the additional amount only. If approved, an updated transaction will be displayed in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ltm.shift4test.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lighthouse Transaction Manager"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This step does NOT close and capture the funds, only authorizes the payment request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that if you are tokenzing your credit card information outside of Shift4, authorizing and capturing a payment is not available unless you store the tokenized value from Shift4 from an authorized payment request and  use this token in the subsequent capture request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1authorization/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_227"}},"schemaId":"schema_227","pointer":"/paths/~1transactions~1authorization/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/authorization","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_227"}},"responseCodes":["200","400","504"],"pointer":"/transactions/authorization","href":"transactions/transactionsauthorization","openApiOperationId":"transactionsauthorization","summary":"Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_227","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_227"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc"]}},"schemaId":"schema_228","exampleIds":["paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1authorization/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1authorization/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1authorization/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_228","exampleIds":["paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc"]}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1authorization/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1authorization/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionsauthorization"}],"panels":[]}]},"httpPath":"/transactions/authorization"},{"label":"Capture","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/transactionscapture","routeSlug":"/apis/payments-platform-rest/openapi/transactions/transactionscapture","metadata":{"seo":{"title":"Capture","description":"Used to close out an existing authorization request. If the invoice number  already exists, the amount requested will be compared to the approved amount  on file, and Shift4 will request approval for the additional amount only. If approved, the authorization will be converted to a sale transaction  and be ready to be batched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactionscapture","name":"Capture","isWebhook":false,"pointer":"/paths/~1transactions~1capture/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capture","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to close out an existing authorization request. If the invoice number  already exists, the amount requested will be compared to the approved amount  on file, and Shift4 will request approval for the additional amount only. If approved, the authorization will be converted to a sale transaction  and be ready to be batched."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Restaurant industry, review "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/restaurant-authorization-and-settlement-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restaurant Authorization and Settlement Flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that if you are tokenzing your credit card information outside of  Shift4, authorizing and capturing a payment is not available unless you store  the tokenized value from Shift4 from an authorized payment request and use this  token in the subsequent capture request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1capture/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230"}},"schemaId":"schema_230","pointer":"/paths/~1transactions~1capture/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/capture","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_230"}},"responseCodes":["200","400","504"],"pointer":"/transactions/capture","href":"transactions/transactionscapture","openApiOperationId":"transactionscapture","summary":"Capture"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_230","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231"}},"schemaId":"schema_231"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1capture/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1capture/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1capture/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_231","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1capture/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1capture/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionscapture"}],"panels":[]}]},"httpPath":"/transactions/capture"},{"label":"Sale/Purchase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/transactionssale","routeSlug":"/apis/payments-platform-rest/openapi/transactions/transactionssale","metadata":{"seo":{"title":"Sale/Purchase","description":"Used to request processor approval for an authorization and capture in one request. If the invoice number already exists, the amount requested will be compared to the approved amount on file, and Shift4 will request approval for the additional amount only. If approved, a new sale transaction  will be displayed in Lighthouse Transaction Manager and be ready to be batched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactionssale","name":"Sale/Purchase","isWebhook":false,"pointer":"/paths/~1transactions~1sale/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sale/Purchase","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request processor approval for an authorization and capture in one request. If the invoice number already exists, the amount requested will be compared to the approved amount on file, and Shift4 will request approval for the additional amount only. If approved, a new sale transaction  will be displayed in Lighthouse Transaction Manager and be ready to be batched."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1sale/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232","pointer":"/paths/~1transactions~1sale/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/sale","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_232"}},"responseCodes":["200","400","504"],"pointer":"/transactions/sale","href":"transactions/transactionssale","openApiOperationId":"transactionssale","summary":"Sale/Purchase"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc"]}},"schemaId":"schema_233","exampleIds":["paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1sale/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1sale/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1sale/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_233","exampleIds":["paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track","paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc"]}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1sale/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1sale/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionssale"}],"panels":[]}]},"httpPath":"/transactions/sale"},{"label":"Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/refund","routeSlug":"/apis/payments-platform-rest/openapi/transactions/refund","metadata":{"seo":{"title":"Refund","description":"This function can be used to refund a transaction for either the full or a partial amount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refund","name":"Refund","isWebhook":false,"pointer":"/paths/~1transactions~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function can be used to refund a transaction for either the full or a partial amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_234"}},"schemaId":"schema_234","pointer":"/paths/~1transactions~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/refund","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_234"}},"responseCodes":["200","400","504"],"pointer":"/transactions/refund","href":"transactions/refund","openApiOperationId":"refund","summary":"Refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_234","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_234"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235"}},"schemaId":"schema_235"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1refund/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1refund/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_235","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1refund/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1refund/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/refund"}],"panels":[]}]},"httpPath":"/transactions/refund"},{"label":"Invoice Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/getinvoice","routeSlug":"/apis/payments-platform-rest/openapi/transactions/getinvoice","metadata":{"seo":{"title":"Invoice Information","description":"Used to request the status (e.g., approved, declined, error, referral, etc.) for a specific invoice; it is primarily used after a timeout or error has occurred. Voided or batched and settled invoices will return an “Invoice Not Found” error. For more information, see the Timeouts and Communication Failures section."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getinvoice","name":"Invoice Information","isWebhook":false,"pointer":"/paths/~1transactions~1invoice/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request the status (e.g., approved, declined, error, referral, etc.) for a specific invoice; it is primarily used after a timeout or error has occurred. Voided or batched and settled invoices will return an “Invoice Not Found” error. For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/response-handling/timeouts-and-communications-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeouts and Communication Failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The GET request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Invoice","in":"header","schemaId":"schema_236","required":true},{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"ApiOptions","in":"header","schemaId":"schema_237","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options modify the request being made. Multiple API Options can be sent in a comma separated list with no spaces. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}],"example":"ALLOWPARTIALAUTH,RETURNEXPDATE"},{"name":"ReceiptColumns","in":"header","schemaId":"schema_238","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send this field if you want Shift4 to format the receipt text instead of returning individual fields. The value sent will correlate to the column width of the formatted receipt that we return. (This also allows the receipt text to wrap to fit the paper size of the printed receipt.) See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/printing-receipts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Printing Receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more information on formatted receipts."},"children":[]}]}]}]},{"name":"Token","in":"header","schemaId":"schema_239","description":"This field is used to specify the token for the payment method."}],"pointer":"/paths/~1transactions~1invoice/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/invoice","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Invoice","in":"header","required":true,"example":"0510093358","schemaId":"components/schemas/TransactionInvoice"},{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"ApiOptions","in":"header","required":false,"example":"ALLOWPARTIALAUTH,RETURNEXPDATE","schemaId":"schema_237"},{"name":"ReceiptColumns","in":"header","required":false,"example":40,"schemaId":"schema_238"},{"name":"Token","in":"header","example":"8048471746471119","schemaId":"schema_239"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/transactions/invoice","href":"transactions/getinvoice","openApiOperationId":"getinvoice","summary":"Invoice Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240"}},"schemaId":"schema_240"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1invoice/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_240","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_240"}}},{"code":"400","schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getinvoice"}],"panels":[]}]},"httpPath":"/transactions/invoice"},{"label":"Void","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/void","routeSlug":"/apis/payments-platform-rest/openapi/transactions/void","metadata":{"seo":{"title":"Void","description":"Used to void and reverse an invoice. This will attempt to reverse the transaction with the processor and will mark the transaction as voided in Shift4's Gateway."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"void","name":"Void","isWebhook":false,"pointer":"/paths/~1transactions~1invoice/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to void and reverse an invoice. This will attempt to reverse the transaction with the processor and will mark the transaction as voided in Shift4's Gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The DELETE request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Invoice","in":"header","schemaId":"schema_236","required":true},{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"ReceiptColumns","in":"header","schemaId":"schema_238","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send this field if you want Shift4 to format the receipt text instead of returning individual fields. The value sent will correlate to the column width of the formatted receipt that we return. (This also allows the receipt text to wrap to fit the paper size of the printed receipt.) See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/printing-receipts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Printing Receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more information on formatted receipts."},"children":[]}]}]}]},{"name":"ReversalReason","in":"header","schemaId":"schema_241","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the reason for the reversal."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeout"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS lost connection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant cancellation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer cancellation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV card removed prematurely"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV card declined issuer approval"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN PAD unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chip error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"09"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspected Fraud"},"children":[]}]}]}]}]}]}],"example":"01"},{"name":"Token","in":"header","schemaId":"schema_239","description":"This field is used to specify the token for the payment method."}],"pointer":"/paths/~1transactions~1invoice/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transactions/invoice","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Invoice","in":"header","required":true,"example":"0510093358","schemaId":"components/schemas/TransactionInvoice"},{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"ReceiptColumns","in":"header","required":false,"example":40,"schemaId":"schema_238"},{"name":"ReversalReason","in":"header","example":"01","schemaId":"schema_241"},{"name":"Token","in":"header","example":"8048471746471119","schemaId":"schema_239"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/transactions/invoice","href":"transactions/void","openApiOperationId":"void","summary":"Void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}},"schemaId":"schema_242"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1invoice/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_242","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}}},{"code":"400","schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/void"}],"panels":[]}]},"httpPath":"/transactions/invoice"},{"label":"Manual Authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/manualauthorization","routeSlug":"/apis/payments-platform-rest/openapi/transactions/manualauthorization","metadata":{"seo":{"title":"Manual Authorization","description":"This function is used to request authorization in an offline scenario, which means that Shift4 will not seek processor approval. An authorization code should be included in this request if the amount being submitted in the request is greater than the authorization amount currently on file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"manualauthorization","name":"Manual Authorization","isWebhook":false,"pointer":"/paths/~1transactions~1manualauthorization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Authorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request authorization in an offline scenario, which means that Shift4 will not seek processor approval. An authorization code should be included in this request if the amount being submitted in the request is greater than the authorization amount currently on file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1manualauthorization/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243","pointer":"/paths/~1transactions~1manualauthorization/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/manualauthorization","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_243"}},"responseCodes":["200","400","504"],"pointer":"/transactions/manualauthorization","href":"transactions/manualauthorization","openApiOperationId":"manualauthorization","summary":"Manual Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_243"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}},"schemaId":"schema_244"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1manualauthorization/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_244","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/manualauthorization"}],"panels":[]}]},"httpPath":"/transactions/manualauthorization"},{"label":"Manual Sale","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/manualsale","routeSlug":"/apis/payments-platform-rest/openapi/transactions/manualsale","metadata":{"seo":{"title":"Manual Sale","description":"This function is used to request authorization and a sale in an offline scenario, which means that Shift4 will not seek processor approval. An authorization code should be included in this request if the amount being submitted in the request is greater than the authorization amount currently on file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"manualsale","name":"Manual Sale","isWebhook":false,"pointer":"/paths/~1transactions~1manualsale/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Sale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request authorization and a sale in an offline scenario, which means that Shift4 will not seek processor approval. An authorization code should be included in this request if the amount being submitted in the request is greater than the authorization amount currently on file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Restaurant industry, review "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/restaurant-authorization-and-settlement-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restaurant Authorization and Settlement Flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1manualsale/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245","pointer":"/paths/~1transactions~1manualsale/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/manualsale","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245"}},"responseCodes":["200","400","504"],"pointer":"/transactions/manualsale","href":"transactions/manualsale","openApiOperationId":"manualsale","summary":"Manual Sale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}},"schemaId":"schema_244"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1manualsale/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_244","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/manualsale"}],"panels":[]}]},"httpPath":"/transactions/manualsale"},{"label":"Upload Signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/transactions/transactionssignature","routeSlug":"/apis/payments-platform-rest/openapi/transactions/transactionssignature","metadata":{"seo":{"title":"Upload Signature","description":"This function is used to upload the captured signature to an existing invoice in Shift4's Gateway."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactionssignature","name":"Upload Signature","isWebhook":false,"pointer":"/paths/~1transactions~1signature/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Signature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to upload the captured signature to an existing invoice in Shift4's Gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1signature/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_246"}},"schemaId":"schema_246","pointer":"/paths/~1transactions~1signature/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/signature","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_246"}},"responseCodes":["200","400","504"],"pointer":"/transactions/signature","href":"transactions/transactionssignature","openApiOperationId":"transactionssignature","summary":"Upload Signature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_246","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_246"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}},"schemaId":"schema_247"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1transactions~1signature/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_247","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}}},{"code":"400","schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1transactions~1signature/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionssignature"}],"panels":[]}]},"httpPath":"/transactions/signature"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions/authorization","summary":"Authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transactionsauthorization","deprecated":false},{"title":"/transactions/capture","summary":"Capture","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transactionscapture","deprecated":false},{"title":"/transactions/sale","summary":"Sale/Purchase","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transactionssale","deprecated":false},{"title":"/transactions/refund","summary":"Refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/refund","deprecated":false},{"title":"/transactions/invoice","summary":"Invoice Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/getinvoice","deprecated":false},{"title":"/transactions/invoice","summary":"Void","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transactions/void","deprecated":false},{"title":"/transactions/manualauthorization","summary":"Manual Authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/manualauthorization","deprecated":false},{"title":"/transactions/manualsale","summary":"Manual Sale","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/manualsale","deprecated":false},{"title":"/transactions/signature","summary":"Upload Signature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transactionssignature","deprecated":false}]}]}]}]}},{"type":"group","label":"Tokens","link":"/apis/payments-platform-rest/openapi/tokens","routeSlug":"/apis/payments-platform-rest/openapi/tokens","items":[{"label":"TokenStore Add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/tokens/tokensadd","routeSlug":"/apis/payments-platform-rest/openapi/tokens/tokensadd","metadata":{"seo":{"title":"TokenStore Add","description":"This function requests that CHD be added to the Global Token Vault and that a card token be returned for future use. This function cannot be used for EMV processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokensadd","name":"TokenStore Add","isWebhook":false,"pointer":"/paths/~1tokens~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TokenStore Add","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that CHD be added to the Global Token Vault and that a card token be returned for future use. This function cannot be used for EMV processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1add/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_250"}},"schemaId":"schema_250","pointer":"/paths/~1tokens~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/add","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_250"}},"responseCodes":["200","400","504"],"pointer":"/tokens/add","href":"tokens/tokensadd","openApiOperationId":"tokensadd","summary":"TokenStore Add"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_250","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_250"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_251"}},"schemaId":"schema_251"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1add/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1tokens~1add/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1tokens~1add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_251","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_251"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1tokens~1add/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1add/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokensadd"}],"panels":[]}]},"httpPath":"/tokens/add"},{"label":"TokenStore Duplicate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/tokens/tokensduplicate","routeSlug":"/apis/payments-platform-rest/openapi/tokens/tokensduplicate","metadata":{"seo":{"title":"TokenStore Duplicate","description":"This function requests that a new card token be generated using an existing card token. This request can be used to deposit a card token into a Global TokenStore or as a means to continue using a token that is about to expire. The card’s short-term data (if sent by the interface) will be stored until it is used or for the period configured in the merchant’s Lighthouse Transaction Manager account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokensduplicate","name":"TokenStore Duplicate","isWebhook":false,"pointer":"/paths/~1tokens~1duplicate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TokenStore Duplicate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a new card token be generated using an existing card token. This request can be used to deposit a card token into a Global TokenStore or as a means to continue using a token that is about to expire. The card’s short-term data (if sent by the interface) will be stored until it is used or for the period configured in the merchant’s "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ltm.shift4test.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lighthouse Transaction Manager"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This request only works for Legacy TrueToken style tokens. It will not work for Global Token Vault style tokens."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_252","exampleIds":["paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1tokens~1duplicate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/duplicate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/tokens/duplicate","href":"tokens/tokensduplicate","openApiOperationId":"tokensduplicate","summary":"TokenStore Duplicate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_252","exampleIds":["paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253","exampleIds":["paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_253","exampleIds":["paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1tokens~1duplicate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_253","exampleIds":["paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253","exampleIds":["paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokensduplicate"}],"panels":[]}]},"httpPath":"/tokens/duplicate"},{"label":"TokenStore Delete","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/tokens/tokensdelete","routeSlug":"/apis/payments-platform-rest/openapi/tokens/tokensdelete","metadata":{"seo":{"title":"TokenStore Delete","description":"This function requests that a token be deleted from the TrueToken vault. This process is irreversible. Once the token is deleted, there is no way to recover it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokensdelete","name":"TokenStore Delete","isWebhook":false,"pointer":"/paths/~1tokens~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TokenStore Delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a token be deleted from the TrueToken vault. This process is irreversible. Once the token is deleted, there is no way to recover it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This request only works for Legacy TrueToken style tokens. It will not work for Global Token Vault style tokens."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1tokens~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_254","exampleIds":["paths/~1tokens~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1tokens~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/delete","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1tokens~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/tokens/delete","href":"tokens/tokensdelete","openApiOperationId":"tokensdelete","summary":"TokenStore Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_254","exampleIds":["paths/~1tokens~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1tokens~1delete/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1tokens~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_255","exampleIds":["paths/~1tokens~1delete/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~1delete/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1tokens~1delete/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1delete/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1tokens~1delete/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1tokens~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_255","exampleIds":["paths/~1tokens~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1tokens~1delete/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1tokens~1delete/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~1delete/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1tokens~1delete/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1delete/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokensdelete"}],"panels":[]}]},"httpPath":"/tokens/delete"},{"label":"Universal Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/tokens/tokensuniversaltoken","routeSlug":"/apis/payments-platform-rest/openapi/tokens/tokensuniversaltoken","metadata":{"seo":{"title":"Universal Token","description":"This function requests that the existing universal token for a card be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokensuniversaltoken","name":"Universal Token","isWebhook":false,"pointer":"/paths/~1tokens~1universaltoken/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Universal Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that the existing universal token for a card be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The GET request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"CardNumber","in":"header","schemaId":"schema_256","description":"The payment card number. This field will always be masked when returned in a response.\n"},{"name":"P2PEData","in":"header","schemaId":"schema_257","description":"The full output of a P2PE keypad/magnetic swipe reader (MSR)."},{"name":"P2PEFormat","in":"header","schemaId":"schema_258","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format, USB KB mode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format, USB HID mode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ingenico format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VeriFone format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift4 TDES DUKPT format"},"children":[]}]}]}]}]}]}],"example":"01"},{"name":"P2PEKsn","in":"header","schemaId":"schema_259","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"p2pe.format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" == \"05\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key serial number which was used to encrypt the P2PE data."},"children":[]}]}]}],"example":"6299495001100E200041"},{"name":"SerialNumber","in":"header","schemaId":"schema_260","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In requests that require the use of a shared card token that is held by another merchant account, such as in TokenStore or TokenShare®, this field is used to specify the serial number for the account where the card token is stored."},"children":[]}]}]}]},{"name":"Token","in":"header","schemaId":"schema_239","description":"This field is used to specify the token for the payment method."},{"name":"TrackData","in":"header","schemaId":"schema_261","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the initial authorization/sale request when processing a swiped MSR transaction. This field is not specified when using True P2PE® (point-to-point encryption) or a UTG-controlled PIN pad."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card swipe data exactly as read by an MSR."},"children":[]}]}]}],"example":";4321000000001119=2212201999999?"}],"pointer":"/paths/~1tokens~1universaltoken/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens/universaltoken","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"CardNumber","in":"header","example":"4321000000001119","schemaId":"schema_256"},{"name":"P2PEData","in":"header","schemaId":"schema_257"},{"name":"P2PEFormat","in":"header","example":"01","schemaId":"schema_258"},{"name":"P2PEKsn","in":"header","example":"6299495001100E200041","schemaId":"schema_259"},{"name":"SerialNumber","in":"header","example":"266","schemaId":"schema_260"},{"name":"Token","in":"header","example":"8048471746471119","schemaId":"schema_239"},{"name":"TrackData","in":"header","example":";4321000000001119=2212201999999?","schemaId":"schema_261"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/tokens/universaltoken","href":"tokens/tokensuniversaltoken","openApiOperationId":"tokensuniversaltoken","summary":"Universal Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}},"schemaId":"schema_262"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1tokens~1universaltoken/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_262","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokensuniversaltoken"}],"panels":[]}]},"httpPath":"/tokens/universaltoken"},{"label":"Get Four Words","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/tokens/tokens4words","routeSlug":"/apis/payments-platform-rest/openapi/tokens/tokens4words","metadata":{"seo":{"title":"Get Four Words","description":"This function is used to generate a unique combination of four words that can be used to reference cardholder data (CHD)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokens4words","name":"Get Four Words","isWebhook":false,"pointer":"/paths/~1tokens~14words/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Four Words","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to generate a unique combination of four words that can be used to reference cardholder data (CHD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This functionality is supported with Legacy TrueTokens only. It is not supported with GTV tokens."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1tokens~14words/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1tokens~14words/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_263","exampleIds":["paths/~1tokens~14words/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1tokens~14words/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens/4words","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1tokens~14words/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/tokens/4words","href":"tokens/tokens4words","openApiOperationId":"tokens4words","summary":"Get Four Words"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_263","exampleIds":["paths/~1tokens~14words/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1tokens~14words/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}},"schemaId":"schema_264"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~14words/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1tokens~14words/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~14words/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1tokens~14words/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1tokens~14words/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_264","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1tokens~14words/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1tokens~14words/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1tokens~14words/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1tokens~14words/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/tokens4words"}],"panels":[]}]},"httpPath":"/tokens/4words"}],"content":{"contentType":"group","meta":{"name":"Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens/add","summary":"TokenStore Add","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokensadd","deprecated":false},{"title":"/tokens/duplicate","summary":"TokenStore Duplicate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokensduplicate","deprecated":false},{"title":"/tokens/delete","summary":"TokenStore Delete","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokensdelete","deprecated":false},{"title":"/tokens/universaltoken","summary":"Universal Token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tokens/tokensuniversaltoken","deprecated":false},{"title":"/tokens/4words","summary":"Get Four Words","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/tokens4words","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchants","link":"/apis/payments-platform-rest/openapi/merchants","routeSlug":"/apis/payments-platform-rest/openapi/merchants","items":[{"label":"Merchant Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/merchants/merchantsmerchant","routeSlug":"/apis/payments-platform-rest/openapi/merchants/merchantsmerchant","metadata":{"seo":{"title":"Merchant Information","description":"Used to request information about the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"merchantsmerchant","name":"Merchant Information","isWebhook":false,"pointer":"/paths/~1merchants~1merchant/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request information about the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The GET request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"ApiOptions","in":"header","schemaId":"schema_237","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options modify the request being made. Multiple API Options can be sent in a comma separated list with no spaces. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNPROCESSORS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the processor information and card ranges the merchant is configured for."},"children":[]}]}]}]}]}]}],"example":"RETURNPROCESSORS"}],"pointer":"/paths/~1merchants~1merchant/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchants/merchant","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"ApiOptions","in":"header","required":false,"example":"RETURNPROCESSORS","schemaId":"schema_237"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/merchants/merchant","href":"merchants/merchantsmerchant","openApiOperationId":"merchantsmerchant","summary":"Merchant Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1merchants~1merchant/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1merchants~1merchant/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1merchants~1merchant/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1merchants~1merchant/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1merchants~1merchant/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/merchantsmerchant"}],"panels":[]}]},"httpPath":"/merchants/merchant"}],"content":{"contentType":"group","meta":{"name":"Merchants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchants","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/merchants/merchant","summary":"Merchant Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchants/merchantsmerchant","deprecated":false}]}]}]}]}},{"type":"group","label":"Gift Cards","link":"/apis/payments-platform-rest/openapi/gift-cards","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards","items":[{"label":"Activate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/activate","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/activate","metadata":{"seo":{"title":"Activate","description":"This function requests that a new gift card be activated for use or that a new gift card be loaded with funds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activate","name":"Activate","isWebhook":false,"pointer":"/paths/~1giftcards~1activate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a new gift card be activated for use or that a new gift card be loaded with funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1activate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_271"}},"schemaId":"schema_271","pointer":"/paths/~1giftcards~1activate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/activate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_271"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/activate","href":"gift-cards/activate","openApiOperationId":"activate","summary":"Activate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_271","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_271"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1giftcards~1activate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_272","exampleIds":["paths/~1giftcards~1activate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1activate/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1activate/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_272","exampleIds":["paths/~1giftcards~1activate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1giftcards~1activate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1activate/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1activate/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/activate"}],"panels":[]}]},"httpPath":"/giftcards/activate"},{"label":"Allocate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/allocate","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/allocate","metadata":{"seo":{"title":"Allocate","description":"This function requests that a new gift card be allocated for use under a specific Program ID. The new card will be generated during the request and activated with the requested amount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allocate","name":"Allocate","isWebhook":false,"pointer":"/paths/~1giftcards~1allocate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a new gift card be allocated for use under a specific Program ID. The new card will be generated during the request and activated with the requested amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1allocate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_273","exampleIds":["paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1giftcards~1allocate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/allocate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/giftcards/allocate","href":"gift-cards/allocate","openApiOperationId":"allocate","summary":"Allocate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_273","exampleIds":["paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_274","exampleIds":["paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1allocate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_274","exampleIds":["paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/allocate"}],"panels":[]}]},"httpPath":"/giftcards/allocate"},{"label":"Deactivate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/deactivate","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/deactivate","metadata":{"seo":{"title":"Deactivate","description":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  A balance will remain on the gift card (if supported by the processor).  If you want to return the card's current balance back to the customer, use the Cashout endpoint instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivate","name":"Deactivate","isWebhook":false,"pointer":"/paths/~1giftcards~1deactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  A balance will remain on the gift card (if supported by the processor).  If you want to return the card's current balance back to the customer, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/cashout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1deactivate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275","pointer":"/paths/~1giftcards~1deactivate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/deactivate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_275"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/deactivate","href":"gift-cards/deactivate","openApiOperationId":"deactivate","summary":"Deactivate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_275"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276","exampleIds":["paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_276","exampleIds":["paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_276","exampleIds":["paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276","exampleIds":["paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/deactivate"}],"panels":[]}]},"httpPath":"/giftcards/deactivate"},{"label":"Cashback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/cashback","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/cashback","metadata":{"seo":{"title":"Cashback","description":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cashback","name":"Cashback","isWebhook":false,"pointer":"/paths/~1giftcards~1cashback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint replaces the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/cashout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card Cashout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1cashback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277","pointer":"/paths/~1giftcards~1cashback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/cashback","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_277"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/cashback","href":"gift-cards/cashback","openApiOperationId":"cashback","summary":"Cashback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1cashback/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/cashback"}],"panels":[]}]},"httpPath":"/giftcards/cashback"},{"label":"Reactivate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/reactivate","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/reactivate","metadata":{"seo":{"title":"Reactivate","description":"This function requests that a previously deactivated gift card be reactivated. If there was a balance remaining on the gift card at the time of deactivation, the balance will again become available for use. Funds cannot be added to a gift card during a Reactivate request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reactivate","name":"Reactivate","isWebhook":false,"pointer":"/paths/~1giftcards~1reactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a previously deactivated gift card be reactivated. If there was a balance remaining on the gift card at the time of deactivation, the balance will again become available for use. Funds cannot be added to a gift card during a Reactivate request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1reactivate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279","pointer":"/paths/~1giftcards~1reactivate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/reactivate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_279"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/reactivate","href":"gift-cards/reactivate","openApiOperationId":"reactivate","summary":"Reactivate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_279"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_280","exampleIds":["paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1reactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_280","exampleIds":["paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/reactivate"}],"panels":[]}]},"httpPath":"/giftcards/reactivate"},{"label":"Reload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/reload","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/reload","metadata":{"seo":{"title":"Reload","description":"This function requests that an active gift card be loaded with additional funds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reload","name":"Reload","isWebhook":false,"pointer":"/paths/~1giftcards~1reload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that an active gift card be loaded with additional funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1reload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281","pointer":"/paths/~1giftcards~1reload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/reload","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_281"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/reload","href":"gift-cards/reload","openApiOperationId":"reload","summary":"Reload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1giftcards~1reload/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_282","exampleIds":["paths/~1giftcards~1reload/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reload/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reload/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reload/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reload/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1reload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_282","exampleIds":["paths/~1giftcards~1reload/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1giftcards~1reload/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reload/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1reload/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reload/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1reload/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/reload"}],"panels":[]}]},"httpPath":"/giftcards/reload"},{"label":"Balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/balance","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/balance","metadata":{"seo":{"title":"Balance","description":"This function requests that a gift card's balance, masked card number, expiration date, and discount percentage be returned. Merchants may be required to pay a fee for an inquiry request depending on their processor agreement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balance","name":"Balance","isWebhook":false,"pointer":"/paths/~1giftcards~1balance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that a gift card's balance, masked card number, expiration date, and discount percentage be returned. Merchants may be required to pay a fee for an inquiry request depending on their processor agreement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1balance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283","pointer":"/paths/~1giftcards~1balance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/balance","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_283"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/balance","href":"gift-cards/balance","openApiOperationId":"balance","summary":"Balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active","paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive"]}},"schemaId":"schema_284","exampleIds":["paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active","paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1balance/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1balance/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1balance/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1balance/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","exampleIds":["paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active","paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active","paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1balance/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1balance/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1balance/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1balance/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/balance"}],"panels":[]}]},"httpPath":"/giftcards/balance"},{"label":"Cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/cancel","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/cancel","metadata":{"seo":{"title":"Cancel","description":"This function attempts to undo the last /giftcards/* request that was made against a gift card or private label card. For example, an Activate or Reload request may eligible for cancellation.  Some processors do not support this functionality.  This endpoint cannot be used to cancel a sale or authorization against a gift card - the Void request should be used for that scenario."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel","name":"Cancel","isWebhook":false,"pointer":"/paths/~1giftcards~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function attempts to undo the last /giftcards/* request that was made against a gift card or private label card. For example, an Activate or Reload request may eligible for cancellation.  Some processors do not support this functionality.  This endpoint cannot be used to cancel a sale or authorization against a gift card - the Void request should be used for that scenario."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"schemaId":"schema_285","pointer":"/paths/~1giftcards~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/cancel","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_285"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/cancel","href":"gift-cards/cancel","openApiOperationId":"cancel","summary":"Cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_285","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286"}},"schemaId":"schema_286"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_286","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/cancel"}],"panels":[]}]},"httpPath":"/giftcards/cancel"},{"label":"Cashout","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/gift-cards/cashout","routeSlug":"/apis/payments-platform-rest/openapi/gift-cards/cashout","metadata":{"seo":{"title":"Cashout","description":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cashout","name":"Cashout","deprecated":true,"isWebhook":false,"pointer":"/paths/~1giftcards~1cashout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashout","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has been deprecated and should no longer be used. It has been replaced by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/cashback"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card Cashback"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1giftcards~1cashout/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277","pointer":"/paths/~1giftcards~1cashout/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcards/cashout","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_277"}},"responseCodes":["200","400","504"],"pointer":"/giftcards/cashout","href":"gift-cards/cashout","openApiOperationId":"cashout","summary":"Cashout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_277"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1giftcards~1cashout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-cards/cashout"}],"panels":[]}]},"httpPath":"/giftcards/cashout"}],"content":{"contentType":"group","meta":{"name":"Gift Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gift Cards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/giftcards/activate","summary":"Activate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/activate","deprecated":false},{"title":"/giftcards/allocate","summary":"Allocate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/allocate","deprecated":false},{"title":"/giftcards/deactivate","summary":"Deactivate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/deactivate","deprecated":false},{"title":"/giftcards/cashback","summary":"Cashback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/cashback","deprecated":false},{"title":"/giftcards/reactivate","summary":"Reactivate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/reactivate","deprecated":false},{"title":"/giftcards/reload","summary":"Reload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/reload","deprecated":false},{"title":"/giftcards/balance","summary":"Balance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/balance","deprecated":false},{"title":"/giftcards/cancel","summary":"Cancel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-cards/cancel","deprecated":false},{"title":"/giftcards/cashout","summary":"Cashout","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/gift-cards/cashout","deprecated":true}]}]}]}]}},{"type":"group","label":"Cards","link":"/apis/payments-platform-rest/openapi/cards","routeSlug":"/apis/payments-platform-rest/openapi/cards","items":[{"label":"Verify Card with Processor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/cards/cardsverify","routeSlug":"/apis/payments-platform-rest/openapi/cards/cardsverify","metadata":{"seo":{"title":"Verify Card with Processor","description":"This function is used to request card validation by going online to verify the card information with the processor. If Address Verification System (AVS) and/or Card Security Code (CSC) data are sent in the request, that information will also be validated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardsverify","name":"Verify Card with Processor","isWebhook":false,"pointer":"/paths/~1cards~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Card with Processor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request card validation by going online to verify the card information with the processor. If Address Verification System (AVS) and/or Card Security Code (CSC) data are sent in the request, that information will also be validated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To process an Account Name Inquiry request the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USEANI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API Option and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent in the request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.middleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional. Account Name Inquiry requests are currently limited to Visa cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1cards~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287","pointer":"/paths/~1cards~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cards/verify","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_287"}},"responseCodes":["200","400","504"],"pointer":"/cards/verify","href":"cards/cardsverify","openApiOperationId":"cardsverify","summary":"Verify Card with Processor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1"}],"schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}},"schemaId":"schema_288"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1cards~1verify/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1cards~1verify/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1cards~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_288","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1cards~1verify/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1cards~1verify/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/cardsverify"}],"panels":[]}]},"httpPath":"/cards/verify"},{"label":"Identify Card Type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/cards/cardsidentify","routeSlug":"/apis/payments-platform-rest/openapi/cards/cardsidentify","metadata":{"seo":{"title":"Identify Card Type","description":"This function is used to request and return the card type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardsidentify","name":"Identify Card Type","isWebhook":false,"pointer":"/paths/~1cards~1identify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identify Card Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request and return the card type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1cards~1identify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"schemaId":"schema_289","pointer":"/paths/~1cards~1identify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cards/identify","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_289"}},"responseCodes":["200","400","504"],"pointer":"/cards/identify","href":"cards/cardsidentify","openApiOperationId":"cardsidentify","summary":"Identify Card Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1"}],"schemaId":"schema_289","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1cards~1identify/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1cards~1identify/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1cards~1identify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1cards~1identify/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1cards~1identify/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/cardsidentify"}],"panels":[]}]},"httpPath":"/cards/identify"}],"content":{"contentType":"group","meta":{"name":"Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cards/verify","summary":"Verify Card with Processor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cards/cardsverify","deprecated":false},{"title":"/cards/identify","summary":"Identify Card Type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cards/cardsidentify","deprecated":false}]}]}]}]}},{"type":"group","label":"Devices","link":"/apis/payments-platform-rest/openapi/devices","routeSlug":"/apis/payments-platform-rest/openapi/devices","items":[{"label":"Request Signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicessignatures","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicessignatures","metadata":{"seo":{"title":"Request Signature","description":"This function is used to request a prompt for signature on a UTG or Commerce Engine controlled PIN pad and returns the signature."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicessignatures","name":"Request Signature","isWebhook":false,"pointer":"/paths/~1devices~1promptsignature/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Signature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request a prompt for signature on a UTG or Commerce Engine controlled PIN pad and returns the signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1promptsignature/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291","pointer":"/paths/~1devices~1promptsignature/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/promptsignature","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_291"}},"responseCodes":["200","400","504"],"pointer":"/devices/promptsignature","href":"devices/devicessignatures","openApiOperationId":"devicessignatures","summary":"Request Signature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}},"schemaId":"schema_292"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1promptsignature/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_292","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicessignatures"}],"panels":[]}]},"httpPath":"/devices/promptsignature"},{"label":"Prompt Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicespromptconfirmation","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicespromptconfirmation","metadata":{"seo":{"title":"Prompt Confirmation","description":"This function is used to display text for a consumer’s confirmation on a UTG-controlled PIN pad."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicespromptconfirmation","name":"Prompt Confirmation","isWebhook":false,"pointer":"/paths/~1devices~1promptconfirmation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prompt Confirmation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to display text for a consumer’s confirmation on a UTG-controlled PIN pad."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1promptconfirmation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293"}},"schemaId":"schema_293","pointer":"/paths/~1devices~1promptconfirmation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/promptconfirmation","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_293"}},"responseCodes":["200","400","504"],"pointer":"/devices/promptconfirmation","href":"devices/devicespromptconfirmation","openApiOperationId":"devicespromptconfirmation","summary":"Prompt Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_293","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294"}},"schemaId":"schema_294"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1promptconfirmation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_294","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicespromptconfirmation"}],"panels":[]}]},"httpPath":"/devices/promptconfirmation"},{"label":"Prompt Terms and Conditions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicestermsandconditions","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicestermsandconditions","metadata":{"seo":{"title":"Prompt Terms and Conditions","description":"This function is used to display terms and conditions for a consumer to accept or decline on a Commerce Engine or UTG-controlled PIN pad."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicestermsandconditions","name":"Prompt Terms and Conditions","isWebhook":false,"pointer":"/paths/~1devices~1termsandconditions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prompt Terms and Conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to display terms and conditions for a consumer to accept or decline on a Commerce Engine or UTG-controlled PIN pad."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1termsandconditions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295","pointer":"/paths/~1devices~1termsandconditions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/termsandconditions","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_295"}},"responseCodes":["200","400","504"],"pointer":"/devices/termsandconditions","href":"devices/devicestermsandconditions","openApiOperationId":"devicestermsandconditions","summary":"Prompt Terms and Conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1termsandconditions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicestermsandconditions"}],"panels":[]}]},"httpPath":"/devices/termsandconditions"},{"label":"Display Line Items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/deviceslineitems","routeSlug":"/apis/payments-platform-rest/openapi/devices/deviceslineitems","metadata":{"seo":{"title":"Display Line Items","description":"This function is used to display up to 10 line items on a UTG-controlled PIN pad. In additional Display Line Items requests, if the API Option APPENDLINEITEM is sent, the UTG will append the new line item(s) to the existing line item(s) displayed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deviceslineitems","name":"Display Line Items","isWebhook":false,"pointer":"/paths/~1devices~1lineitems/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Display Line Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to display up to 10 line items on a UTG-controlled PIN pad. In additional Display Line Items requests, if the API Option APPENDLINEITEM is sent, the UTG will append the new line item(s) to the existing line item(s) displayed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1lineitems/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_297","exampleIds":["paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1devices~1lineitems/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/lineitems","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/devices/lineitems","href":"devices/deviceslineitems","openApiOperationId":"deviceslineitems","summary":"Display Line Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_297","exampleIds":["paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1lineitems/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/deviceslineitems"}],"panels":[]}]},"httpPath":"/devices/lineitems"},{"label":"Clear Line Items","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesdeletelineitems","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesdeletelineitems","metadata":{"seo":{"title":"Clear Line Items","description":"This function is used to clear the line items displayed on a UTG-controlled PIN pad."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesdeletelineitems","name":"Clear Line Items","isWebhook":false,"pointer":"/paths/~1devices~1lineitems/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear Line Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to clear the line items displayed on a UTG-controlled PIN pad."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The DELETE request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TerminalId","in":"header","schemaId":"schema_299","description":"The API Terminal ID configured in UTG TuneUp must be specified in this field.\n","required":true},{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1lineitems/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/devices/lineitems","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TerminalId","in":"header","required":true,"example":"1742","schemaId":"schema_299"},{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/devices/lineitems","href":"devices/devicesdeletelineitems","openApiOperationId":"devicesdeletelineitems","summary":"Clear Line Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1lineitems/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesdeletelineitems"}],"panels":[]}]},"httpPath":"/devices/lineitems"},{"label":"Device Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesinfo","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesinfo","metadata":{"seo":{"title":"Device Information","description":"This function is used to request information regarding the status of a specific Commerce Engine or UTG-controlled PIN pad. Depending on the type of device in use, this request may return a variety of device information in the response, including the types of encryption keys injected on the device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesinfo","name":"Device Information","isWebhook":false,"pointer":"/paths/~1devices~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request information regarding the status of a specific Commerce Engine or UTG-controlled PIN pad. Depending on the type of device in use, this request may return a variety of device information in the response, including the types of encryption keys injected on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The GET request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TerminalId","in":"header","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required for UTG, optional for Commerce Engine."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API Terminal ID assigned to the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For UTG it is configured in TuneUp and must be included in the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Commerce Engine it is defined in the Terminal Management System (TMS) and is optional. If sent, it must match the value defined in the TMS."},"children":[]}]}]}]},{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/devices/info","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TerminalId","in":"header","example":"1742","schemaId":"schema_299"},{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/devices/info","href":"devices/devicesinfo","openApiOperationId":"devicesinfo","summary":"Device Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_300"}},"schemaId":"schema_300"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1info/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1info/get/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1info/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1info/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_300","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_300"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1info/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1info/get/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1info/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1info/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesinfo"}],"panels":[]}]},"httpPath":"/devices/info"},{"label":"Initialize Readers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesinitializereaders","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesinitializereaders","metadata":{"seo":{"title":"Initialize Readers","description":"This function is used to request a card swipe, insert, tap (if applicable), etc. on a UTG-controlled PIN pad before an Authorization or Sale/Purchase request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesinitializereaders","name":"Initialize Readers","isWebhook":false,"pointer":"/paths/~1devices~1initializereaders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize Readers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request a card swipe, insert, tap (if applicable), etc. on a UTG-controlled PIN pad before an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionsauthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionssale"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale/Purchase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1initializereaders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_301"}},"schemaId":"schema_301","pointer":"/paths/~1devices~1initializereaders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/initializereaders","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_301"}},"responseCodes":["200","400","504"],"pointer":"/devices/initializereaders","href":"devices/devicesinitializereaders","openApiOperationId":"devicesinitializereaders","summary":"Initialize Readers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_301","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_301"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1initializereaders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesinitializereaders"}],"panels":[]}]},"httpPath":"/devices/initializereaders"},{"label":"Reset Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesreset","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesreset","metadata":{"seo":{"title":"Reset Device","description":"This function is used to reset a Commerce Engine or UTG-controlled PIN pad to idle. When there is pending consumer input (e.g., waiting for the consumer to confirm the amount, swipe their card, select credit or debit, etc.), sending this request will cancel the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesreset","name":"Reset Device","isWebhook":false,"pointer":"/paths/~1devices~1reset/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Device","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to reset a Commerce Engine or UTG-controlled PIN pad to idle. When there is pending consumer input (e.g., waiting for the consumer to confirm the amount, swipe their card, select credit or debit, etc.), sending this request will cancel the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1reset/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302","pointer":"/paths/~1devices~1reset/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/reset","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_302"}},"responseCodes":["200","400","504"],"pointer":"/devices/reset","href":"devices/devicesreset","openApiOperationId":"devicesreset","summary":"Reset Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1reset/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1reset/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1reset/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1reset/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1reset/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1reset/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1reset/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1reset/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1reset/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesreset"}],"panels":[]}]},"httpPath":"/devices/reset"},{"label":"Prompt Card Read","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicespromptcardread","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicespromptcardread","metadata":{"seo":{"title":"Prompt Card Read","description":"This function is used to prompt a P2PE-enabled, Commerce Engine or UTG controlled PIN pad to request a pass-through card swipe, causing the output of the swipe to be returned directly to the interface without any action or validation by Shift4 or the processor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicespromptcardread","name":"Prompt Card Read","isWebhook":false,"pointer":"/paths/~1devices~1promptcardread/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prompt Card Read","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to prompt a P2PE-enabled, Commerce Engine or UTG controlled PIN pad to request a pass-through card swipe, causing the output of the swipe to be returned directly to the interface without any action or validation by Shift4 or the processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1promptcardread/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"schemaId":"schema_303","pointer":"/paths/~1devices~1promptcardread/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/promptcardread","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_303"}},"responseCodes":["200","400","504"],"pointer":"/devices/promptcardread","href":"devices/devicespromptcardread","openApiOperationId":"devicespromptcardread","summary":"Prompt Card Read"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304","exampleIds":["paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard"]}},"schemaId":"schema_304","exampleIds":["paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1promptcardread/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_304","exampleIds":["paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304","exampleIds":["paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard","paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicespromptcardread"}],"panels":[]}]},"httpPath":"/devices/promptcardread"},{"label":"Prompt for Input","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicespromptinput","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicespromptinput","metadata":{"seo":{"title":"Prompt for Input","description":"This function is used to prompt a Commerce Engine or UTG-controlled PIN pad to collect a specified value from a consumer. The interface will specify the value based on the device.promptInput.index field. Each request will collect one specified value; when multiple values need to be collected, separate requests must be sent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicespromptinput","name":"Prompt for Input","isWebhook":false,"pointer":"/paths/~1devices~1promptinput/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prompt for Input","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to prompt a Commerce Engine or UTG-controlled PIN pad to collect a specified value from a consumer. The interface will specify the value based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device.promptInput.index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Each request will collect one specified value; when multiple values need to be collected, separate requests must be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1promptinput/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305","pointer":"/paths/~1devices~1promptinput/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/promptinput","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_305"}},"responseCodes":["200","400","504"],"pointer":"/devices/promptinput","href":"devices/devicespromptinput","openApiOperationId":"devicespromptinput","summary":"Prompt for Input"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptinput/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptinput/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptinput/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptinput/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1promptinput/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1promptinput/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1promptinput/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1promptinput/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1promptinput/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicespromptinput"}],"panels":[]}]},"httpPath":"/devices/promptinput"},{"label":"Display Custom Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesprocessform","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesprocessform","metadata":{"seo":{"title":"Display Custom Form","description":"This function is used to display a custom form and text for a consumer’s input on a Commerce Engine or UTG controlled PIN pad."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesprocessform","name":"Display Custom Form","isWebhook":false,"pointer":"/paths/~1devices~1processform/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Display Custom Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to display a custom form and text for a consumer’s input on a Commerce Engine or UTG controlled PIN pad."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1processform/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307","pointer":"/paths/~1devices~1processform/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/processform","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_307"}},"responseCodes":["200","400","504"],"pointer":"/devices/processform","href":"devices/devicesprocessform","openApiOperationId":"devicesprocessform","summary":"Display Custom Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}},"schemaId":"schema_308"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1processform/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1processform/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1processform/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1processform/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1processform/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1processform/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1processform/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1processform/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1processform/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesprocessform"}],"panels":[]}]},"httpPath":"/devices/processform"},{"label":"Print Receipts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesprint","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesprint","metadata":{"seo":{"title":"Print Receipts","description":"This function is used to print a receipt using a device’s built-in printer. The receipt may include a scannable bar code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesprint","name":"Print Receipts","isWebhook":false,"pointer":"/paths/~1devices~1print/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Print Receipts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to print a receipt using a device’s built-in printer. The receipt may include a scannable bar code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine for On Premise and Commerce Engine For Cloud support both the legacy printing format for backwards compability with UTG integrations as well as a new structured printing format. With the new structured printing format you can format an entire receipt as a bmp image including text, QR codes, and images. In future Commerce Engine releases we will be enhancing the structured format to support handling text and bar codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1print/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309","pointer":"/paths/~1devices~1print/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/print","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_309"}},"responseCodes":["200","400","504"],"pointer":"/devices/print","href":"devices/devicesprint","openApiOperationId":"devicesprint","summary":"Print Receipts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1print/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1print/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1print/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1print/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1print/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1print/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1print/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1print/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1print/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesprint"}],"panels":[]}]},"httpPath":"/devices/print"},{"label":"Get Device Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesgetstatus","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesgetstatus","metadata":{"seo":{"title":"Get Device Status","description":"This function is used to get the status of the device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesgetstatus","name":"Get Device Status","isWebhook":false,"pointer":"/paths/~1devices~1getstatus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Device Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to get the status of the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1getstatus/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311","pointer":"/paths/~1devices~1getstatus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/getstatus","servers":[{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_311"}},"responseCodes":["200","400","504"],"pointer":"/devices/getstatus","href":"devices/devicesgetstatus","openApiOperationId":"devicesgetstatus","summary":"Get Device Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_312"}},"schemaId":"schema_312"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1getstatus/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1getstatus/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1getstatus/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1getstatus/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1getstatus/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_312","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_312"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1getstatus/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1getstatus/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1getstatus/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1getstatus/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesgetstatus"}],"panels":[]}]},"httpPath":"/devices/getstatus"},{"label":"Prompt Tip","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/devices/devicesprompttip","routeSlug":"/apis/payments-platform-rest/openapi/devices/devicesprompttip","metadata":{"seo":{"title":"Prompt Tip","description":"This function is used to prompt for tip outside of a payment transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"devicesprompttip","name":"Prompt Tip","isWebhook":false,"pointer":"/paths/~1devices~1prompttip/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prompt Tip","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to prompt for tip outside of a payment transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For Cloud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1devices~1prompttip/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313"}},"schemaId":"schema_313","pointer":"/paths/~1devices~1prompttip/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/devices/prompttip","servers":[{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_313"}},"responseCodes":["200","400","504"],"pointer":"/devices/prompttip","href":"devices/devicesprompttip","openApiOperationId":"devicesprompttip","summary":"Prompt Tip"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"},{"url":"https://api.shift4test.com/api/rest/v1","description":"Commerce Engine For Cloud Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Commerce Engine For Cloud Production URL"}],"schemaId":"schema_313","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1prompttip/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1devices~1prompttip/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1prompttip/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1devices~1prompttip/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1devices~1prompttip/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1devices~1prompttip/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1devices~1prompttip/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1devices~1prompttip/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1devices~1prompttip/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/devicesprompttip"}],"panels":[]}]},"httpPath":"/devices/prompttip"}],"content":{"contentType":"group","meta":{"name":"Devices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Devices","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/devices/promptsignature","summary":"Request Signature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicessignatures","deprecated":false},{"title":"/devices/promptconfirmation","summary":"Prompt Confirmation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicespromptconfirmation","deprecated":false},{"title":"/devices/termsandconditions","summary":"Prompt Terms and Conditions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicestermsandconditions","deprecated":false},{"title":"/devices/lineitems","summary":"Display Line Items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/deviceslineitems","deprecated":false},{"title":"/devices/lineitems","summary":"Clear Line Items","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/devices/devicesdeletelineitems","deprecated":false},{"title":"/devices/info","summary":"Device Information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/devicesinfo","deprecated":false},{"title":"/devices/initializereaders","summary":"Initialize Readers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesinitializereaders","deprecated":false},{"title":"/devices/reset","summary":"Reset Device","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesreset","deprecated":false},{"title":"/devices/promptcardread","summary":"Prompt Card Read","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicespromptcardread","deprecated":false},{"title":"/devices/promptinput","summary":"Prompt for Input","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicespromptinput","deprecated":false},{"title":"/devices/processform","summary":"Display Custom Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesprocessform","deprecated":false},{"title":"/devices/print","summary":"Print Receipts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesprint","deprecated":false},{"title":"/devices/getstatus","summary":"Get Device Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesgetstatus","deprecated":false},{"title":"/devices/prompttip","summary":"Prompt Tip","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/devicesprompttip","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/apis/payments-platform-rest/openapi/reports","routeSlug":"/apis/payments-platform-rest/openapi/reports","items":[{"label":"Totals Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/reports/reportsbatchtotals","routeSlug":"/apis/payments-platform-rest/openapi/reports/reportsbatchtotals","metadata":{"seo":{"title":"Totals Report","description":"This function is used to request a simple totals report for automated analysis. It does not supersede the standard auditing and reporting tools that are included with Shift4’ products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportsbatchtotals","name":"Totals Report","isWebhook":false,"pointer":"/paths/~1reports~1batchtotals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Totals Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request a simple totals report for automated analysis. It does not supersede the standard auditing and reporting tools that are included with Shift4’ products."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The GET request does not support a request body. Sending an empty request body may result in an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"BusinessDate","in":"header","schemaId":"schema_329","description":"The business date you want to obtain the totals report for.","required":true,"example":"2021-04-15T09:18:23.283-07:00"},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Inclusive","in":"header","schemaId":"schema_330","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not you want the batch to include transactions for every day leading up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BusinessDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this parameter is not sent, the assumed value will be 'Y'."},"children":[]}]}]}]}],"pointer":"/paths/~1reports~1batchtotals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/batchtotals","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"BusinessDate","in":"header","required":true,"example":"2021-04-15T09:18:23.283-07:00","schemaId":"schema_329"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"Inclusive","in":"header","required":false,"schemaId":"schema_330"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/reports/batchtotals","href":"reports/reportsbatchtotals","openApiOperationId":"reportsbatchtotals","summary":"Totals Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1reports~1batchtotals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/reportsbatchtotals"}],"panels":[]}]},"httpPath":"/reports/batchtotals"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/batchtotals","summary":"Totals Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/reportsbatchtotals","deprecated":false}]}]}]}]}},{"type":"group","label":"Batches","link":"/apis/payments-platform-rest/openapi/batches","routeSlug":"/apis/payments-platform-rest/openapi/batches","items":[{"label":"Submit Batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/batches/batchessubmit","routeSlug":"/apis/payments-platform-rest/openapi/batches/batchessubmit","metadata":{"seo":{"title":"Submit Batch","description":"This function is used to close a batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchessubmit","name":"Submit Batch","isWebhook":false,"pointer":"/paths/~1batches~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to close a batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1batches~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1batches~1submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batches/submit","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","504"],"pointer":"/batches/submit","href":"batches/batchessubmit","openApiOperationId":"batchessubmit","summary":"Submit Batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1batches~1submit/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1batches~1submit/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1batches~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1batches~1submit/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1batches~1submit/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/batchessubmit"}],"panels":[]}]},"httpPath":"/batches/submit"}],"content":{"contentType":"group","meta":{"name":"Batches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batches","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batches/submit","summary":"Submit Batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batches/batchessubmit","deprecated":false}]}]}]}]}},{"type":"group","label":"QR Payments","link":"/apis/payments-platform-rest/openapi/qr-payments","routeSlug":"/apis/payments-platform-rest/openapi/qr-payments","items":[{"label":"Get QR Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/qr-payments/getqrcode","routeSlug":"/apis/payments-platform-rest/openapi/qr-payments/getqrcode","metadata":{"seo":{"title":"Get QR Code","description":"This endpoint is used to obtain a transaction based QR code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getqrcode","name":"Get QR Code","isWebhook":false,"pointer":"/paths/~1qrpayments~1getqrcode/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get QR Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to obtain a transaction based QR code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1qrpayments~1getqrcode/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337","pointer":"/paths/~1qrpayments~1getqrcode/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/qrpayments/getqrcode","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_337"}},"responseCodes":["200","400","504"],"pointer":"/qrpayments/getqrcode","href":"qr-payments/getqrcode","openApiOperationId":"getqrcode","summary":"Get QR Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1qrpayments~1getqrcode/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qr-payments/getqrcode"}],"panels":[]}]},"httpPath":"/qrpayments/getqrcode"},{"label":"Get QR Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/qr-payments/getqrdetails","routeSlug":"/apis/payments-platform-rest/openapi/qr-payments/getqrdetails","metadata":{"seo":{"title":"Get QR Details","description":"This endpoint is used to get detailed information for a transaction based QR code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getqrdetails","name":"Get QR Details","isWebhook":false,"pointer":"/paths/~1qrpayments~1getqrdetails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get QR Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to get detailed information for a transaction based QR code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1qrpayments~1getqrdetails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339","pointer":"/paths/~1qrpayments~1getqrdetails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/qrpayments/getqrdetails","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_339"}},"responseCodes":["200","400","504"],"pointer":"/qrpayments/getqrdetails","href":"qr-payments/getqrdetails","openApiOperationId":"getqrdetails","summary":"Get QR Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1qrpayments~1getqrdetails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qr-payments/getqrdetails"}],"panels":[]}]},"httpPath":"/qrpayments/getqrdetails"},{"label":"Get QR Payment Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/qr-payments/getqrpaymentstatus","routeSlug":"/apis/payments-platform-rest/openapi/qr-payments/getqrpaymentstatus","metadata":{"seo":{"title":"Get QR Payment Status","description":"This endpoint is used to poll for the status of the QR code payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getqrpaymentstatus","name":"Get QR Payment Status","isWebhook":false,"pointer":"/paths/~1qrpayments~1getqrpaymentstatus/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get QR Payment Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to poll for the status of the QR code payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1qrpayments~1getqrpaymentstatus/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339","pointer":"/paths/~1qrpayments~1getqrpaymentstatus/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/qrpayments/getqrpaymentstatus","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_339"}},"responseCodes":["200","400","504"],"pointer":"/qrpayments/getqrpaymentstatus","href":"qr-payments/getqrpaymentstatus","openApiOperationId":"getqrpaymentstatus","summary":"Get QR Payment Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS"]}},"schemaId":"schema_341","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1qrpayments~1getqrpaymentstatus/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_341","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qr-payments/getqrpaymentstatus"}],"panels":[]}]},"httpPath":"/qrpayments/getqrpaymentstatus"},{"label":"Cancel QR Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/qr-payments/cancelqrpayment","routeSlug":"/apis/payments-platform-rest/openapi/qr-payments/cancelqrpayment","metadata":{"seo":{"title":"Cancel QR Payment","description":"This endpoint is used to cancel a QR code payment. If the payment was already processed the transaction will be reversed. If the payment has not yet processed it will prevent the QR code from being used to process a payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelqrpayment","name":"Cancel QR Payment","isWebhook":false,"pointer":"/paths/~1qrpayments~1cancelqrpayment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel QR Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to cancel a QR code payment. If the payment was already processed the transaction will be reversed. If the payment has not yet processed it will prevent the QR code from being used to process a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1qrpayments~1cancelqrpayment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339","pointer":"/paths/~1qrpayments~1cancelqrpayment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/qrpayments/cancelqrpayment","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_339"}},"responseCodes":["200","400","504"],"pointer":"/qrpayments/cancelqrpayment","href":"qr-payments/cancelqrpayment","openApiOperationId":"cancelqrpayment","summary":"Cancel QR Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"},{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"}],"schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1qrpayments~1cancelqrpayment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qr-payments/cancelqrpayment"}],"panels":[]}]},"httpPath":"/qrpayments/cancelqrpayment"}],"content":{"contentType":"group","meta":{"name":"QR Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"QR Payments","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/qrpayments/getqrcode","summary":"Get QR Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qr-payments/getqrcode","deprecated":false},{"title":"/qrpayments/getqrdetails","summary":"Get QR Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qr-payments/getqrdetails","deprecated":false},{"title":"/qrpayments/getqrpaymentstatus","summary":"Get QR Payment Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qr-payments/getqrpaymentstatus","deprecated":false},{"title":"/qrpayments/cancelqrpayment","summary":"Cancel QR Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qr-payments/cancelqrpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Mode","link":"/apis/payments-platform-rest/openapi/mode","routeSlug":"/apis/payments-platform-rest/openapi/mode","items":[{"label":"Go Offline","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/mode/modeoffline","routeSlug":"/apis/payments-platform-rest/openapi/mode/modeoffline","metadata":{"seo":{"title":"Go Offline","description":"This function is used to put UTG/Commerce Engine into offline mode. UTG/Commerce Engine will be configured to set a maximum duration for how long it will stay in offline mode in order to prevent UTG/Commerce Engine from staying offline indefinitely if the Interface Vendor does not send the go online request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modeoffline","name":"Go Offline","isWebhook":false,"pointer":"/paths/~1mode~1offline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Go Offline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to put UTG/Commerce Engine into offline mode. UTG/Commerce Engine will be configured to set a maximum duration for how long it will stay in offline mode in order to prevent UTG/Commerce Engine from staying offline indefinitely if the Interface Vendor does not send the go online request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: To utilize this feature with UTG, you must be running UTG version 3080 or later. UTG can be configured to disable this feature, which will prevent the API request from putting UTG into offline mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1mode~1offline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1mode~1offline/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mode/offline","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_343"}},"responseCodes":["200","400","504"],"pointer":"/mode/offline","href":"mode/modeoffline","openApiOperationId":"modeoffline","summary":"Go Offline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"}],"schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Go Offline request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1mode~1offline/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1mode~1offline/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1mode~1offline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1mode~1offline/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1mode~1offline/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mode/modeoffline"}],"panels":[]}]},"httpPath":"/mode/offline"},{"label":"Go Online","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/mode/modeonline","routeSlug":"/apis/payments-platform-rest/openapi/mode/modeonline","metadata":{"seo":{"title":"Go Online","description":"This function is used to bring UTG/Commerce Engine out of offline mode after putting UTG/Commerce Engine into offline mode via the Go Online request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modeonline","name":"Go Online","isWebhook":false,"pointer":"/paths/~1mode~1online/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Go Online","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to bring UTG/Commerce Engine out of offline mode after putting UTG/Commerce Engine into offline mode via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/mode/modeoffline"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go Online"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: To utilize this feature with UTG, you must be running UTG version 3080 or later."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locally Installed UTG"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce Engine For On Premise"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1mode~1online/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1mode~1online/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mode/online","servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_343"}},"responseCodes":["200","400","504"],"pointer":"/mode/online","href":"mode/modeonline","openApiOperationId":"modeonline","summary":"Go Online"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://192.168.1.10:277/api/rest/v1","description":"Locally Installed UTG URL"},{"url":"https://192.168.1.20:8085/api/rest/v1","description":"Commerce Engine For On Premise URL"}],"schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Go Online request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error"]}},"schemaId":"schema_224","exampleIds":["paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error"]},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1mode~1online/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1mode~1online/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1mode~1online/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error"]}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1mode~1online/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1mode~1online/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mode/modeonline"}],"panels":[]}]},"httpPath":"/mode/online"}],"content":{"contentType":"group","meta":{"name":"Mode"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mode","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/mode/offline","summary":"Go Offline","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mode/modeoffline","deprecated":false},{"title":"/mode/online","summary":"Go Online","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mode/modeonline","deprecated":false}]}]}]}]}},{"type":"group","label":"Risk","link":"/apis/payments-platform-rest/openapi/risk","routeSlug":"/apis/payments-platform-rest/openapi/risk","items":[{"label":"Risk Assess","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/risk/riskassess","routeSlug":"/apis/payments-platform-rest/openapi/risk/riskassess","metadata":{"seo":{"title":"Risk Assess","description":"Used to check the level of risk before processing a transaction. Risk assessment returns four possible values: approve, deny, escalate and review. If the risk  transaction is approved or review, you will be able to make a payment call with the risk  assessment, risk id and transaction id you get in response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"riskassess","name":"Risk Assess","isWebhook":false,"pointer":"/paths/~1risk~1assess/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk Assess","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to check the level of risk before processing a transaction. Risk assessment returns four possible values: approve, deny, escalate and review. If the risk  transaction is approved or review, you will be able to make a payment call with the risk  assessment, risk id and transaction id you get in response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1risk~1assess/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"schemaId":"schema_345","pointer":"/paths/~1risk~1assess/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/risk/assess","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_345"}},"responseCodes":["200","400","504"],"pointer":"/risk/assess","href":"risk/riskassess","openApiOperationId":"riskassess","summary":"Risk Assess"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_345","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk assessment was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1risk~1assess/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_346","exampleIds":["paths/~1risk~1assess/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}},"schemaId":"schema_348"}],"pointer":"/paths/~1risk~1assess/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1risk~1assess/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1risk~1assess/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"504","schemaId":"schema_348","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk/riskassess"}],"panels":[]}]},"httpPath":"/risk/assess"}],"content":{"contentType":"group","meta":{"name":"Risk"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/risk/assess","summary":"Risk Assess","prefix":{"name":"post","color":"post"},"badges":[],"link":"/risk/riskassess","deprecated":false}]}]}]}]}},{"type":"group","label":"PayPal","link":"/apis/payments-platform-rest/openapi/paypal","routeSlug":"/apis/payments-platform-rest/openapi/paypal","items":[{"label":"PayPal Initiate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/paypal/paypalinitiate","routeSlug":"/apis/payments-platform-rest/openapi/paypal/paypalinitiate","metadata":{"seo":{"title":"PayPal Initiate","description":"This request initiates a PayPal transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paypalinitiate","name":"PayPal Initiate","isWebhook":false,"pointer":"/paths/~1paypal~1initiate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayPal Initiate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request initiates a PayPal transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1paypal~1initiate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/~1paypal~1initiate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paypal/initiate","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_362"}},"responseCodes":["200"],"pointer":"/paypal/initiate","href":"paypal/paypalinitiate","openApiOperationId":"paypalinitiate","summary":"PayPal Initiate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"}],"pointer":"/paths/~1paypal~1initiate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paypal/paypalinitiate"}],"panels":[]}]},"httpPath":"/paypal/initiate"},{"label":"PayPal Sale Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/paypal/paypalsale","routeSlug":"/apis/payments-platform-rest/openapi/paypal/paypalsale","metadata":{"seo":{"title":"PayPal Sale Transaction","description":"This authorizes and captures the transaction. In addition, it will return a payload that includes the transaction's  sale details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paypalsale","name":"PayPal Sale Transaction","isWebhook":false,"pointer":"/paths/~1paypal~1sale/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayPal Sale Transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authorizes and captures the transaction. In addition, it will return a payload that includes the transaction's  sale details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1paypal~1sale/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1paypal~1sale/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_364","exampleIds":["paths/~1paypal~1sale/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1paypal~1sale/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paypal/sale","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1paypal~1sale/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/paypal/sale","href":"paypal/paypalsale","openApiOperationId":"paypalsale","summary":"PayPal Sale Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_364","exampleIds":["paths/~1paypal~1sale/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1paypal~1sale/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1paypal~1sale/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_365","exampleIds":["paths/~1paypal~1sale/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1paypal~1sale/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_365","exampleIds":["paths/~1paypal~1sale/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1paypal~1sale/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paypal/paypalsale"}],"panels":[]}]},"httpPath":"/paypal/sale"},{"label":"PayPal Refund Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/paypal/paypalrefund","routeSlug":"/apis/payments-platform-rest/openapi/paypal/paypalrefund","metadata":{"seo":{"title":"PayPal Refund Transaction","description":"This refunds a settled transaction. In addition, it will return a  payload that includes the transaction’s refund details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paypalrefund","name":"PayPal Refund Transaction","isWebhook":false,"pointer":"/paths/~1paypal~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayPal Refund Transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This refunds a settled transaction. In addition, it will return a  payload that includes the transaction’s refund details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1paypal~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1paypal~1refund/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_366","exampleIds":["paths/~1paypal~1refund/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1paypal~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paypal/refund","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1paypal~1refund/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/paypal/refund","href":"paypal/paypalrefund","openApiOperationId":"paypalrefund","summary":"PayPal Refund Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_366","exampleIds":["paths/~1paypal~1refund/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1paypal~1refund/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1paypal~1refund/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_367","exampleIds":["paths/~1paypal~1refund/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1paypal~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_367","exampleIds":["paths/~1paypal~1refund/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1paypal~1refund/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paypal/paypalrefund"}],"panels":[]}]},"httpPath":"/paypal/refund"}],"content":{"contentType":"group","meta":{"name":"PayPal"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PayPal","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/paypal/initiate","summary":"PayPal Initiate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/paypal/paypalinitiate","deprecated":false},{"title":"/paypal/sale","summary":"PayPal Sale Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/paypal/paypalsale","deprecated":false},{"title":"/paypal/refund","summary":"PayPal Refund Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/paypal/paypalrefund","deprecated":false}]}]}]}]}},{"type":"group","label":"3D Secure","link":"/apis/payments-platform-rest/openapi/3d-secure","routeSlug":"/apis/payments-platform-rest/openapi/3d-secure","items":[{"label":"3D Secure Standalone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/3d-secure/3dsecurestandalone","routeSlug":"/apis/payments-platform-rest/openapi/3d-secure/3dsecurestandalone","metadata":{"seo":{"title":"3D Secure Standalone","description":"This function is used to process a request via the 3D Secure process without authorizing the payment. This will return the result of the 3D Secure process as well as the 3D Secure data that can then be used to process a payment via the Authorization or Sale/Purchase endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"3dsecurestandalone","name":"3D Secure Standalone","isWebhook":false,"pointer":"/paths/~13dsecure~1standalone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3D Secure Standalone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to process a request via the 3D Secure process without authorizing the payment. This will return the result of the 3D Secure process as well as the 3D Secure data that can then be used to process a payment via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionsauthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionssale"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale/Purchase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~13dsecure~1standalone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368","pointer":"/paths/~13dsecure~1standalone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/3dsecure/standalone","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368"}},"responseCodes":["200","400","504"],"pointer":"/3dsecure/standalone","href":"3d-secure/3dsecurestandalone","openApiOperationId":"3dsecurestandalone","summary":"3D Secure Standalone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~13dsecure~1standalone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"code":"400","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3d-secure/3dsecurestandalone"}],"panels":[]}]},"httpPath":"/3dsecure/standalone"},{"label":"3D Secure Completion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/3d-secure/3dsecurecompletion","routeSlug":"/apis/payments-platform-rest/openapi/3d-secure/3dsecurecompletion","metadata":{"seo":{"title":"3D Secure Completion","description":"This endpoint is utilized to send the status of the device fingerprint. This must be sent whenever the response to the 3D Secure Standalone results in a device fingerprint required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"3dsecurecompletion","name":"3D Secure Completion","isWebhook":false,"pointer":"/paths/~13dsecure~1completion/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3D Secure Completion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is utilized to send the status of the device fingerprint. This must be sent whenever the response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/3d-secure/3dsecurestandalone"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure Standalone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in a device fingerprint required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~13dsecure~1completion/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_371","exampleIds":["paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"],"pointer":"/paths/~13dsecure~1completion/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/3dsecure/completion","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/3dsecure/completion","href":"3d-secure/3dsecurecompletion","openApiOperationId":"3dsecurecompletion","summary":"3D Secure Completion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_371","exampleIds":["paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1completion/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1completion/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~13dsecure~1completion/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"400","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~13dsecure~1completion/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~13dsecure~1completion/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3d-secure/3dsecurecompletion"}],"panels":[]}]},"httpPath":"/3dsecure/completion"}],"content":{"contentType":"group","meta":{"name":"3D Secure"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3D Secure","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/3dsecure/standalone","summary":"3D Secure Standalone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3d-secure/3dsecurestandalone","deprecated":false},{"title":"/3dsecure/completion","summary":"3D Secure Completion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3d-secure/3dsecurecompletion","deprecated":false}]}]}]}]}},{"type":"group","label":"OCT","link":"/apis/payments-platform-rest/openapi/oct","routeSlug":"/apis/payments-platform-rest/openapi/oct","items":[{"label":"OCT Payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/oct/octpayout","routeSlug":"/apis/payments-platform-rest/openapi/oct/octpayout","metadata":{"seo":{"title":"OCT Payout","description":"Used to process an original credit transaction to transfer funds from the merchant to the recipient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"octpayout","name":"OCT Payout","isWebhook":false,"pointer":"/paths/~1oct~1payout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OCT Payout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to process an original credit transaction to transfer funds from the merchant to the recipient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1oct~1payout/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","pointer":"/paths/~1oct~1payout/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oct/payout","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_373"}},"responseCodes":["200","400","504"],"pointer":"/oct/payout","href":"oct/octpayout","openApiOperationId":"octpayout","summary":"OCT Payout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1oct~1payout/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_374","exampleIds":["paths/~1oct~1payout/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376"}],"pointer":"/paths/~1oct~1payout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","exampleIds":["paths/~1oct~1payout/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1oct~1payout/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}},{"code":"504","schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oct/octpayout"}],"panels":[]}]},"httpPath":"/oct/payout"},{"label":"OCT Update Recipient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/oct/octupdaterecipient","routeSlug":"/apis/payments-platform-rest/openapi/oct/octupdaterecipient","metadata":{"seo":{"title":"OCT Update Recipient","description":"Used to update the OCT recipient email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"octupdaterecipient","name":"OCT Update Recipient","isWebhook":false,"pointer":"/paths/~1oct~1updaterecipient/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OCT Update Recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to update the OCT recipient email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1oct~1updaterecipient/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_377","exampleIds":["paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1oct~1updaterecipient/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oct/updaterecipient","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","504"],"pointer":"/oct/updaterecipient","href":"oct/octupdaterecipient","openApiOperationId":"octupdaterecipient","summary":"OCT Update Recipient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_377","exampleIds":["paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376"}],"pointer":"/paths/~1oct~1updaterecipient/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}}},{"code":"400","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}},{"code":"504","schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oct/octupdaterecipient"}],"panels":[]}]},"httpPath":"/oct/updaterecipient"}],"content":{"contentType":"group","meta":{"name":"OCT"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OCT","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oct/payout","summary":"OCT Payout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oct/octpayout","deprecated":false},{"title":"/oct/updaterecipient","summary":"OCT Update Recipient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oct/octupdaterecipient","deprecated":false}]}]}]}]}},{"type":"group","label":"ACH","link":"/apis/payments-platform-rest/openapi/ach","routeSlug":"/apis/payments-platform-rest/openapi/ach","items":[{"label":"ACH Verify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achverify","routeSlug":"/apis/payments-platform-rest/openapi/ach/achverify","metadata":{"seo":{"title":"ACH Verify","description":"Used to verify an ach bank account prior to sending an ACH sale/refund transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achverify","name":"ACH Verify","isWebhook":false,"pointer":"/paths/~1ach~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH Verify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to verify an ach bank account prior to sending an ACH sale/refund transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379","pointer":"/paths/~1ach~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/verify","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_379"}},"responseCodes":["200","400","504"],"pointer":"/ach/verify","href":"ach/achverify","openApiOperationId":"achverify","summary":"ACH Verify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achverify"}],"panels":[]}]},"httpPath":"/ach/verify"},{"label":"ACH Sale","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achsale","routeSlug":"/apis/payments-platform-rest/openapi/ach/achsale","metadata":{"seo":{"title":"ACH Sale","description":"Used to process an ach sale transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achsale","name":"ACH Sale","isWebhook":false,"pointer":"/paths/~1ach~1sale/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH Sale","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to process an ach sale transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1sale/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383","pointer":"/paths/~1ach~1sale/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/sale","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_383"}},"responseCodes":["200","400","504"],"pointer":"/ach/sale","href":"ach/achsale","openApiOperationId":"achsale","summary":"ACH Sale"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384","exampleIds":["paths/~1ach~1sale/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_384","exampleIds":["paths/~1ach~1sale/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1sale/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_384","exampleIds":["paths/~1ach~1sale/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384","exampleIds":["paths/~1ach~1sale/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achsale"}],"panels":[]}]},"httpPath":"/ach/sale"},{"label":"ACH Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achrefund","routeSlug":"/apis/payments-platform-rest/openapi/ach/achrefund","metadata":{"seo":{"title":"ACH Refund","description":"Used to process an ach refund transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achrefund","name":"ACH Refund","isWebhook":false,"pointer":"/paths/~1ach~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH Refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to process an ach refund transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","pointer":"/paths/~1ach~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/refund","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_385"}},"responseCodes":["200","400","504"],"pointer":"/ach/refund","href":"ach/achrefund","openApiOperationId":"achrefund","summary":"ACH Refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386","exampleIds":["paths/~1ach~1refund/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_386","exampleIds":["paths/~1ach~1refund/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_386","exampleIds":["paths/~1ach~1refund/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386","exampleIds":["paths/~1ach~1refund/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achrefund"}],"panels":[]}]},"httpPath":"/ach/refund"},{"label":"ACH Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achstatus","routeSlug":"/apis/payments-platform-rest/openapi/ach/achstatus","metadata":{"seo":{"title":"ACH Status","description":"Used to process an ach sale transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achstatus","name":"ACH Status","isWebhook":false,"pointer":"/paths/~1ach~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to process an ach sale transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/~1ach~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/status","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_387"}},"responseCodes":["200","400","504"],"pointer":"/ach/status","href":"ach/achstatus","openApiOperationId":"achstatus","summary":"ACH Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388","exampleIds":["paths/~1ach~1status/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_388","exampleIds":["paths/~1ach~1status/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","exampleIds":["paths/~1ach~1status/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388","exampleIds":["paths/~1ach~1status/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achstatus"}],"panels":[]}]},"httpPath":"/ach/status"},{"label":"Create Plaid Link Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achplaidlinktokencreate","routeSlug":"/apis/payments-platform-rest/openapi/ach/achplaidlinktokencreate","metadata":{"seo":{"title":"Create Plaid Link Token","description":"Used to create a Plaid Link token to use with the Plaid Link UI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achplaidlinktokencreate","name":"Create Plaid Link Token","isWebhook":false,"pointer":"/paths/~1ach~1plaid~1link_token~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Plaid Link Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to create a Plaid Link token to use with the Plaid Link UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1plaid~1link_token~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/~1ach~1plaid~1link_token~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/plaid/link_token/create","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["200","400","504"],"pointer":"/ach/plaid/link_token/create","href":"ach/achplaidlinktokencreate","openApiOperationId":"achplaidlinktokencreate","summary":"Create Plaid Link Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_390","exampleIds":["paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1plaid~1link_token~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_390","exampleIds":["paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achplaidlinktokencreate"}],"panels":[]}]},"httpPath":"/ach/plaid/link_token/create"},{"label":"Plaid Public Token Exchange","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achplaidpublictokenexchange","routeSlug":"/apis/payments-platform-rest/openapi/ach/achplaidpublictokenexchange","metadata":{"seo":{"title":"Plaid Public Token Exchange","description":"Used to create a Plaid Link token to use with the Plaid Link UI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achplaidpublictokenexchange","name":"Plaid Public Token Exchange","isWebhook":false,"pointer":"/paths/~1ach~1plaid~1public_token~1exchange/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plaid Public Token Exchange","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to create a Plaid Link token to use with the Plaid Link UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1ach~1plaid~1public_token~1exchange/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391","pointer":"/paths/~1ach~1plaid~1public_token~1exchange/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ach/plaid/public_token/exchange","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_391"}},"responseCodes":["200","400","504"],"pointer":"/ach/plaid/public_token/exchange","href":"ach/achplaidpublictokenexchange","openApiOperationId":"achplaidpublictokenexchange","summary":"Plaid Public Token Exchange"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392","exampleIds":["paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_392","exampleIds":["paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"}],"pointer":"/paths/~1ach~1plaid~1public_token~1exchange/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_392","exampleIds":["paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392","exampleIds":["paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"504","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achplaidpublictokenexchange"}],"panels":[]}]},"httpPath":"/ach/plaid/public_token/exchange"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/payments-platform-rest/openapi/ach/achnotification","routeSlug":"/apis/payments-platform-rest/openapi/ach/achnotification","metadata":{"seo":{"title":"Notification","description":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides status of the ach request. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"achnotification","name":"Notification","isWebhook":true,"pointer":"/paths/ach-notification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides status of the ach request. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration.\n\nThis requires the interface vendor to establish a listening service to receive these requests.\n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/ach-notification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ach-notification","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["200"],"pointer":"ach-notification","href":"ach/achnotification","openApiOperationId":"achnotification","summary":"Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return 200 status to indicate that the Notification was received successfully.\n"}],"pointer":"/paths/ach-notification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/achnotification"}],"panels":[]}]},"httpPath":"ach-notification"}],"content":{"contentType":"group","meta":{"name":"ACH"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ach/verify","summary":"ACH Verify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achverify","deprecated":false},{"title":"/ach/sale","summary":"ACH Sale","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achsale","deprecated":false},{"title":"/ach/refund","summary":"ACH Refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achrefund","deprecated":false},{"title":"/ach/status","summary":"ACH Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achstatus","deprecated":false},{"title":"/ach/plaid/link_token/create","summary":"Create Plaid Link Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achplaidlinktokencreate","deprecated":false},{"title":"/ach/plaid/public_token/exchange","summary":"Plaid Public Token Exchange","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achplaidpublictokenexchange","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"ach-notification","summary":"Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/achnotification","deprecated":false}]}]}]}]}},{"type":"group","label":"Updater","link":"/apis/payments-platform-rest/openapi/updater","routeSlug":"/apis/payments-platform-rest/openapi/updater","items":[{"label":"Account Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/updater/updaterrequest","routeSlug":"/apis/payments-platform-rest/openapi/updater/updaterrequest","metadata":{"seo":{"title":"Account Update","description":"This function is used to request an account update for a set of tokens."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updaterrequest","name":"Account Update","isWebhook":false,"pointer":"/paths/~1updater~1request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request an account update for a set of tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1updater~1request/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396","pointer":"/paths/~1updater~1request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/updater/request","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_396"}},"responseCodes":["200","400","504"],"pointer":"/updater/request","href":"updater/updaterrequest","openApiOperationId":"updaterrequest","summary":"Account Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"}],"pointer":"/paths/~1updater~1request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"504","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/updater/updaterrequest"}],"panels":[]}]},"httpPath":"/updater/request"},{"label":"Account Update Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/updater/updaterstatus","routeSlug":"/apis/payments-platform-rest/openapi/updater/updaterstatus","metadata":{"seo":{"title":"Account Update Status","description":"This function is used to request a status update to a previous Account Update request for a set of tokens."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updaterstatus","name":"Account Update Status","isWebhook":false,"pointer":"/paths/~1updater~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Update Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This function is used to request a status update to a previous "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/updater/updaterrequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request for a set of tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1updater~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1updater~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/updater/status","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","504"],"pointer":"/updater/status","href":"updater/updaterstatus","openApiOperationId":"updaterstatus","summary":"Account Update Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"}],"pointer":"/paths/~1updater~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"504","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/updater/updaterstatus"}],"panels":[]}]},"httpPath":"/updater/status"}],"content":{"contentType":"group","meta":{"name":"Updater"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updater","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/updater/request","summary":"Account Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/updater/updaterrequest","deprecated":false},{"title":"/updater/status","summary":"Account Update Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/updater/updaterstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"DCC","link":"/apis/payments-platform-rest/openapi/dcc","routeSlug":"/apis/payments-platform-rest/openapi/dcc","items":[{"label":"DCC Rate Lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/dcc/dccratelookup","routeSlug":"/apis/payments-platform-rest/openapi/dcc/dccratelookup","metadata":{"seo":{"title":"DCC Rate Lookup","description":"Used to look up the dynamic currency conversion rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dccratelookup","name":"DCC Rate Lookup","isWebhook":false,"pointer":"/paths/~1dcc~1ratelookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DCC Rate Lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to look up the dynamic currency conversion rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1dcc~1ratelookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402","pointer":"/paths/~1dcc~1ratelookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dcc/ratelookup","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_402"}},"responseCodes":["200","400","504"],"pointer":"/dcc/ratelookup","href":"dcc/dccratelookup","openApiOperationId":"dccratelookup","summary":"DCC Rate Lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403","exampleIds":["paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_403","exampleIds":["paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1dcc~1ratelookup/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_403","exampleIds":["paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403","exampleIds":["paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dcc/dccratelookup"}],"panels":[]}]},"httpPath":"/dcc/ratelookup"}],"content":{"contentType":"group","meta":{"name":"DCC"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DCC","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dcc/ratelookup","summary":"DCC Rate Lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dcc/dccratelookup","deprecated":false}]}]}]}]}},{"type":"group","label":"Rule","link":"/apis/payments-platform-rest/openapi/rule","routeSlug":"/apis/payments-platform-rest/openapi/rule","items":[{"label":"Rule Verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/rule/ruleverify","routeSlug":"/apis/payments-platform-rest/openapi/rule/ruleverify","metadata":{"seo":{"title":"Rule Verification","description":"Used to check for various processing rules such as surcharge eligibility."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ruleverify","name":"Rule Verification","isWebhook":false,"pointer":"/paths/~1rule~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rule Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to check for various processing rules such as surcharge eligibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#json-body-schemas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Body Schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on the various JSON body formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1rule~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","pointer":"/paths/~1rule~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rule/verify","servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_404"}},"responseCodes":["200","400","504"],"pointer":"/rule/verify","href":"rule/ruleverify","openApiOperationId":"ruleverify","summary":"Rule Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}],"schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1rule~1verify/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_405","exampleIds":["paths/~1rule~1verify/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1rule~1verify/post/responses/504/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1rule~1verify/post/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1rule~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","exampleIds":["paths/~1rule~1verify/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1rule~1verify/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"504","schemaId":"schema_225","exampleIds":["paths/~1rule~1verify/post/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1rule~1verify/post/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rule/ruleverify"}],"panels":[]}]},"httpPath":"/rule/verify"}],"content":{"contentType":"group","meta":{"name":"Rule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rule","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rule/verify","summary":"Rule Verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rule/ruleverify","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Links","link":"/apis/payments-platform-rest/openapi/payment-links","routeSlug":"/apis/payments-platform-rest/openapi/payment-links","items":[{"label":"Create Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkcreate","routeSlug":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkcreate","metadata":{"seo":{"title":"Create Link","description":"Used to send out a link via the Payment Links system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentslinkcreate","name":"Create Link","isWebhook":false,"pointer":"/paths/~1paymentlinks~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to send out a link via the Payment Links system"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentLink.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to choose the flow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) — a standard payment flow. Provide the products in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentLink.lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — performs a $0 authorization to confirm the card is valid and save it on file "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charging it. These links take "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentLink.currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a new inline customer or an existing one referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1paymentlinks~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1paymentlinks~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentlinks/create","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["200","400","504"],"pointer":"/paymentlinks/create","href":"payment-links/paymentslinkcreate","openApiOperationId":"paymentslinkcreate","summary":"Create Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1paymentlinks~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/paymentslinkcreate"}],"panels":[]}]},"httpPath":"/paymentlinks/create"},{"label":"List Links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/payment-links/paymentslinklist","routeSlug":"/apis/payments-platform-rest/openapi/payment-links/paymentslinklist","metadata":{"seo":{"title":"List Links","description":"Used to retrieve a list of links via the Payment Links system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentslinklist","name":"List Links","isWebhook":false,"pointer":"/paths/~1paymentlinks~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to retrieve a list of links via the Payment Links system"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Limit","in":"header","schemaId":"schema_409","description":"Maximum number of returned objects\n"},{"name":"StartingAfterId","in":"header","schemaId":"schema_410","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor used for pagination (getting the next page). For example, if you make a list request and receive 10 objects, where the last object has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - then you can make another request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingAfterId=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the next page of that list."},"children":[]}]}]}]},{"name":"EndingBeforeId","in":"header","schemaId":"schema_410","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor used for pagination (getting the previous page). For example, if you make a list request and receive 10 objects, where the first object has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - then you can make another request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingBeforeId=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the previous page of that list"},"children":[]}]}]}]},{"name":"DatetimeAfter","in":"header","schemaId":"schema_411","description":"Returns only records strictly after the specified timestamp\n"},{"name":"DatetimeBefore","in":"header","schemaId":"schema_411","description":"Returns only records strictly before the specified timestamp\n"}],"pointer":"/paths/~1paymentlinks~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/paymentlinks/list","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"Limit","in":"header","schemaId":"schema_409"},{"name":"StartingAfterId","in":"header","schemaId":"schema_410"},{"name":"EndingBeforeId","in":"header","schemaId":"schema_410"},{"name":"DatetimeAfter","in":"header","example":"2024-05-21T09:18:23.283-07:00","schemaId":"schema_411"},{"name":"DatetimeBefore","in":"header","example":"2024-05-21T09:18:23.283-07:00","schemaId":"schema_411"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/paymentlinks/list","href":"payment-links/paymentslinklist","openApiOperationId":"paymentslinklist","summary":"List Links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1paymentlinks~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/paymentslinklist"}],"panels":[]}]},"httpPath":"/paymentlinks/list"},{"label":"Retrieve Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkretrieve","routeSlug":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkretrieve","metadata":{"seo":{"title":"Retrieve Link","description":"Used to retrieve a single link via the Payment Links system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentslinkretrieve","name":"Retrieve Link","isWebhook":false,"pointer":"/paths/~1paymentlinks~1retrieve/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to retrieve a single link via the Payment Links system"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"PaymentLinkId","in":"header","schemaId":"schema_410","description":"Used for selecting payment link by id\n","required":true}],"pointer":"/paths/~1paymentlinks~1retrieve/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/paymentlinks/retrieve","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"PaymentLinkId","in":"header","required":true,"schemaId":"schema_410"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/paymentlinks/retrieve","href":"payment-links/paymentslinkretrieve","openApiOperationId":"paymentslinkretrieve","summary":"Retrieve Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1paymentlinks~1retrieve/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/paymentslinkretrieve"}],"panels":[]}]},"httpPath":"/paymentlinks/retrieve"},{"label":"Update Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkupdate","routeSlug":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkupdate","metadata":{"seo":{"title":"Update Link","description":"Used to update an existing payment link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentslinkupdate","name":"Update Link","isWebhook":false,"pointer":"/paths/~1paymentlinks~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to update an existing payment link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"PaymentLinkId","in":"header","schemaId":"schema_410","description":"Used for selecting payment link by id\n","required":true}],"pointer":"/paths/~1paymentlinks~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413","pointer":"/paths/~1paymentlinks~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentlinks/update","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"PaymentLinkId","in":"header","required":true,"schemaId":"schema_410"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_413"}},"responseCodes":["200","400","504"],"pointer":"/paymentlinks/update","href":"payment-links/paymentslinkupdate","openApiOperationId":"paymentslinkupdate","summary":"Update Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1paymentlinks~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/paymentslinkupdate"}],"panels":[]}]},"httpPath":"/paymentlinks/update"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Payment Links Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/payments-platform-rest/openapi/payment-links/paymentlinksnotification","routeSlug":"/apis/payments-platform-rest/openapi/payment-links/paymentlinksnotification","metadata":{"seo":{"title":"Payment Links Notification","description":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the Payment Links request. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentlinksnotification","name":"Payment Links Notification","isWebhook":true,"pointer":"/paths/paymentlinks-notification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Links Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the Payment Links request. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration.\n\nThis requires the interface vendor to establish a listening service to receive these requests.\n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414","pointer":"/paths/paymentlinks-notification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"paymentlinks-notification","servers":[{"url":"https://api.merchant.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_414"}},"responseCodes":["200"],"pointer":"paymentlinks-notification","href":"payment-links/paymentlinksnotification","openApiOperationId":"paymentlinksnotification","summary":"Payment Links Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.merchant.com"}],"schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return 200 status to indicate that the Notification was received successfully.\n"}],"pointer":"/paths/paymentlinks-notification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/paymentlinksnotification"}],"panels":[]}]},"httpPath":"paymentlinks-notification"}],"content":{"contentType":"group","meta":{"name":"Payment Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Links","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/paymentlinks/create","summary":"Create Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/paymentslinkcreate","deprecated":false},{"title":"/paymentlinks/list","summary":"List Links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-links/paymentslinklist","deprecated":false},{"title":"/paymentlinks/retrieve","summary":"Retrieve Link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-links/paymentslinkretrieve","deprecated":false},{"title":"/paymentlinks/update","summary":"Update Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/paymentslinkupdate","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"paymentlinks-notification","summary":"Payment Links Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/paymentlinksnotification","deprecated":false}]}]}]}]}},{"type":"group","label":"Checkout Sessions","link":"/apis/payments-platform-rest/openapi/checkout-sessions","routeSlug":"/apis/payments-platform-rest/openapi/checkout-sessions","items":[{"label":"Create Checkout Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionscreate","routeSlug":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionscreate","metadata":{"seo":{"title":"Create Checkout Session","description":"Creates a Checkout Session — the server-side configuration for a single payment attempt."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkoutsessionscreate","name":"Create Checkout Session","isWebhook":false,"pointer":"/paths/~1checkoutsessions~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Checkout Session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Checkout Session — the server-side configuration for a single payment attempt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response carries two fields for collecting payment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for embedding Custom Components on your own page, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for redirecting the customer to a Shift4-hosted checkout page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Checkout Session is immutable: to change the line items, customer, or any other configuration, create a new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain one via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1checkoutsessions~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCheckoutSessionWebV1Request"}},"schemaId":"components/schemas/CreateCheckoutSessionWebV1Request","pointer":"/paths/~1checkoutsessions~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkoutsessions/create","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCheckoutSessionWebV1Request"}},"responseCodes":["200","400","504"],"pointer":"/checkoutsessions/create","href":"checkout-sessions/checkoutsessionscreate","openApiOperationId":"checkoutsessionscreate","summary":"Create Checkout Session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"schemaId":"components/schemas/CreateCheckoutSessionWebV1Request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCheckoutSessionWebV1Request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1checkoutsessions~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout-sessions/checkoutsessionscreate"}],"panels":[]}]},"httpPath":"/checkoutsessions/create"},{"label":"List Checkout Sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionslist","routeSlug":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionslist","metadata":{"seo":{"title":"List Checkout Sessions","description":"Returns a paginated list of Checkout Sessions, most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkoutsessionslist","name":"List Checkout Sessions","isWebhook":false,"pointer":"/paths/~1checkoutsessions~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Checkout Sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of Checkout Sessions, most recent first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination and time filters are passed as request headers — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartingAfterId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndingBeforeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DatetimeAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DatetimeBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — alongside further filtering headers described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain one via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Limit","in":"header","schemaId":"schema_416","description":"Maximum number of returned objects"},{"name":"StartingAfterId","in":"header","schemaId":"schema_417","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor used for pagination (getting the next page). For example, if you make a list request and receive 10 objects, where the last object has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - then you can make another request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingAfterId=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the next page of that list."},"children":[]}]}]}]},{"name":"EndingBeforeId","in":"header","schemaId":"schema_417","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor used for pagination (getting the previous page). For example, if you make a list request and receive 10 objects, where the first object has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - then you can make another request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endingBeforeId=some-example-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the previous page of that list"},"children":[]}]}]}]},{"name":"DatetimeAfter","in":"header","schemaId":"schema_418","description":"Returns only records strictly after the specified timestamp","example":"2024-05-21T09:18:23.283-07:00"},{"name":"DatetimeBefore","in":"header","schemaId":"schema_418","description":"Returns only records strictly before the specified timestamp","example":"2024-05-21T09:18:23.283-07:00"},{"name":"PaymentLinkId","in":"header","schemaId":"schema_417","description":"Used for selecting payment link by id"},{"name":"Status","in":"header","schemaId":"schema_419","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter checkout sessions by their current status. When omitted, all sessions are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Session is open — payment not yet completed, not expired, and within the allowed failure count"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment was completed successfully"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Session expired before a payment was completed successfully"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment was attempted but reached the maximum number of failed attempts"},"children":[]}]}]}]}]}]}]}],"pointer":"/paths/~1checkoutsessions~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkoutsessions/list","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"Limit","in":"header","schemaId":"schema_416"},{"name":"StartingAfterId","in":"header","schemaId":"schema_417"},{"name":"EndingBeforeId","in":"header","schemaId":"schema_417"},{"name":"DatetimeAfter","in":"header","example":"2024-05-21T09:18:23.283-07:00","schemaId":"schema_418"},{"name":"DatetimeBefore","in":"header","example":"2024-05-21T09:18:23.283-07:00","schemaId":"schema_418"},{"name":"PaymentLinkId","in":"header","schemaId":"schema_417"},{"name":"Status","in":"header","schemaId":"schema_419"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/checkoutsessions/list","href":"checkout-sessions/checkoutsessionslist","openApiOperationId":"checkoutsessionslist","summary":"List Checkout Sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1checkoutsessions~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout-sessions/checkoutsessionslist"}],"panels":[]}]},"httpPath":"/checkoutsessions/list"},{"label":"Retrieve Checkout Session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionsretrieve","routeSlug":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionsretrieve","metadata":{"seo":{"title":"Retrieve Checkout Session","description":"Retrieves a single Checkout Session by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkoutsessionsretrieve","name":"Retrieve Checkout Session","isWebhook":false,"pointer":"/paths/~1checkoutsessions~1retrieve/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Checkout Session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single Checkout Session by id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id is passed via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckoutSessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header. Returns the same envelope shape as Create and List — the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastOpened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamps, the latest event, and (once the customer has paid) "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host Direct"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#integration-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#urls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs Section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections of the Development Quick Start guide for details regarding each processing option."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"AccessToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"InterfaceVersion","in":"header","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"InterfaceName","in":"header","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"CompanyName","in":"header","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \\ + ="},"children":[]}]}]}],"required":true},{"name":"AccessToken","in":"header","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain one via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"CheckoutSessionId","in":"header","schemaId":"schema_410","description":"Used for selecting checkout session by id","required":true}],"pointer":"/paths/~1checkoutsessions~1retrieve/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkoutsessions/retrieve","servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"InterfaceVersion","in":"header","required":true,"example":"2.1","schemaId":"schema_219"},{"name":"InterfaceName","in":"header","required":true,"example":"ForwardPOS","schemaId":"schema_220"},{"name":"CompanyName","in":"header","required":true,"example":"PAWS","schemaId":"schema_221"},{"name":"AccessToken","in":"header","required":true,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","schemaId":"schema_226"},{"name":"CheckoutSessionId","in":"header","required":true,"schemaId":"schema_410"}],"cookie":[]},"security":[{"schemes":[{"id":"AccessToken","type":"apiKey","name":"AccessToken","in":"header"}],"scopes":[]}],"responseCodes":["200","400","504"],"pointer":"/checkoutsessions/retrieve","href":"checkout-sessions/checkoutsessionsretrieve","openApiOperationId":"checkoutsessionsretrieve","summary":"Retrieve Checkout Session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com/api/rest/v1","description":"Host Direct URL"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request was processed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"504","description":"Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1checkoutsessions~1retrieve/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"504","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout-sessions/checkoutsessionsretrieve"}],"panels":[]}]},"httpPath":"/checkoutsessions/retrieve"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Checkout Sessions Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionsnotification","routeSlug":"/apis/payments-platform-rest/openapi/checkout-sessions/checkoutsessionsnotification","metadata":{"seo":{"title":"Checkout Sessions Notification","description":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the checkout session. This notification request is sent to the webhookUrl set on the Checkout Session. For a Checkout Session created by opening a Payment Link, the link's webhookUrl is used instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkoutsessionsnotification","name":"Checkout Sessions Notification","isWebhook":true,"pointer":"/paths/checkoutsessions-notification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checkout Sessions Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the checkout session. This notification request is sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set on the Checkout Session. For a Checkout Session created by opening a Payment Link, the link's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhookUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This requires the interface vendor to establish a listening service to receive these requests."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckoutSessionWebV1Response"}},"schemaId":"components/schemas/CheckoutSessionWebV1Response","pointer":"/paths/checkoutsessions-notification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"checkoutsessions-notification","servers":[{"url":"https://api.merchant.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckoutSessionWebV1Response"}},"responseCodes":["200"],"pointer":"checkoutsessions-notification","href":"checkout-sessions/checkoutsessionsnotification","openApiOperationId":"checkoutsessionsnotification","summary":"Checkout Sessions Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.merchant.com"}],"schemaId":"components/schemas/CheckoutSessionWebV1Response","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckoutSessionWebV1Response"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return 200 status to indicate that the Notification was received successfully.\n"}],"pointer":"/paths/checkoutsessions-notification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout-sessions/checkoutsessionsnotification"}],"panels":[]}]},"httpPath":"checkoutsessions-notification"}],"content":{"contentType":"group","meta":{"name":"Checkout Sessions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checkout Sessions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkoutsessions/create","summary":"Create Checkout Session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checkout-sessions/checkoutsessionscreate","deprecated":false},{"title":"/checkoutsessions/list","summary":"List Checkout Sessions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkout-sessions/checkoutsessionslist","deprecated":false},{"title":"/checkoutsessions/retrieve","summary":"Retrieve Checkout Session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkout-sessions/checkoutsessionsretrieve","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"checkoutsessions-notification","summary":"Checkout Sessions Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checkout-sessions/checkoutsessionsnotification","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DateTime":{"id":"components/schemas/DateTime","kind":"json-schema","title":"DateTime","data":{"type":"string","format":"ISO 8601","example":"2024-05-21T09:18:23.283-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00"},"children":[]}]}]}]}},"components/schemas/CredentialAccessToken":{"id":"components/schemas/CredentialAccessToken","kind":"json-schema","title":"CredentialAccessToken","data":{"type":"string","format":"uuid","maxLength":52,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, which generates an Access Token using an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CredentialAuthToken":{"id":"components/schemas/CredentialAuthToken","kind":"json-schema","title":"CredentialAuthToken","data":{"type":"string","format":"uuid","maxLength":51,"example":"3504489F-A774-88E0-80114FBBC925E207","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique encrypted identifier that refers to a specific merchant account. It is required when making an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request. For detailed information about the AuthToken, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#access-token-exchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]}]}]}},"components/schemas/CredentialClientGuid":{"id":"components/schemas/CredentialClientGuid","kind":"json-schema","title":"CredentialClientGuid","data":{"type":"string","format":"uuid","maxLength":51,"example":"A3B18F21-AD17-8416-0626C4C9F1CA86A7","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Client GUID is a unique identifier that is used to identify an interface across all of the merchant accounts that use it. The same Client GUID can be used for all versions of the same interface. If a completely new interface is certified, then you will receive a new Client GUID, which must be hard coded into the application and must not be a configurable field. The Client GUID is required when making an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/credentials/accesstokenexchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Token Exchange"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For detailed information about the Client GUID, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/quickstart#access-token-exchange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement: The Client GUID supplied by your API Analyst must be hard coded into your application because it will permanently identify your interface across all merchant accounts."},"children":[]}]}]}]}]}},"components/schemas/CredentialApiSerialNumber":{"id":"components/schemas/CredentialApiSerialNumber","kind":"json-schema","title":"CredentialApiSerialNumber","data":{"type":"string","maxLength":10,"example":"266","readOnly":true,"description":"The serial number for the merchant account. This field is only used for backwards compatibility with older interfaces and has been replaced by the Access Token.\n"}},"components/schemas/CredentialApiPassword":{"id":"components/schemas/CredentialApiPassword","kind":"json-schema","title":"CredentialApiPassword","data":{"type":"string","maxLength":32,"example":"9YCR23G7%BY#9+","readOnly":true,"description":"A credential used to authenticate the API Serial Number when processing a request. This field is only used for backwards compatibility with older interfaces and has been replaced by the Access Token.\n"}},"components/schemas/Credential":{"id":"components/schemas/Credential","kind":"json-schema","title":"Credential","data":{"type":"object","required":["authToken","clientGuid"],"properties":{"accessToken":{"$ref":"#/components/schemas/CredentialAccessToken"},"authToken":{"$ref":"#/components/schemas/CredentialAuthToken"},"clientGuid":{"$ref":"#/components/schemas/CredentialClientGuid"},"apiSerialNumber":{"$ref":"#/components/schemas/CredentialApiSerialNumber"},"apiPassword":{"$ref":"#/components/schemas/CredentialApiPassword"}}}},"components/schemas/ServerName":{"id":"components/schemas/ServerName","kind":"json-schema","title":"ServerName","data":{"type":"string","maxLength":50,"example":"TM01CE","description":"The name of the server that processed the request.\n"}},"components/schemas/Server":{"id":"components/schemas/Server","kind":"json-schema","title":"Server","data":{"type":"object","readOnly":true,"properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"components/schemas/ErrorCode":{"id":"components/schemas/ErrorCode","kind":"json-schema","title":"ErrorCode","data":{"type":"integer","maxLength":5,"readOnly":true,"example":64100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the type of error that occurred. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This is currently only supported for European merchant processing."},"children":[]}]}]}]}]}},"components/schemas/ErrorSeverity":{"id":"components/schemas/ErrorSeverity","kind":"json-schema","title":"ErrorSeverity","data":{"type":"string","enum":["Info","Error","Alert"],"readOnly":true,"example":"Info","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Severity level of the error."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Severity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Info"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action not required - Data input/formatting is incorrect"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action may be required - Communication, timeout or network issue"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action required - System issue"},"children":[]}]}]}]}]}]}]}},"components/schemas/ErrorShortText":{"id":"components/schemas/ErrorShortText","kind":"json-schema","title":"ErrorShortText","data":{"type":"string","maxLength":16,"readOnly":true,"example":"NOT IN CARDRANGE","description":"Abbreviated error message that is always returned if an error condition exists\n"}},"components/schemas/ErrorLongText":{"id":"components/schemas/ErrorLongText","kind":"json-schema","title":"ErrorLongText","data":{"type":"string","maxLength":255,"readOnly":true,"example":"Card type not recognized","description":"Extended error message that is returned if an error condition exists.\n"}},"components/schemas/ErrorPrimaryCode":{"id":"components/schemas/ErrorPrimaryCode","kind":"json-schema","title":"ErrorPrimaryCode","data":{"type":"integer","maxLength":4,"readOnly":true,"example":9842,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the type of error that occurred. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more details."},"children":[]}]}]}]}},"components/schemas/ErrorSecondaryCode":{"id":"components/schemas/ErrorSecondaryCode","kind":"json-schema","title":"ErrorSecondaryCode","data":{"type":"integer","maxLength":4,"readOnly":true,"example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code supplements the code specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.primaryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to provide additional information about the error that occurred."},"children":[]}]}]}]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"severity":{"$ref":"#/components/schemas/ErrorSeverity"},"shortText":{"$ref":"#/components/schemas/ErrorShortText"},"longText":{"$ref":"#/components/schemas/ErrorLongText"},"primaryCode":{"$ref":"#/components/schemas/ErrorPrimaryCode"},"secondaryCode":{"$ref":"#/components/schemas/ErrorSecondaryCode"}}}},"components/schemas/LighthouseDataResponse":{"id":"components/schemas/LighthouseDataResponse","kind":"json-schema","title":"LighthouseDataResponse","data":{"type":"string","example":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9","description":"Base64 encoded JSON formatted data that will be returned from Lighthouse to be passed back to SkyTab. This data will contain variable information.\n"}},"components/schemas/AmountTotal":{"id":"components/schemas/AmountTotal","kind":"json-schema","title":"AmountTotal","data":{"type":"number","maxLength":14,"example":160,"description":"The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.\n"}},"components/schemas/AmountTax":{"id":"components/schemas/AmountTax","kind":"json-schema","title":"AmountTax","data":{"type":"number","maxLength":14,"example":15,"description":"The amount of sales tax charged for a transaction. The tax amount is used by businesses to track tax expenses for accounting purposes. Identifying the tax amount also helps consumers understand the total amount that they were billed.  This field is part of Level 2 card data.\n"}},"components/schemas/AmountTaxIndicator":{"id":"components/schemas/AmountTaxIndicator","kind":"json-schema","title":"AmountTaxIndicator","data":{"type":"string","maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax is included"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax is not included"},"children":[]}]}]}]}]}]}]}},"components/schemas/AmountCashback":{"id":"components/schemas/AmountCashback","kind":"json-schema","title":"AmountCashback","data":{"type":"number","maxLength":14,"example":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the cashback amount in a transaction. When using a UTG-controlled PIN pad with the ALLOWCASHBACK API Option, this field will return the cashback amount requested by the consumer. The interface can also send the desired cashback amount in a request by adding it to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and including it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.cashback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. This will bypass prompting the consumer for a cashback amount."},"children":[]}]}]}]}},"components/schemas/IIASAmount":{"id":"components/schemas/IIASAmount","kind":"json-schema","title":"IIASAmount","data":{"type":"number","maxLength":14,"example":34,"description":"The subtotal for this type of healthcare expenses.\n"}},"components/schemas/IIASType":{"id":"components/schemas/IIASType","kind":"json-schema","title":"IIASType","data":{"type":"string","minLength":2,"maxLength":2,"example":"4T","enum":["4O","4S","4T","4U","4V","4W","4X"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code classifies eligible healthcare expenses."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash Disbursement (Discover Only) – Amount of Cash Back Being Requested"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare (Visa/MC Only) – Qualified Medical Expenses or Over-the-Counter"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4T"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transit (Visa Only) – Transit Fare Media (e.g., Commuter and Parking Passes, Mass Transit Vouchers, and Tickets)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RX (Visa/MC Only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4V"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vision (Visa Only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4W"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clinical (Visa Only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dental (Visa Only)"},"children":[]}]}]}]}]}]}]}},"components/schemas/IIASAmounts":{"id":"components/schemas/IIASAmounts","kind":"json-schema","title":"IIASAmounts","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/IIASAmount"},"type":{"$ref":"#/components/schemas/IIASType"}}}},"components/schemas/IIASAmountsArray":{"id":"components/schemas/IIASAmountsArray","kind":"json-schema","title":"IIASAmountsArray","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/IIASAmounts"},"example":[{"type":"4S","amount":75},{"type":"4W","amount":25}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the request if processing for a health care merchant."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Vision related charges you must send only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iiasAmounts.type = 4V"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iiasAmounts.amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other charges, the first entry in the array should have an amount representing the total of all healthcare costs, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iiasAmounts.type = 4S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Any subsequent entries should contain the subtotal for each of the other expense types involved in this transaction."},"children":[]}]}]}]}},"components/schemas/AmountTip":{"id":"components/schemas/AmountTip","kind":"json-schema","title":"AmountTip","data":{"type":"number","maxLength":14,"example":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the request if a tip is included."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tip amount of the transaction."},"children":[]}]}]}]}},"components/schemas/AmountCheckTotal":{"id":"components/schemas/AmountCheckTotal","kind":"json-schema","title":"AmountCheckTotal","data":{"type":"number","maxLength":14,"writeOnly":true,"example":200,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field specifying the total amount of the entire bill/invoice that this transaction is part of. It can be larger than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in scenarios where the check is being split or if a portion of the check was already paid in cash or another form of payment."},"children":[]}]}]}]}},"components/schemas/AmountObjectNoSurcharge":{"id":"components/schemas/AmountObjectNoSurcharge","kind":"json-schema","title":"AmountObjectNoSurcharge","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with a $20 tip and $8 tax would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"128.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount  fields can specify up to three decimal places. However, the number of decimal  places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total","tax"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"taxIndicator":{"$ref":"#/components/schemas/AmountTaxIndicator"},"cashback":{"$ref":"#/components/schemas/AmountCashback"},"iiasAmounts":{"$ref":"#/components/schemas/IIASAmountsArray"},"tip":{"$ref":"#/components/schemas/AmountTip"},"checkTotal":{"$ref":"#/components/schemas/AmountCheckTotal"}}}},"components/schemas/ClerkNumericId":{"id":"components/schemas/ClerkNumericId","kind":"json-schema","title":"ClerkNumericId","data":{"type":"integer","maxLength":5,"example":1576,"description":"A number used to identify the point-of-sale (POS) or property management system (PMS) clerk or user. The value cannot be 0. An interface must be able to dynamically populate this field (not use a hardcoded value), unless the interface will be used exclusively for e-commerce.\n"}},"components/schemas/Clerk":{"id":"components/schemas/Clerk","kind":"json-schema","title":"Clerk","data":{"type":"object","required":["numericId"],"properties":{"numericId":{"$ref":"#/components/schemas/ClerkNumericId"}}}},"components/schemas/TransactionInvoice":{"id":"components/schemas/TransactionInvoice","kind":"json-schema","title":"TransactionInvoice","data":{"type":"string","maxLength":10,"example":"0510093358","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10-digit invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For US and Canadian processing: Although the invoice number is sent as a JSON string it is a numeric value. No alpha characters are allowed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For processing outside of the US and Canada alpha characters are allowed."},"children":[]}]}]}]}]}},"components/schemas/TransactionNotes":{"id":"components/schemas/TransactionNotes","kind":"json-schema","title":"TransactionNotes","data":{"type":"string","maxLength":4096,"example":"Transaction notes are added here","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A free-form notes field that supports the use of HTML tags.  This can be used for reference in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ltm.shift4test.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lighthouse Transaction Manager"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is not sent to the authorization host. Escaped quotation marks should not be sent in the Notes field."},"children":[]}]}]}]}},"components/schemas/TransactionBusinessDate":{"id":"components/schemas/TransactionBusinessDate","kind":"json-schema","title":"TransactionBusinessDate","data":{"type":"string","format":"ISO 8601","minLength":10,"example":"2021-04-15","description":"Desired business date of a transaction. Include when overriding the existing business date of a transaction. The overriding date may be earlier or later than the existing date. (yyyy-mm-dd)\n"}},"components/schemas/AmexPropertyCode":{"id":"components/schemas/AmexPropertyCode","kind":"json-schema","title":"AmexPropertyCode","data":{"type":"string","maxLength":15,"example":"21546782948","description":"The code that contains a Merchant-assigned store or location number (or name) that uniquely identifies where the transaction took place.\n"}},"components/schemas/TransactionAmex":{"id":"components/schemas/TransactionAmex","kind":"json-schema","title":"TransactionAmex","data":{"type":"object","properties":{"propertyCode":{"$ref":"#/components/schemas/AmexPropertyCode"}}}},"components/schemas/AutoEstimatedDays":{"id":"components/schemas/AutoEstimatedDays","kind":"json-schema","title":"AutoEstimatedDays","data":{"type":"integer","maxLength":2,"example":5,"description":"Estimated contract length of car rental.\n"}},"components/schemas/AutoCheckIn":{"id":"components/schemas/AutoCheckIn","kind":"json-schema","title":"AutoCheckIn","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Auto Rental transactions"},"children":[]}]}]}]}],"properties":{"estimatedDays":{"$ref":"#/components/schemas/AutoEstimatedDays"}}}},"components/schemas/AirlineCarrierCode":{"id":"components/schemas/AirlineCarrierCode","kind":"json-schema","title":"AirlineCarrierCode","data":{"type":"string","maxLength":4,"example":"5472","description":"The code of the airline carrier issuing the ticket.\n"}},"components/schemas/AirlineCarrierName":{"id":"components/schemas/AirlineCarrierName","kind":"json-schema","title":"AirlineCarrierName","data":{"type":"string","maxLength":19,"example":"American Airlines","description":"The name of the airline carrier issuing the ticket.\n"}},"components/schemas/AirlineConjunctionTicketIndicator":{"id":"components/schemas/AirlineConjunctionTicketIndicator","kind":"json-schema","title":"AirlineConjunctionTicketIndicator","data":{"type":"string","maxLength":1,"enum":["Y","N"],"example":"N","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the itinerary contains more than four segments of travel."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineDocumentType":{"id":"components/schemas/AirlineDocumentType","kind":"json-schema","title":"AirlineDocumentType","data":{"type":"string","maxLength":2,"enum":["01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","41","42","43","44","45","46","47","48","49","50","51","52","60","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93"],"example":"93","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the airline Document Type code, which indicates the purpose of this transaction. This information may appear on the descriptive bill on the Cardmember's statement, or be used to resolve billing inquiries and disputes. The codes entered in the Transaction Type and Document Type fields are used together to describe the purpose of this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passenger Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Collection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Excess Baggage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Misc. Charge Order (MCO) / Prepaid Ticket Auth"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Service Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lost Ticket Application"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"09"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tour Order Voucher"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket by Mail"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Undercharge Adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"14"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPD/Air Freight"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-flight Adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency Passenger Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"17"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency Tour Order/Voucher"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"18"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency Misc. Charge Order (MCO)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"19"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency Exchange Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency Group Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit Adjustment Duplicate Refund/Use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-flight Merchandise Ordered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"23"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogue Merchandise Ordered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-flight Phone Charges"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"25"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Flyer Fee/Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"26"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kennel Charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"27"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Animal Transportation Charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"28"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firearms Case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"29"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upgrade Charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Unused Transportation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"31"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Class of Service Adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"32"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Denied Boarding"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Misc. Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"34"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Lost Ticket Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"35"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Exchange Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"36"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Overcharge Adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"37"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Multiple Unused Tickets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"38"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"39"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Self-Service Ticket(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-flight Duty Free Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"42"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Senior Citizen Discount Booklets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Club Membership Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"44"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupon Book"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"45"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-flight Charges"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"46"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tour Deposit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"47"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Flyer Overnight Delivery Charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"48"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Flyer Fulfillment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"49"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Small Package Delivery"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vendor Sale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"51"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous Tax(es) Fee(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"52"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Agency Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vendor Refund Credit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duty Free Sale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"65"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred Seat Upgrade"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"66"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cabin Upgrade"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"67"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lounge/Club Access or Day Pass"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"68"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agent Assisted Reservation. Ticketing Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"69"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket Change or Cancel Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"70"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip Insurance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"71"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unaccompanied Minor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"72"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standby Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"73"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Curbside Baggage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"74"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inflight Medical Equipment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"75"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket or Pass Print Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"76"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checked Sporting/Special Equipment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"77"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dry Ice Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"78"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail/Postage Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"79"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Club Membership Fee - Temporary/Trial"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"80"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Flyer Activation/Reinstatement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"81"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Certificate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"82"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboard/Inflight Prepaid Voucher"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"83"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional Services Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"84"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced Purchase - Excess Baggage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"85"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced Purchase - Preferred Seat Upgrade"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"86"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced Purchase - Cabin Upgrade"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"87"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced Purchase - Optional Services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"88"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WiFi"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"89"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packages"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inflight Entertainment/Internet Access"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overweight Bag Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sleep Sets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"93"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Purchase Fee"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineElectronicTicketIndicator":{"id":"components/schemas/AirlineElectronicTicketIndicator","kind":"json-schema","title":"AirlineElectronicTicketIndicator","data":{"type":"string","maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if an electronic ticket was issued."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineInternetIndicator":{"id":"components/schemas/AirlineInternetIndicator","kind":"json-schema","title":"AirlineInternetIndicator","data":{"type":"string","maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if this is an internet transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineIssueDate":{"id":"components/schemas/AirlineIssueDate","kind":"json-schema","title":"AirlineIssueDate","data":{"type":"string","format":"ISO 8601","example":"2021-04-12T15:39:01.594-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the ticket was issued to the customer. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/AirlineNumberOfCities":{"id":"components/schemas/AirlineNumberOfCities","kind":"json-schema","title":"AirlineNumberOfCities","data":{"type":"number","maxLength":2,"example":5,"description":"The number of airports or cities for each leg on the ticket (including origination and destination cities).\n"}},"components/schemas/AirlineNumberOfCarriers":{"id":"components/schemas/AirlineNumberOfCarriers","kind":"json-schema","title":"AirlineNumberOfCarriers","data":{"type":"number","maxLength":2,"example":5,"description":"This field contains the number of airline carriers.\n"}},"components/schemas/AirlineNumberOfPassengers":{"id":"components/schemas/AirlineNumberOfPassengers","kind":"json-schema","title":"AirlineNumberOfPassengers","data":{"type":"number","maxLength":3,"example":5,"description":"The number of passengers in the transaction.\n"}},"components/schemas/AirlinePassengerArrivalDate":{"id":"components/schemas/AirlinePassengerArrivalDate","kind":"json-schema","title":"AirlinePassengerArrivalDate","data":{"type":"string","format":"ISO 8601","example":"2021-04-14T15:39:01.594-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date that the ticket holder is scheduled to arrive at their destination at the time of issuance of the original ticket. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/AirlinePassengerDepartureDate":{"id":"components/schemas/AirlinePassengerDepartureDate","kind":"json-schema","title":"AirlinePassengerDepartureDate","data":{"type":"string","format":"ISO 8601","example":"2021-04-13T15:39:01.594-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date that the ticket holder is scheduled to depart at the time of issuance of the original ticket. The date may be a future one.  The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/AirlinePassengerNameRecord":{"id":"components/schemas/AirlinePassengerNameRecord","kind":"json-schema","title":"AirlinePassengerNameRecord","data":{"type":"string","maxLength":6,"example":"MXCTIF","description":"A passenger name record (PNR) is a record in the database of a computer reservation system (CRS) that contains the itinerary for a passenger or a group of passengers travelling together\n"}},"components/schemas/AirlineRestrictedTicketIndicator":{"id":"components/schemas/AirlineRestrictedTicketIndicator","kind":"json-schema","title":"AirlineRestrictedTicketIndicator","data":{"type":"string","maxLength":1,"example":"1","enum":["0","1"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this ticket is non-refundable."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No restriction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricted (non-refundable) ticket"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineTicketChangeIndicator":{"id":"components/schemas/AirlineTicketChangeIndicator","kind":"json-schema","title":"AirlineTicketChangeIndicator","data":{"type":"string","maxLength":1,"enum":["C","N"],"example":"C","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates why a ticket was changed.  This field should contain spaces or one of the below codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change to existing ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New ticket"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineTicketTranType":{"id":"components/schemas/AirlineTicketTranType","kind":"json-schema","title":"AirlineTicketTranType","data":{"type":"string","maxLength":3,"enum":["TKT","REF","EXC","MSC"],"example":"TKT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the ticket transaction type code assigned to this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TKT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket Purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Ticket"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MSC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only)"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineTypeIndicator":{"id":"components/schemas/AirlineTypeIndicator","kind":"json-schema","title":"AirlineTypeIndicator","data":{"type":"string","maxLength":1,"enum":["R","O","M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if this ticket is a round trip, multi-city, or one-way ticket."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Round-Trip"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One Way"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-City"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineTicketsPassengerName":{"id":"components/schemas/AirlineTicketsPassengerName","kind":"json-schema","title":"AirlineTicketsPassengerName","data":{"type":"string","maxLength":40,"example":"Doe Jane M Mrs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the passenger to whom the ticket was issued.  This field contains the Passenger Name in format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SURNAME FIRSTNAME MIDDLEINITIAL TITLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: \"Doe Jane M Mrs\""},"children":[]}]}]}]}},"components/schemas/AirlineTicketsTicketNumber":{"id":"components/schemas/AirlineTicketsTicketNumber","kind":"json-schema","title":"AirlineTicketsTicketNumber","data":{"type":"string","maxLength":15,"example":"344567890234567","description":"The ticket number provided by the Carrier for the passenger.\n"}},"components/schemas/AirlineTicketsTicketFare":{"id":"components/schemas/AirlineTicketsTicketFare","kind":"json-schema","title":"AirlineTicketsTicketFare","data":{"type":"number","maxLength":14,"example":350,"description":"Ticket fare is the total amount for each ticket, including service fee or any other fee for each ticket.\n"}},"components/schemas/AirlineTickets":{"id":"components/schemas/AirlineTickets","kind":"json-schema","title":"AirlineTickets","data":{"type":"object","required":["passengerName","ticketNumber","ticketFare"],"properties":{"passengerName":{"$ref":"#/components/schemas/AirlineTicketsPassengerName"},"ticketNumber":{"$ref":"#/components/schemas/AirlineTicketsTicketNumber"},"ticketFare":{"$ref":"#/components/schemas/AirlineTicketsTicketFare"}}}},"components/schemas/AirlineTicketsArray":{"id":"components/schemas/AirlineTicketsArray","kind":"json-schema","title":"AirlineTicketsArray","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/AirlineTickets"},"example":[{"ticketNumber":412345678901234,"passengerName":"Jane Doe","ticketFare":350},{"ticketNumber":412345678901236,"passengerName":"John Smith","ticketFare":250}],"description":"Array of ticket number and passenger name. Note: At least one instance of ticket number and passenger name info should be provided.\n"}},"components/schemas/AirlineFlightLegsCarrierCode":{"id":"components/schemas/AirlineFlightLegsCarrierCode","kind":"json-schema","title":"AirlineFlightLegsCarrierCode","data":{"type":"string","maxLength":2,"example":"DL","description":"Code indicating name of carrier (United Airlines, Jet Blue, etc.) for the leg.\n"}},"components/schemas/AirlineFlightLegsCouponNumber":{"id":"components/schemas/AirlineFlightLegsCouponNumber","kind":"json-schema","title":"AirlineFlightLegsCouponNumber","data":{"type":"number","maxLength":1,"example":1,"description":"Number of coupons in the ticket for the leg.\n"}},"components/schemas/AirlineFlightLegsDestAirportCode":{"id":"components/schemas/AirlineFlightLegsDestAirportCode","kind":"json-schema","title":"AirlineFlightLegsDestAirportCode","data":{"type":"string","maxLength":5,"example":"YXX","description":"Indicates destination city's airport code for the leg.\n"}},"components/schemas/AirlineFlightLegsFare":{"id":"components/schemas/AirlineFlightLegsFare","kind":"json-schema","title":"AirlineFlightLegsFare","data":{"type":"number","maxLength":14,"example":300,"description":"This field contains the total Fare for this trip segment. This is not the total amount billed to the customer.\n"}},"components/schemas/AirlineFlightLegsFareBasis":{"id":"components/schemas/AirlineFlightLegsFareBasis","kind":"json-schema","title":"AirlineFlightLegsFareBasis","data":{"type":"string","maxLength":24,"example":"YE3MAU","description":"This field contains primary and secondary discount codes that indicate the class of service and fare level associated with the ticket for the leg. Truncate at 24 bytes, if necessary.\n"}},"components/schemas/AirlineFlightLegsFlightNumber":{"id":"components/schemas/AirlineFlightLegsFlightNumber","kind":"json-schema","title":"AirlineFlightLegsFlightNumber","data":{"type":"string","maxLength":5,"example":"2490","description":"Number of the airline flight to be taken on Leg of the trip.\n"}},"components/schemas/AirlineFlightLegsLegArrivalDateTime":{"id":"components/schemas/AirlineFlightLegsLegArrivalDateTime","kind":"json-schema","title":"AirlineFlightLegsLegArrivalDateTime","data":{"type":"string","format":"ISO 8601","example":"2021-04-15T09:18:23.283-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the flight is scheduled to arrive for the leg. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/AirlineFlightLegsLegDepartureDateTime":{"id":"components/schemas/AirlineFlightLegsLegDepartureDateTime","kind":"json-schema","title":"AirlineFlightLegsLegDepartureDateTime","data":{"type":"string","format":"ISO 8601","example":"2021-04-12T15:39:01.594-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time the flight is scheduled to depart for the leg. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/AirlineFlightLegsOriginAirportCode":{"id":"components/schemas/AirlineFlightLegsOriginAirportCode","kind":"json-schema","title":"AirlineFlightLegsOriginAirportCode","data":{"type":"string","maxLength":5,"example":"AUH","description":"Indicates origination city's airport code for the leg.\n"}},"components/schemas/AirlineFlightLegsServiceClass":{"id":"components/schemas/AirlineFlightLegsServiceClass","kind":"json-schema","title":"AirlineFlightLegsServiceClass","data":{"type":"string","maxLength":2,"example":"FC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates service class for leg."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First Class"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Class"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Economy/Coach Class"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineFlightLegsStopOverCode":{"id":"components/schemas/AirlineFlightLegsStopOverCode","kind":"json-schema","title":"AirlineFlightLegsStopOverCode","data":{"type":"string","maxLength":1,"example":"X","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a stopover is allowed on this ticket for leg. The entry must be a D, O, or X."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopover allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopover not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination point"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineFlightLegsTripLegInfo":{"id":"components/schemas/AirlineFlightLegsTripLegInfo","kind":"json-schema","title":"AirlineFlightLegsTripLegInfo","data":{"type":"string","maxLength":35,"example":"Trip Leg Info 1","description":"Description of leg or stage of trip.\n"}},"components/schemas/AirlineFlightLegs":{"id":"components/schemas/AirlineFlightLegs","kind":"json-schema","title":"AirlineFlightLegs","data":{"type":"object","required":["carrierCode","destAirportCode","fare","fareBasis","flightNumber","legArrivalDateTime","legDepartureDateTime","originAirportCode","serviceClass","stopOverCode","tripLegInfo"],"properties":{"carrierCode":{"$ref":"#/components/schemas/AirlineFlightLegsCarrierCode"},"couponNumber":{"$ref":"#/components/schemas/AirlineFlightLegsCouponNumber"},"destAirportCode":{"$ref":"#/components/schemas/AirlineFlightLegsDestAirportCode"},"fare":{"$ref":"#/components/schemas/AirlineFlightLegsFare"},"fareBasis":{"$ref":"#/components/schemas/AirlineFlightLegsFareBasis"},"flightNumber":{"$ref":"#/components/schemas/AirlineFlightLegsFlightNumber"},"legArrivalDateTime":{"$ref":"#/components/schemas/AirlineFlightLegsLegArrivalDateTime"},"legDepartureDateTime":{"$ref":"#/components/schemas/AirlineFlightLegsLegDepartureDateTime"},"originAirportCode":{"$ref":"#/components/schemas/AirlineFlightLegsOriginAirportCode"},"serviceClass":{"$ref":"#/components/schemas/AirlineFlightLegsServiceClass"},"stopOverCode":{"$ref":"#/components/schemas/AirlineFlightLegsStopOverCode"},"tripLegInfo":{"$ref":"#/components/schemas/AirlineFlightLegsTripLegInfo"}}}},"components/schemas/AirlineFlightLegsArray":{"id":"components/schemas/AirlineFlightLegsArray","kind":"json-schema","title":"AirlineFlightLegsArray","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/AirlineFlightLegs"},"example":[{"tripLegInfo":"Trip Leg Info 1","couponNumber":1,"legDepartureDateTime":"2021-04-12T15:39:01.594-07:00","legArrivalDateTime":"2021-04-15T09:18:23.283-07:00","fare":300},{"tripLegInfo":"Trip Leg Info 2","couponNumber":2,"legDepartureDateTime":"2021-04-12T15:39:01.594-07:00","legArrivalDateTime":"2021-04-15T09:18:23.283-07:00","fare":500}],"description":"Array of flight trip leg info. Maximun 4 legs to a trip allowed. Note: At least one instance of flight trip leg info should be provided.\n"}},"components/schemas/AirlineAncillaryServicesServiceCode":{"id":"components/schemas/AirlineAncillaryServicesServiceCode","kind":"json-schema","title":"AirlineAncillaryServicesServiceCode","data":{"type":"string","enum":["BF","BG","CF","CG","CO","FF","GF","GT","IE","LG","MD","ML","OT","PA","PT","SA","SB","SF","ST","TS","UN","UP","WI"],"maxLength":2,"example":"BF","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field describes the type of service that has been provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundled Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Baggage Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cargo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CO"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carbon Offset"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequent Flyer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ground Transport"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-Flight Entertainment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lounge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medical"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ML"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meal/Beverage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passenger Assist Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat Fees"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standby"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Fee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unaccompanied Travel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upgrades"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wi-Fi"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineAncillaryServicesServiceFee":{"id":"components/schemas/AirlineAncillaryServicesServiceFee","kind":"json-schema","title":"AirlineAncillaryServicesServiceFee","data":{"type":"number","maxLength":14,"example":2,"description":"This field contains the amount associated with the value provided in ancillary Service Code.\n"}},"components/schemas/AirlineAncillaryServices":{"id":"components/schemas/AirlineAncillaryServices","kind":"json-schema","title":"AirlineAncillaryServices","data":{"type":"object","required":["serviceCode","serviceFee"],"properties":{"serviceCode":{"$ref":"#/components/schemas/AirlineAncillaryServicesServiceCode"},"serviceFee":{"$ref":"#/components/schemas/AirlineAncillaryServicesServiceFee"}}}},"components/schemas/AirlineAncillaryServicesArray":{"id":"components/schemas/AirlineAncillaryServicesArray","kind":"json-schema","title":"AirlineAncillaryServicesArray","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/AirlineAncillaryServices"},"example":[{"serviceCode":"BF","serviceFee":2},{"serviceCode":"BG","serviceFee":3}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of ancillary service code and fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send if any ancillary services were charged."},"children":[]}]}]}]}]}},"components/schemas/AirlineTravelAgencyCode":{"id":"components/schemas/AirlineTravelAgencyCode","kind":"json-schema","title":"AirlineTravelAgencyCode","data":{"type":"string","maxLength":8,"example":"05172343","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code identifying travel agency if the ticket was issued by a travel agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send if a travel agency service was used."},"children":[]}]}]}]}]}},"components/schemas/AirlineTravelAgencyName":{"id":"components/schemas/AirlineTravelAgencyName","kind":"json-schema","title":"AirlineTravelAgencyName","data":{"type":"string","maxLength":25,"example":"State Travel","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of travel agency if the ticket was issued by a travel agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send if a travel agency service was used."},"children":[]}]}]}]}]}},"components/schemas/AirlineExchangeTicketNumber":{"id":"components/schemas/AirlineExchangeTicketNumber","kind":"json-schema","title":"AirlineExchangeTicketNumber","data":{"type":"string","maxLength":15,"example":"507212345678768","description":"The original ticket number that was replaced by a new ticket number.\n"}},"components/schemas/AirlineRequest":{"id":"components/schemas/AirlineRequest","kind":"json-schema","title":"AirlineRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Airline transactions in Authorization/Sale requests when possible. If unable to provide this data at Authorization, this object must be sent in subsequent Capture requests for the transaction."},"children":[]}]}]}]}],"required":["carrierCode","carrierName","conjunctionTicketIndicator","documentType","electronicTicketIndicator","internetIndicator","issueDate","numberOfCities","numberOfCarriers","numberOfPassengers","passengerArrivalDate","passengerDepartureDate","passengerNameRecord","restrictedTicketIndicator","ticketChangeIndicator","ticketTranType","tickets","flightLegs","typeIndicator"],"properties":{"carrierCode":{"$ref":"#/components/schemas/AirlineCarrierCode"},"carrierName":{"$ref":"#/components/schemas/AirlineCarrierName"},"conjunctionTicketIndicator":{"$ref":"#/components/schemas/AirlineConjunctionTicketIndicator"},"documentType":{"$ref":"#/components/schemas/AirlineDocumentType"},"electronicTicketIndicator":{"$ref":"#/components/schemas/AirlineElectronicTicketIndicator"},"internetIndicator":{"$ref":"#/components/schemas/AirlineInternetIndicator"},"issueDate":{"$ref":"#/components/schemas/AirlineIssueDate"},"numberOfCities":{"$ref":"#/components/schemas/AirlineNumberOfCities"},"numberOfCarriers":{"$ref":"#/components/schemas/AirlineNumberOfCarriers"},"numberOfPassengers":{"$ref":"#/components/schemas/AirlineNumberOfPassengers"},"passengerArrivalDate":{"$ref":"#/components/schemas/AirlinePassengerArrivalDate"},"passengerDepartureDate":{"$ref":"#/components/schemas/AirlinePassengerDepartureDate"},"passengerNameRecord":{"$ref":"#/components/schemas/AirlinePassengerNameRecord"},"restrictedTicketIndicator":{"$ref":"#/components/schemas/AirlineRestrictedTicketIndicator"},"ticketChangeIndicator":{"$ref":"#/components/schemas/AirlineTicketChangeIndicator"},"ticketTranType":{"$ref":"#/components/schemas/AirlineTicketTranType"},"typeIndicator":{"$ref":"#/components/schemas/AirlineTypeIndicator"},"tickets":{"$ref":"#/components/schemas/AirlineTicketsArray"},"flightLegs":{"$ref":"#/components/schemas/AirlineFlightLegsArray"},"ancillaryServices":{"$ref":"#/components/schemas/AirlineAncillaryServicesArray"},"travelAgencyCode":{"$ref":"#/components/schemas/AirlineTravelAgencyCode"},"travelAgencyName":{"$ref":"#/components/schemas/AirlineTravelAgencyName"},"exchangeTicketNumber":{"$ref":"#/components/schemas/AirlineExchangeTicketNumber"}}}},"components/schemas/CardOnFileType":{"id":"components/schemas/CardOnFileType","kind":"json-schema","title":"CardOnFileType","data":{"type":"string","enum":["S01","S02","U01","U02","U03","U04","U05","U06","U07","U08","U09"],"example":"S01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the type of the card-on-file transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is a table showing the valid values for use cases where the cardholder is entering their card data to store on file."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when the initial transaction/card verification request is not for a recurring payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when the initial transaction/card verification request is for a recurring payment. Requires sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOnFile.recurringFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOnFile.recurringExpiry"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is a table showing the valid values for uses cases where you already have a card on file and are using that existing card to process a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unscheduled transaction using the card on file initiated by the cardholder"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unscheduled transaction using the card on file initiated by the merchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant initiated recurring payment using the card on file"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as a Reauthorization COF transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as a Resubmission COF transaction. Only certain merchant categories are able to send a resubmission, and it can only be done if the original authorization attempt was declined due to insufficient funds."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as an Estimated Authorization COF transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as a Delayed Charges COF transaction. For example, a hotel might charge a customer for room damages after the guest has already checked out."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as an Incremental COF transaction. For example, a hotel which authorized a customer’s card for one night at check-in might increase the authorization amount to cover two nights when the customer decides to extend their stay. Shift4 automatically detects this scenario and sends the appropriate value to the processor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U09"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as a No Show COF transaction. For example, a hotel might charge a customer who does not show up for a booked stay."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/card-on-file-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card On File Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for additional details."},"children":[]}]}]}]}},"components/schemas/CardOnFileRecurringExpiry":{"id":"components/schemas/CardOnFileRecurringExpiry","kind":"json-schema","title":"CardOnFileRecurringExpiry","data":{"type":"string","example":"20250401","minLength":8,"maxLength":8,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date after which no further authorizations shall be performed. This field is limited to 8 characters, and the accepted format is YYYYMMDD."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: This field is required if it's the first recurring transaction ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOnFile.type = S02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This field is not needed if the transaction is not recurring or if the transaction is a subsequent recurring transaction."},"children":[]}]}]}]}]}},"components/schemas/CardOnFileRecurringFrequency":{"id":"components/schemas/CardOnFileRecurringFrequency","kind":"json-schema","title":"CardOnFileRecurringFrequency","data":{"type":"string","example":"15","minLength":1,"maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the minimum number of days between authorizations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: 'This field is required if it's the first recurring transaction ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOnFile.type = S02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This field is not needed if the transaction is not recurring or if the transaction is a subsequent recurring transaction."},"children":[]}]}]}]}]}},"components/schemas/CardOnFileTransactionId":{"id":"components/schemas/CardOnFileTransactionId","kind":"json-schema","title":"CardOnFileTransactionId","data":{"type":"string","maxLength":15,"example":"Z62537846172646","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is returned in the initial COF response, and ties subsequent COF transactions to the original authorization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a merchant runs a Sale on a card for the first time, they will receive a transactionId back in the response.  A month later, when the merchant wants to perform an additional Sale with the card on file, they would send a Sale request including the transactionId they received from the first sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent in subsequent COF requests if you are not processing with a Global Token Vault token. If using Global Token Vault tokens then this field is not required"},"children":[]}]}]}]}]}},"components/schemas/CardOnFileTransactionLinkId":{"id":"components/schemas/CardOnFileTransactionLinkId","kind":"json-schema","title":"CardOnFileTransactionLinkId","data":{"type":"string","maxLength":22,"example":"Z871868461726461879548","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to each transaction to link related events throughout the transaction lifecycle. This field is supported for Mastercard brand only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a merchant runs a Sale on a card for the first time, they will receive a transactionLinkId back in the response.  A month later, when the merchant wants to perform an additional Sale with the card on file, they would send a Sale request including the transactionLinkId they received from the first sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent in subsequent COF requests if you are not processing with a Global Token Vault token. If using Global Token Vault tokens then this field is not required"},"children":[]}]}]}]}]}},"components/schemas/CardOnFile":{"id":"components/schemas/CardOnFile","kind":"json-schema","title":"CardOnFile","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send this object when the transaction being performed is using a card on file or when the request will result in storing a card on file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/card-on-file-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card On File Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/CardOnFileType"},"recurringExpiry":{"$ref":"#/components/schemas/CardOnFileRecurringExpiry"},"recurringFrequency":{"$ref":"#/components/schemas/CardOnFileRecurringFrequency"},"transactionId":{"$ref":"#/components/schemas/CardOnFileTransactionId"},"transactionLinkId":{"$ref":"#/components/schemas/CardOnFileTransactionLinkId"}}}},"components/schemas/HotelEstimatedDays":{"id":"components/schemas/HotelEstimatedDays","kind":"json-schema","title":"HotelEstimatedDays","data":{"type":"integer","maxLength":2,"example":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to communicate the estimated number of days of a guest’s stay. This value is included in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionsauthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request for a consumer’s hotel stay."},"children":[]}]}]}]}},"components/schemas/HotelCheckIn":{"id":"components/schemas/HotelCheckIn","kind":"json-schema","title":"HotelCheckIn","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Hotel transactions"},"children":[]}]}]}]}],"properties":{"estimatedDays":{"$ref":"#/components/schemas/HotelEstimatedDays"}}}},"components/schemas/PurchaseCardCustomerReference":{"id":"components/schemas/PurchaseCardCustomerReference","kind":"json-schema","title":"PurchaseCardCustomerReference","data":{"type":"string","maxLength":25,"example":"D019D09309F2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique value used to identify the consumer or transaction. If a merchant has a significant amount of revenue from purchasing card customers, the interface would use this field to collect the consumer’s purchase order or employee identification number. In lodging transactions, this may be unique transaction details, such as a reservation code or third-party booking source.  This field is part of Level 2 card data."},"children":[]}]}]}]}},"components/schemas/PurchaseCardDestinationPostalCode":{"id":"components/schemas/PurchaseCardDestinationPostalCode","kind":"json-schema","title":"PurchaseCardDestinationPostalCode","data":{"type":"string","maxLength":9,"example":"94719","description":"When items are shipped, the ZIP/postal code to which merchandise will be shipped; otherwise, the ZIP/postal code where the goods or services are rendered.  This field is part of Level 2 card data.\n"}},"components/schemas/PurchaseCardProductDescriptors":{"id":"components/schemas/PurchaseCardProductDescriptors","kind":"json-schema","title":"PurchaseCardProductDescriptors","data":{"type":"array","items":{"type":"string"},"maxLength":40,"example":["Hamburger","Fries","Soda","Cookie"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text description of the items purchased or services sold. This can be a generic text description of what the merchant sells (such as “Groceries”) or specific transaction data (such as the name of the item sold). At least one product descriptor field is required in a sale or authorization request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The productDescriptors array is limited to 4 elements. Each element can contain a maximum of 40 characters."},"children":[]}]}]}]}},"components/schemas/PurchaseCard":{"id":"components/schemas/PurchaseCard","kind":"json-schema","title":"PurchaseCard","data":{"type":"object","required":["customerReference","destinationPostalCode","productDescriptors"],"properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"},"destinationPostalCode":{"$ref":"#/components/schemas/PurchaseCardDestinationPostalCode"},"productDescriptors":{"$ref":"#/components/schemas/PurchaseCardProductDescriptors"}}}},"components/schemas/TransactionVendorReference":{"id":"components/schemas/TransactionVendorReference","kind":"json-schema","title":"TransactionVendorReference","data":{"type":"string","maxLength":50,"example":"12382-01","description":"Optional field for information that can be searched in the merchant portal.\n"}},"components/schemas/TransactionAuthType":{"id":"components/schemas/TransactionAuthType","kind":"json-schema","title":"TransactionAuthType","data":{"type":"string","maxLength":2,"enum":["1","2"],"example":"2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the authorization amount can be modified post authorization. Specifying the transaction as a 'Final Authorization' can result in lower transaction rates, however the transaction amount can not be incremented or decremented. It must be captured for the exact amount that it was authorized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not included in the request the transaction will be processed as a 'Pre-Authorization'."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final Authorization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Authorization"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionSource":{"id":"components/schemas/TransactionSource","kind":"json-schema","title":"TransactionSource","data":{"type":"string","minLength":1,"maxLength":2,"example":"6","enum":["6"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent when processing transactions on an unattended device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction source type."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unattended Cardholder Activated Terminal (UCAT)"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionOriginalDate":{"id":"components/schemas/TransactionOriginalDate","kind":"json-schema","title":"TransactionOriginalDate","data":{"type":"string","format":"ISO 8601","example":"2021-04-15T09:18:23.283-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the original transaction request in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an exact match for the value sent in the original transaction request."},"children":[]}]}]}]}},"components/schemas/DeviceTerminalIdComEng":{"id":"components/schemas/DeviceTerminalIdComEng","kind":"json-schema","title":"DeviceTerminalIdComEng","data":{"type":"string","maxLength":32,"example":"1742","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is optional and is for backwards compatibility with existing vendors that are used to processing via UTG controlled devices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since Commerce Engine is running directly on the payment device it does not require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device.terminalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be specified."},"children":[]}]}]}]}},"components/schemas/ReceiptColumns":{"id":"components/schemas/ReceiptColumns","kind":"json-schema","title":"ReceiptColumns","data":{"type":"integer","example":40,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send this field if you want Shift4 to format the receipt text instead of returning individual fields. The value sent will correlate to the column width of the formatted receipt that we return. (This also allows the receipt text to wrap to fit the paper size of the printed receipt.) See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/printing-receipts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Printing Receipts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more information on formatted receipts."},"children":[]}]}]}]}},"components/schemas/StatementSuffix":{"id":"components/schemas/StatementSuffix","kind":"json-schema","title":"StatementSuffix","data":{"type":"string","maxLength":15,"example":"KDNYZUHQ1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom description that will be appended to the merchant name on the customer's statement. For most card brands, the merchant DBA name can be a maximum of 25 characters. Sending this value will cause the merchant name to be truncated to 9 characters. Shift4 will add an asterisk between the merchant name and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementSuffix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, for a merchant named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Joe's Warehouse Emporium"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that processes a transaction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statementSuffix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KDNYZUHQ1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the merchant statement will show as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Joe's War*KDNYZUHQ1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The value that displays on customer statements from card issuers is beyond Shift4's control. We will submit the transaction data as described above, however issuers may modify or truncate that data as they see fit. To best accommodate different issuer limitations, we will truncate the merchant name to the minimum possible value (9 characters) in order to attempt to leave the most room for the statementSuffix to populate on issuer statements."},"children":[]}]}]}]}]}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","format":"ISO 4217 3 Character Alphabetic Code","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction currency code. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This is currently supported when processing for a merchant outside of the US and Canada. If processing for a US or Canadian merchant then this field will be ignored and the transaction will process in the merchant's configured currency."},"children":[]}]}]}]}]}},"components/schemas/CustomerAddressLine1":{"id":"components/schemas/CustomerAddressLine1","kind":"json-schema","title":"CustomerAddressLine1","data":{"type":"string","maxLength":30,"example":"65 Easy St","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder’s street address exactly as it appears on their billing statement. This field is used in AVS."},"children":[]}]}]}]}},"components/schemas/CustomerFirstName":{"id":"components/schemas/CustomerFirstName","kind":"json-schema","title":"CustomerFirstName","data":{"type":"string","maxLength":30,"example":"John","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a consumer’s first name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the response, unless the API Option "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options#usecardname"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USECARDNAME"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the request and a Commerce Engine or UTG-controlled PIN pad is in use. If the interface does not send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, the consumer's name will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object if the name is present in the card's EMV or track data."},"children":[]}]}]}]}},"components/schemas/CustomerMiddleName":{"id":"components/schemas/CustomerMiddleName","kind":"json-schema","title":"CustomerMiddleName","data":{"type":"string","maxLength":30,"example":"Andrew","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a consumer’s middle name."},"children":[]}]}]}]}},"components/schemas/CustomerLastName":{"id":"components/schemas/CustomerLastName","kind":"json-schema","title":"CustomerLastName","data":{"type":"string","maxLength":30,"example":"Smith","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a consumer’s last name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the response, unless the API Option "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options#usecardname"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USECARDNAME"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the request and a Commerce Engine or UTG-controlled PIN pad is in use. If the interface does not send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, the consumer's name will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object if the name is present in the card's EMV or track data."},"children":[]}]}]}]}},"components/schemas/CustomerPostalCode":{"id":"components/schemas/CustomerPostalCode","kind":"json-schema","title":"CustomerPostalCode","data":{"type":"string","minLength":1,"maxLength":9,"example":"65144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder’s ZIP/postal code from their billing statement. This field is used in AVS. Do not include special characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field only allows alphanumeric characters (a-z, A-Z, 0-9). Special characters including - are not allowed. If you are sending in zip+4 you must not include the dash so 89134-1234 would be sent as 891341234"},"children":[]}]}]}]}]}},"components/schemas/CustomerEmailAddress":{"id":"components/schemas/CustomerEmailAddress","kind":"json-schema","title":"CustomerEmailAddress","data":{"type":"string","maxLength":80,"example":"john.smith@email.com","description":"Customer email address.\n"}},"components/schemas/CustomerIpAddress":{"id":"components/schemas/CustomerIpAddress","kind":"json-schema","title":"CustomerIpAddress","data":{"type":"string","maxLength":20,"example":"63.57.84.101","description":"Public source IP Address where the request originates, not the IP Address of the web server.\n"}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"middleName":{"$ref":"#/components/schemas/CustomerMiddleName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}}},"components/schemas/CardPresent":{"id":"components/schemas/CardPresent","kind":"json-schema","title":"CardPresent","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the initial authorization/sale request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a card was present (‘Y’) or not (‘N’) at the time a transaction took place. This should be set appropriately in the initial authorization/sale request.  In subsequent requests, this field should be left blank or should not be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subsequent request here does not apply to the secondary request for card on file type transactions or reuse of the same card. An example of a subsequent request would be a capture after an authorization. You would not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.present"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the capture, which is the subsequent request. Another example is when performing an incremental authorization where you perform an authorization, followed by an incremental authorization then a capture. The second authorization (incremental) and the capture are the subsequent requests where you would not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.present"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CardType":{"id":"components/schemas/CardType","kind":"json-schema","title":"CardType","data":{"type":"string","enum":["CC","DB","GC","HF","PL","YC"],"example":"VS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An abbreviation used to specify the type of card that will be used when processing a transaction.  If an interface sends a value that is not listed here, that value will be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a UTG-controlled device, this value will force a card to process as credit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a UTG-controlled device, this value will force a card to process as debit.  When using a non-UTG-controlled PIN pad, this value must be sent when processing a debit transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HSA/FSA Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Private Label"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IT’S YOUR CARD"},"children":[]}]}]}]}]}]}]}},"components/schemas/ApiOptions":{"id":"components/schemas/ApiOptions","kind":"json-schema","title":"ApiOptions","data":{"type":"array","items":{"type":"string"},"example":["RETURNEXPDATE","ALLOWPARTIALAUTH"],"writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options modify the request being made. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]}},"components/schemas/TipPresetType":{"id":"components/schemas/TipPresetType","kind":"json-schema","title":"TipPresetType","data":{"type":"string","enum":["none","percent","amount"],"example":"percent","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tip option selected by the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Skips the preset screen and goes direclty to the other tip amount screen."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"percent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the preset screen showing preset percentages. Must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display the preset screen showing preset amounts. Must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip.preset3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}},"components/schemas/TipPresetDefault":{"id":"components/schemas/TipPresetDefault","kind":"json-schema","title":"TipPresetDefault","data":{"type":"string","enum":["1","2","3","none"],"example":"2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The preset value that is selected by default. If not sent in the request it will default to to preset 2."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preset 1 is selected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preset 2 is selected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preset 3 is selected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No preset is selected"},"children":[]}]}]}]}]}]}]}},"components/schemas/TipPreset1":{"id":"components/schemas/TipPreset1","kind":"json-schema","title":"TipPreset1","data":{"type":"number","example":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The preset value for the preset number 1. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the percentage value. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the amount value."},"children":[]}]}]}]}},"components/schemas/TipPreset2":{"id":"components/schemas/TipPreset2","kind":"json-schema","title":"TipPreset2","data":{"type":"number","example":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The preset value for the preset number 2. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the percentage value. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the amount value."},"children":[]}]}]}]}},"components/schemas/TipPreset3":{"id":"components/schemas/TipPreset3","kind":"json-schema","title":"TipPreset3","data":{"type":"number","example":25,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The preset value for the preset number 3. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the percentage value. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presetType = amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send the amount value."},"children":[]}]}]}]}},"components/schemas/TipHeader":{"id":"components/schemas/TipHeader","kind":"json-schema","title":"TipHeader","data":{"type":"string","maxLength":100,"example":"Would you like to add a tip?","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field to override the header text. If not sent, the header text will display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Add Tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the terminal's configured language."},"children":[]}]}]}]}},"components/schemas/TipBasisNotification":{"id":"components/schemas/TipBasisNotification","kind":"json-schema","title":"TipBasisNotification","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to display the tip basis notification text on the tip screen. Must also include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.tipBasis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request if sending as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]}},"components/schemas/TipDisplayNoTip":{"id":"components/schemas/TipDisplayNoTip","kind":"json-schema","title":"TipDisplayNoTip","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to display No Tip instead of Cash Tip on the tip entry screen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]}},"components/schemas/TipObject":{"id":"components/schemas/TipObject","kind":"json-schema","title":"TipObject","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object allows integrators to control the display and behavior of the tip screen presented to customers during payment processing."},"children":[]}]}]}],"required":["presetType"],"properties":{"presetType":{"$ref":"#/components/schemas/TipPresetType"},"presetDefault":{"$ref":"#/components/schemas/TipPresetDefault"},"preset1":{"$ref":"#/components/schemas/TipPreset1"},"preset2":{"$ref":"#/components/schemas/TipPreset2"},"preset3":{"$ref":"#/components/schemas/TipPreset3"},"headerText":{"$ref":"#/components/schemas/TipHeader"},"basisNotification":{"$ref":"#/components/schemas/TipBasisNotification"},"displayNoTip":{"$ref":"#/components/schemas/TipDisplayNoTip"}}}},"components/schemas/UILanguageRequest":{"id":"components/schemas/UILanguageRequest","kind":"json-schema","title":"UILanguageRequest","data":{"type":"string","example":"en","description":"ISO 639-1 2-letter language code specifying the UI display language for the transaction (e.g. \"en\", \"fr\", \"de\"). When provided, overrides the device's configured default language for the duration of the session. Value persists across transactions until a new value is passed. Send default to reset the device back to its default language.\n"}},"components/schemas/UIMode":{"id":"components/schemas/UIMode","kind":"json-schema","title":"UIMode","data":{"type":"string","enum":["light","dark"],"example":"dark","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the UI to light mode by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"light"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or dark mode by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dark"},"children":[]}]}]}]}},"components/schemas/UISuppressFinalResult":{"id":"components/schemas/UISuppressFinalResult","kind":"json-schema","title":"UISuppressFinalResult","data":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the terminal suppresses the final transaction result screen."},"children":[]}]}]}]}},"components/schemas/SafFloorLimitCredit":{"id":"components/schemas/SafFloorLimitCredit","kind":"json-schema","title":"SafFloorLimitCredit","data":{"type":"number","maxLength":14,"example":250.25,"description":"Sets the offline floor limit for the transaction. If lower than the configured credit floor limit, it overrides the limit. If higher than or equal to the configured limit, it's ignored.\n"}},"components/schemas/SafFloorLimit":{"id":"components/schemas/SafFloorLimit","kind":"json-schema","title":"SafFloorLimit","data":{"type":"object","properties":{"credit":{"$ref":"#/components/schemas/SafFloorLimitCredit"}}}},"components/schemas/transactions_authorization_comengdevice":{"id":"components/schemas/transactions_authorization_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/DeviceCloud":{"id":"components/schemas/DeviceCloud","kind":"json-schema","title":"DeviceCloud","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the transaction will be processed via the Commerce Engine solution for cloud based POS/PMS systems. Value must be sent as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to route the request to the payment device at the merchant location."},"children":[]}]}]}]}},"components/schemas/DeviceManufacturer":{"id":"components/schemas/DeviceManufacturer","kind":"json-schema","title":"DeviceManufacturer","data":{"type":"string","enum":["Ingenico","Innowi","PAX","Verifone","Castles","Miura"],"example":"PAX","description":"Specifies the company which manufactured the device.\n"}},"components/schemas/DeviceSerialNumber":{"id":"components/schemas/DeviceSerialNumber","kind":"json-schema","title":"DeviceSerialNumber","data":{"type":"string","maxLength":64,"example":"1170301234","description":"Specifies the serial number of the device.\n"}},"components/schemas/DeviceCommerceEngineCloud":{"id":"components/schemas/DeviceCommerceEngineCloud","kind":"json-schema","title":"DeviceCommerceEngineCloud","data":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"}}}},"components/schemas/transactions_authorization_comengcloud":{"id":"components/schemas/transactions_authorization_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2023-08-31T07:20:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/DeviceTerminalId":{"id":"components/schemas/DeviceTerminalId","kind":"json-schema","title":"DeviceTerminalId","data":{"type":"string","maxLength":32,"example":"1742","description":"To prompt a specific UTG-controlled PIN pad in a request, the API Terminal ID configured in UTG TuneUp must be specified in this field.\n"}},"components/schemas/DevicePromptPostalCode":{"id":"components/schemas/DevicePromptPostalCode","kind":"json-schema","title":"DevicePromptPostalCode","data":{"type":"string","minLength":1,"maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a UTG-controlled PIN pad:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force the PIN pad to prompt the consumer for a ZIP/Postal Code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not force the PIN pad to prompt the consumer for a ZIP/Postal Code."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG."},"children":[]}]}]}]}]}},"components/schemas/DevicePromptCardSecurityCode":{"id":"components/schemas/DevicePromptCardSecurityCode","kind":"json-schema","title":"DevicePromptCardSecurityCode","data":{"type":"string","minLength":1,"maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a UTG-controlled PIN pad:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force the PIN pad to prompt the consumer for a CSC."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not force the PIN pad to prompt the consumer for a CSC."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG."},"children":[]}]}]}]}]}},"components/schemas/DevicePromptStreetNumber":{"id":"components/schemas/DevicePromptStreetNumber","kind":"json-schema","title":"DevicePromptStreetNumber","data":{"type":"string","minLength":1,"maxLength":1,"enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a UTG-controlled PIN pad:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force the PIN pad to prompt the consumer for the street number of their billing address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not force the PIN pad to prompt the consumer for the street number of their billing address."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG."},"children":[]}]}]}]}]}},"components/schemas/transactions_authorization_utgdevice":{"id":"components/schemas/transactions_authorization_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"terminalId":"1742"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/AmountSurcharge":{"id":"components/schemas/AmountSurcharge","kind":"json-schema","title":"AmountSurcharge","data":{"type":"number","maxLength":14,"example":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the request if a surcharge was applied to the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a sale or authorization transaction, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surcharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field specifies a fee amount that a consumer is charged in addition to the transaction amount. The fee amount is also added into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if the transaction request had "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surcharge.percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was 1.5% the transaction would include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 101.50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.surcharge = 1.50"},"children":[]}]}]}]}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with a $20 tip and $8 tax would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"128.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount  fields can specify up to three decimal places. However, the number of decimal  places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total","tax"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"taxIndicator":{"$ref":"#/components/schemas/AmountTaxIndicator"},"cashback":{"$ref":"#/components/schemas/AmountCashback"},"iiasAmounts":{"$ref":"#/components/schemas/IIASAmountsArray"},"surcharge":{"$ref":"#/components/schemas/AmountSurcharge"},"tip":{"$ref":"#/components/schemas/AmountTip"},"checkTotal":{"$ref":"#/components/schemas/AmountCheckTotal"}}}},"components/schemas/TransactionS4RiskIdRequest":{"id":"components/schemas/TransactionS4RiskIdRequest","kind":"json-schema","title":"TransactionS4RiskIdRequest","data":{"type":"string","example":"EC52377F-5A8E-4534-BE7A-CF779A35BE45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique transaction identification number generated by Shift4 to identify a specific risk transaction and a field that can be searched in LTM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was completed prior to processing the transaction."},"children":[]}]}]}]}]}},"components/schemas/TransactionDeferredAuth":{"id":"components/schemas/TransactionDeferredAuth","kind":"json-schema","title":"TransactionDeferredAuth","data":{"type":"string","minLength":1,"maxLength":1,"example":"D","enum":["D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent if the transaction is deferred"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies that a transaction is the result of a deferred authorization. For example, a transaction that was accepted while in an offline state and is being uploaded after coming back online."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction is a deferred authorization"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionExemptionAction":{"id":"components/schemas/TransactionExemptionAction","kind":"json-schema","title":"TransactionExemptionAction","data":{"type":"string","example":"02","enum":["02"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the merchant preference regarding SCA exemption."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an exemption as part of the payment request."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If no value is provided, and you are using the 3DS Adviser module, the Shift4 Payment Gateway requests an exemption (if applicable) as part of the 3D secure process."},"children":[]}]}]}]}},"components/schemas/TransactionExemptionReason":{"id":"components/schemas/TransactionExemptionReason","kind":"json-schema","title":"TransactionExemptionReason","data":{"type":"string","example":"01","enum":["01","02","04"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: required when sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.exemptionAction = 02"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Low value transaction (below 30 EUR or equivalent)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Low risk transaction (TRA)1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure Corporate Cards 3"},"children":[]}]}]}]}]}]}]}},"components/schemas/CardExpirationDate":{"id":"components/schemas/CardExpirationDate","kind":"json-schema","title":"CardExpirationDate","data":{"type":"integer","minLength":3,"maxLength":4,"format":"MMYY","example":1230,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send only when card data is manually entered or when using a token. This field should not be specified when using an encrypted device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card expiration date in MMYY format. This value should only be populated in the initial sale/authorization request."},"children":[]}]}]}]}},"components/schemas/CardTokenValue":{"id":"components/schemas/CardTokenValue","kind":"json-schema","title":"CardTokenValue","data":{"description":"This field is used to specify a card token. Whenever CHD is sent in a request, a card token will be returned in this field. Your interface should be designed to store this card token for future use. The latest card token received should be used in any subsequent request that references the same card data.\n","type":"string","maxLength":16,"example":"8048471746471119"}},"components/schemas/CardTokenRequired":{"id":"components/schemas/CardTokenRequired","kind":"json-schema","title":"CardTokenRequired","data":{"type":"object","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/CardTokenValue"}}}},"components/schemas/CardSecurityCodeIndicator":{"id":"components/schemas/CardSecurityCodeIndicator","kind":"json-schema","title":"CardSecurityCodeIndicator","data":{"type":"string","minLength":1,"maxLength":1,"writeOnly":true,"example":"1","enum":["0","1","2","9"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates the presence of a CSC."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC not provided by user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC provided."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC illegible."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC not on card, or card did not have a CSC."},"children":[]}]}]}]}]}]}]}},"components/schemas/CardSecurityCodeResult":{"id":"components/schemas/CardSecurityCodeResult","kind":"json-schema","title":"CardSecurityCodeResult","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"M","enum":["M","N","P","S","U","Y","1","2","3"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are sent in the request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of a CSC check. This field will be used by Shift4 to determine the value sent in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (based on the merchant’s list of accepted verification results as configured with Shift4)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC did not match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC not processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC should have been present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer unable to process."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CVC1 incorrect."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSC Unavailable - processor / card type does not support this parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unrecognised result code was returned by the processor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No result code was returned by the processor."},"children":[]}]}]}]}]}]}]}},"components/schemas/CardSecurityCodeValid":{"id":"components/schemas/CardSecurityCodeValid","kind":"json-schema","title":"CardSecurityCodeValid","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are sent in the request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A simplified CSC check result based on the value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and the merchant’s accepted verification results as configured with Shift4. The value returned will be ‘Y’ if CSC verification passed or ‘N’ if CSC verification did not pass."},"children":[]}]}]}]}},"components/schemas/CardSecurityCodeValue":{"id":"components/schemas/CardSecurityCodeValue","kind":"json-schema","title":"CardSecurityCodeValue","data":{"type":"string","maxLength":4,"writeOnly":true,"example":"333","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three- or four-digit Card Security Code found on a payment card. This value should only be sent in an initial sale/authorization request. It should not be stored by the interface. When sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.securityCode.indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be sent."},"children":[]}]}]}]}},"components/schemas/CardSecurityCode":{"id":"components/schemas/CardSecurityCode","kind":"json-schema","title":"CardSecurityCode","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send only when card data is manually entered. This object should not be specified when using an encrypted device. This object should be sent for initial card on file request but is not required for subsequent merchant initiated  charges."},"children":[]}]}]}]}],"required":["indicator","value"],"properties":{"indicator":{"$ref":"#/components/schemas/CardSecurityCodeIndicator"},"result":{"$ref":"#/components/schemas/CardSecurityCodeResult"},"valid":{"$ref":"#/components/schemas/CardSecurityCodeValid"},"value":{"$ref":"#/components/schemas/CardSecurityCodeValue"}}}},"components/schemas/RiskTranIdRequest":{"id":"components/schemas/RiskTranIdRequest","kind":"json-schema","title":"RiskTranIdRequest","data":{"type":"string","example":"DDWT0P3LG6LL","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The risk tranId value received in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was completed prior to processing the transaction."},"children":[]}]}]}]}]}},"components/schemas/RiskAssessmentRequest":{"id":"components/schemas/RiskAssessmentRequest","kind":"json-schema","title":"RiskAssessmentRequest","data":{"type":"string","enum":["A","D","R","E"],"example":"A","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The risk assessment value received in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  was completed prior to processing the transaction."},"children":[]}]}]}]}]}},"components/schemas/RiskTransactionRequest":{"id":"components/schemas/RiskTransactionRequest","kind":"json-schema","title":"RiskTransactionRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/risk/riskassess"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Assessment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was completed prior to processing the transaction."},"children":[]}]}]}]}],"properties":{"tranId":{"$ref":"#/components/schemas/RiskTranIdRequest"},"assessment":{"$ref":"#/components/schemas/RiskAssessmentRequest"}}}},"components/schemas/ReportingDataCustomerInfoFirstName":{"id":"components/schemas/ReportingDataCustomerInfoFirstName","kind":"json-schema","title":"ReportingDataCustomerInfoFirstName","data":{"type":"string","example":"John","maxLength":30,"description":"Customer's first name\n"}},"components/schemas/ReportingDataCustomerInfoLastName":{"id":"components/schemas/ReportingDataCustomerInfoLastName","kind":"json-schema","title":"ReportingDataCustomerInfoLastName","data":{"type":"string","example":"Smith","maxLength":30,"description":"Customer's last name\n"}},"components/schemas/ReportingDataCustomerInfoDateOfBirth":{"id":"components/schemas/ReportingDataCustomerInfoDateOfBirth","kind":"json-schema","title":"ReportingDataCustomerInfoDateOfBirth","data":{"type":"string","example":"01281980","minLength":8,"maxLength":8,"description":"Customer's date of birth in MMDDYYYY format\n"}},"components/schemas/ReportingDataCustomerInfoGender":{"id":"components/schemas/ReportingDataCustomerInfoGender","kind":"json-schema","title":"ReportingDataCustomerInfoGender","data":{"type":"string","example":"male","maxLength":20,"description":"Customer's gender\n"}},"components/schemas/ReportingDataCustomerInfoBaggage":{"id":"components/schemas/ReportingDataCustomerInfoBaggage","kind":"json-schema","title":"ReportingDataCustomerInfoBaggage","data":{"type":"string","example":"carryon","maxLength":20,"description":"Description for the customer's baggage\n"}},"components/schemas/ReportingDataCustomerInfoSeats":{"id":"components/schemas/ReportingDataCustomerInfoSeats","kind":"json-schema","title":"ReportingDataCustomerInfoSeats","data":{"type":"string","example":"1A","maxLength":3,"description":"Customer's assigned seat\n"}},"components/schemas/ReportingDataCustomerInfoBoardingPriority":{"id":"components/schemas/ReportingDataCustomerInfoBoardingPriority","kind":"json-schema","title":"ReportingDataCustomerInfoBoardingPriority","data":{"type":"string","example":"3","maxLength":3,"description":"Customer's boarding priority\n"}},"components/schemas/ReportingDataCustomerInfo":{"id":"components/schemas/ReportingDataCustomerInfo","kind":"json-schema","title":"ReportingDataCustomerInfo","data":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/ReportingDataCustomerInfoFirstName"},"lastName":{"$ref":"#/components/schemas/ReportingDataCustomerInfoLastName"},"dateOfBirth":{"$ref":"#/components/schemas/ReportingDataCustomerInfoDateOfBirth"},"gender":{"$ref":"#/components/schemas/ReportingDataCustomerInfoGender"},"baggage":{"$ref":"#/components/schemas/ReportingDataCustomerInfoBaggage"},"seats":{"$ref":"#/components/schemas/ReportingDataCustomerInfoSeats"},"boardingPriority":{"$ref":"#/components/schemas/ReportingDataCustomerInfoBoardingPriority"}}}},"components/schemas/ReportingDataCustomerInfoArray":{"id":"components/schemas/ReportingDataCustomerInfoArray","kind":"json-schema","title":"ReportingDataCustomerInfoArray","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/ReportingDataCustomerInfo"},"example":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}],"description":"Array of customer information objects. The maximum number of customer information objects that can be sent is 10.\n"}},"components/schemas/ReportingDataPspDataPspId":{"id":"components/schemas/ReportingDataPspDataPspId","kind":"json-schema","title":"ReportingDataPspDataPspId","data":{"type":"string","maxLength":64,"example":"PSP Name XYZ","description":"PSP identifier / label\n"}},"components/schemas/ReportingDataPspDataPspMid":{"id":"components/schemas/ReportingDataPspDataPspMid","kind":"json-schema","title":"ReportingDataPspDataPspMid","data":{"type":"string","maxLength":32,"example":"123456","description":"PSP merchant identifier (MID).\n"}},"components/schemas/ReportingDataPspDataPspTid":{"id":"components/schemas/ReportingDataPspDataPspTid","kind":"json-schema","title":"ReportingDataPspDataPspTid","data":{"type":"string","maxLength":32,"example":"12345678","description":"PSP terminal identifier (TID).\n"}},"components/schemas/ReportingDataPspDataPspTxnTraceNo":{"id":"components/schemas/ReportingDataPspDataPspTxnTraceNo","kind":"json-schema","title":"ReportingDataPspDataPspTxnTraceNo","data":{"type":"string","maxLength":32,"example":"000013","description":"PSP transaction trace number.\n"}},"components/schemas/ReportingDataPspDataPspTxnDate":{"id":"components/schemas/ReportingDataPspDataPspTxnDate","kind":"json-schema","title":"ReportingDataPspDataPspTxnDate","data":{"type":"string","format":"date","example":"20260110","description":"PSP transaction date (YYYYMMDD).\n"}},"components/schemas/ReportingDataPspDataPspTxnTime":{"id":"components/schemas/ReportingDataPspDataPspTxnTime","kind":"json-schema","title":"ReportingDataPspDataPspTxnTime","data":{"type":"string","format":"24-hour time","example":"235959","description":"PSP transaction time (hhmmss)\n"}},"components/schemas/ReportingDataPspDataPspResponseCode":{"id":"components/schemas/ReportingDataPspDataPspResponseCode","kind":"json-schema","title":"ReportingDataPspDataPspResponseCode","data":{"type":"string","maxLength":16,"example":"00","description":"PSP host response code.\n"}},"components/schemas/ReportingDataPspDataPspResponseText":{"id":"components/schemas/ReportingDataPspDataPspResponseText","kind":"json-schema","title":"ReportingDataPspDataPspResponseText","data":{"type":"string","maxLength":256,"example":"Payment Approved","description":"PSP host response description/text.\n"}},"components/schemas/ReportingDataPspData":{"id":"components/schemas/ReportingDataPspData","kind":"json-schema","title":"ReportingDataPspData","data":{"type":"object","description":"Payment service provider (PSP) metadata for third-party processed transactions.\n","properties":{"pspId":{"$ref":"#/components/schemas/ReportingDataPspDataPspId"},"pspMid":{"$ref":"#/components/schemas/ReportingDataPspDataPspMid"},"pspTid":{"$ref":"#/components/schemas/ReportingDataPspDataPspTid"},"pspTxnTraceNo":{"$ref":"#/components/schemas/ReportingDataPspDataPspTxnTraceNo"},"pspTxnDate":{"$ref":"#/components/schemas/ReportingDataPspDataPspTxnDate"},"pspTxnTime":{"$ref":"#/components/schemas/ReportingDataPspDataPspTxnTime"},"pspResponseCode":{"$ref":"#/components/schemas/ReportingDataPspDataPspResponseCode"},"pspResponseText":{"$ref":"#/components/schemas/ReportingDataPspDataPspResponseText"}}}},"components/schemas/ReportingData":{"id":"components/schemas/ReportingData","kind":"json-schema","title":"ReportingData","data":{"type":"object","description":"Used to send non-payment related data for reporting purposes.\n","properties":{"customerInfo":{"$ref":"#/components/schemas/ReportingDataCustomerInfoArray"},"pspData":{"$ref":"#/components/schemas/ReportingDataPspData"}}}},"components/schemas/mPOSType":{"id":"components/schemas/mPOSType","kind":"json-schema","title":"mPOSType","data":{"type":"string","enum":["00","01","02","03"],"example":"01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mPOS (mobile POS) device type indicator"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mPOS Accessory/dongle with contact and contactless interfaces, with or without PIN pad."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile device based contactless only mPOS without PIN support."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mPOS Accessory/dongle with contact and contactless interfaces and PIN on Glass support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile device based contactless only mPOS with PIN on Glass support."},"children":[]}]}]}]}]}]}]}},"components/schemas/mPOS":{"id":"components/schemas/mPOS","kind":"json-schema","title":"mPOS","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the request if transaction is coming from an mPOS"},"children":[]}]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/mPOSType"}}}},"components/schemas/DCCRateTimeStamp":{"id":"components/schemas/DCCRateTimeStamp","kind":"json-schema","title":"DCCRateTimeStamp","data":{"type":"string","format":"ISO 8601","example":"2024-07-09T13:34:25.049-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the DDC rate lookup in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/DCCCurrencyCode":{"id":"components/schemas/DCCCurrencyCode","kind":"json-schema","title":"DCCCurrencyCode","data":{"type":"string","format":"ISO 4217 3 Character Alphabetic Code","example":"CAD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's transaction currency code. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}]}},"components/schemas/DCCForeignAmount":{"id":"components/schemas/DCCForeignAmount","kind":"json-schema","title":"DCCForeignAmount","data":{"type":"number","maxLength":14,"example":180,"description":"Foreign Currency Amount\n"}},"components/schemas/DCCConversionRate":{"id":"components/schemas/DCCConversionRate","kind":"json-schema","title":"DCCConversionRate","data":{"type":"string","maxLength":20,"example":1.35,"description":"Foreign Currency Exchange Rate. The rate at which one currency can be exchanged for another currency.\n"}},"components/schemas/DCCMarginPercentage":{"id":"components/schemas/DCCMarginPercentage","kind":"json-schema","title":"DCCMarginPercentage","data":{"type":"string","maxLength":10,"example":9.99,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is the foreign exchange markup percentage including the decimal. For example 9.99% will be returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9.99"},"children":[]}]}]}]}},"components/schemas/DCCCurrencyMinorUnits":{"id":"components/schemas/DCCCurrencyMinorUnits","kind":"json-schema","title":"DCCCurrencyMinorUnits","data":{"type":"number","example":2,"description":"Foreign Currency Minor Unit. Indicates the number of digits after the decimal separator as specified by either MasterCard, VISA, or the ISO 4217 standard.\n"}},"components/schemas/DCCTransactionID":{"id":"components/schemas/DCCTransactionID","kind":"json-schema","title":"DCCTransactionID","data":{"type":"string","maxLength":50,"example":"1A2820D2G334","description":"A unique identifier returned in the ratelookup response to link with the initial authorization, Sale transaction types.\n"}},"components/schemas/DCCConversionIndicator":{"id":"components/schemas/DCCConversionIndicator","kind":"json-schema","title":"DCCConversionIndicator","data":{"type":"string","minLength":1,"maxLength":1,"enum":["0","1","2"],"example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the cardholder opted into dynamic currency conversion."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convertible but declined by cardholder (cardholder chose to pay in merchant currency)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Converted (cardholder opted to pay in their currency)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nonconvertible (DCC cannot be used)"},"children":[]}]}]}]}]}]}]}},"components/schemas/DCCDiffOverECB":{"id":"components/schemas/DCCDiffOverECB","kind":"json-schema","title":"DCCDiffOverECB","data":{"type":"string","maxLength":5,"example":"0.35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Difference of GB Reference Rate over ECB Reference Rate in percentage (%), if applicable including decimal. This field is applicable only for conversion between currencies of EU countries, e.g. EUR --> DKK or SEK --> CZK."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will not be returned if the transaction is not in Scope of EU Regulation 2019/518."},"children":[]}]}]}]}},"components/schemas/DCCMarginOverECB":{"id":"components/schemas/DCCMarginOverECB","kind":"json-schema","title":"DCCMarginOverECB","data":{"type":"string","maxLength":5,"example":"2.85","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markup of offered exchange rate over ECB Reference Rate in percentage (%), if applicable. This field is applicable only for conversion between currencies of EU countries, e.g. EUR --> DKK or SEK --> CZK."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will not be returned if the transaction is not in scope of EU Regulation 2019/518."},"children":[]}]}]}]}},"components/schemas/DCCDisplayUnit":{"id":"components/schemas/DCCDisplayUnit","kind":"json-schema","title":"DCCDisplayUnit","data":{"type":"number","example":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display unit for currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the exponent of the base currency in an exchange rate pair e.g. for a JPY merchant converting to EUR, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dcc.displayUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 2 will show JPY in 100 (10^2) units: JPY 100 = EUR 0.7961"},"children":[]}]}]}]}},"components/schemas/DCCProvider":{"id":"components/schemas/DCCProvider","kind":"json-schema","title":"DCCProvider","data":{"type":"string","enum":["WAY4","GLOBAL_BLUE"],"example":"GLOBAL_BLUE","description":"DCC Provider\n"}},"components/schemas/DCCTransactionRequest":{"id":"components/schemas/DCCTransactionRequest","kind":"json-schema","title":"DCCTransactionRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing Dynamic Currency Conversion (DCC) information. Must contain all fields received in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/dcc/dccratelookup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DCC Rate Lookup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be included in the request if the cardholder was given the option to pay in their currency, even if they opted out."},"children":[]}]}]}]}],"properties":{"rateTimeStamp":{"$ref":"#/components/schemas/DCCRateTimeStamp"},"currencyCode":{"$ref":"#/components/schemas/DCCCurrencyCode"},"foreignAmount":{"$ref":"#/components/schemas/DCCForeignAmount"},"conversionRate":{"$ref":"#/components/schemas/DCCConversionRate"},"marginPercentage":{"$ref":"#/components/schemas/DCCMarginPercentage"},"currencyMinorUnits":{"$ref":"#/components/schemas/DCCCurrencyMinorUnits"},"transactionId":{"$ref":"#/components/schemas/DCCTransactionID"},"conversionIndicator":{"$ref":"#/components/schemas/DCCConversionIndicator"},"diffOverEcb":{"$ref":"#/components/schemas/DCCDiffOverECB"},"marginOverEcb":{"$ref":"#/components/schemas/DCCMarginOverECB"},"displayUnit":{"$ref":"#/components/schemas/DCCDisplayUnit"},"provider":{"$ref":"#/components/schemas/DCCProvider"}}}},"components/schemas/SurchargePercentage":{"id":"components/schemas/SurchargePercentage","kind":"json-schema","title":"SurchargePercentage","data":{"type":"number","example":2,"maximum":99.99,"description":"The surcharge percentage that can be applied to a transaction.\n"}},"components/schemas/SurchargeRequest":{"id":"components/schemas/SurchargeRequest","kind":"json-schema","title":"SurchargeRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent in the request if a surcharge is applied to the transaction."},"children":[]}]}]}]}],"properties":{"percentage":{"$ref":"#/components/schemas/SurchargePercentage"}}}},"components/schemas/transactions_authorization_token_gtv":{"id":"components/schemas/transactions_authorization_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/CardTokenSerialNumber":{"id":"components/schemas/CardTokenSerialNumber","kind":"json-schema","title":"CardTokenSerialNumber","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In requests that require the use of a shared card token that is held by another merchant account, such as in a TokenStore or TokenShare®, this field is used to specify the serial number for the account where the card token is stored."},"children":[]}]}]}],"type":"string","maxLength":10,"example":"266"}},"components/schemas/CardTokenRequiredLegacy":{"id":"components/schemas/CardTokenRequiredLegacy","kind":"json-schema","title":"CardTokenRequiredLegacy","data":{"type":"object","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/CardTokenValue"},"serialNumber":{"$ref":"#/components/schemas/CardTokenSerialNumber"}}}},"components/schemas/transactions_authorization_token_legacy":{"id":"components/schemas/transactions_authorization_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/P2PEData":{"id":"components/schemas/P2PEData","kind":"json-schema","title":"P2PEData","data":{"type":"string","maxLength":2048,"example":"027101801F2D1E00939B%*432100******1119^VS/DUAL TRACK^2212******?*;432100******1119=2212******?*CECE3FCE7781142BEC8D0E267AE89F5D3C7E235BF1A70E637951E8D93003E5A2586C336CA4A3B31F6639B04005BB12A716D8BC4D3AB125C27AB11A9DDC02816569D42A20B036EE5E2C71CB70565FB43B000000000000000000000000000000000000000000000000000000000000000000000000000000003434345434363138343962994950010038200415953903","description":"The full output of a P2PE keypad/magnetic swipe reader (MSR).\n"}},"components/schemas/P2PEFormatIDTech":{"id":"components/schemas/P2PEFormatIDTech","kind":"json-schema","title":"P2PEFormatIDTech","data":{"type":"string","minLength":2,"maxLength":2,"enum":["01","02"],"example":"01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format (Keyboard Mode)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format (USB HID Mode)"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PEType0102IDTECH":{"id":"components/schemas/P2PEType0102IDTECH","kind":"json-schema","title":"P2PEType0102IDTECH","data":{"type":"object","required":["data","format"],"properties":{"data":{"$ref":"#/components/schemas/P2PEData"},"format":{"$ref":"#/components/schemas/P2PEFormatIDTech"}}}},"components/schemas/transactions_authorization_p2pe_idtech":{"id":"components/schemas/transactions_authorization_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","apiOptions":["ALLOWPARTIALAUTH"],"amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"present":"Y"},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/AccountType":{"id":"components/schemas/AccountType","kind":"json-schema","title":"AccountType","data":{"type":"string","example":"00","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of financial institution account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Must be sent if processing Interac debit EMV contact transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chequing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionPinBlock":{"id":"components/schemas/TransactionPinBlock","kind":"json-schema","title":"TransactionPinBlock","data":{"type":"string","maxLength":16,"example":"1234567890123456","description":"Encrypted PIN data received from a POS-controlled PIN pad (not controlled by the UTG).\n"}},"components/schemas/TransactionPinKsn":{"id":"components/schemas/TransactionPinKsn","kind":"json-schema","title":"TransactionPinKsn","data":{"type":"string","maxLength":20,"example":"FFFF4950010293927772","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key serial number (KSN) received from a POS-controlled PIN pad (not controlled by the UTG). This field is a hexadecimal field that should be padded with leading ‘F’s."},"children":[]}]}]}]}},"components/schemas/TransactionPin":{"id":"components/schemas/TransactionPin","kind":"json-schema","title":"TransactionPin","data":{"type":"object","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Include in the request for PIN debit and EMV Online PIN transactions. This object does not apply to UTG-controlled devices."},"children":[]}]}]}]}],"properties":{"block":{"$ref":"#/components/schemas/TransactionPinBlock"},"ksn":{"$ref":"#/components/schemas/TransactionPinKsn"}}}},"components/schemas/DeviceModel":{"id":"components/schemas/DeviceModel","kind":"json-schema","title":"DeviceModel","data":{"type":"string","maxLength":50,"example":"A800","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when using a non-UTG-controlled device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the model of the device."},"children":[]}]}]}]}},"components/schemas/DeviceCapabilityContactlessEMV":{"id":"components/schemas/DeviceCapabilityContactlessEMV","kind":"json-schema","title":"DeviceCapabilityContactlessEMV","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports contactless EMV.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityContactlessMSR":{"id":"components/schemas/DeviceCapabilityContactlessMSR","kind":"json-schema","title":"DeviceCapabilityContactlessMSR","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports contactless magstripe.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityEMV":{"id":"components/schemas/DeviceCapabilityEMV","kind":"json-schema","title":"DeviceCapabilityEMV","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports EMV.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityManualEntry":{"id":"components/schemas/DeviceCapabilityManualEntry","kind":"json-schema","title":"DeviceCapabilityManualEntry","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports manual entry.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityMagstripe":{"id":"components/schemas/DeviceCapabilityMagstripe","kind":"json-schema","title":"DeviceCapabilityMagstripe","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports magstripe.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityPIN":{"id":"components/schemas/DeviceCapabilityPIN","kind":"json-schema","title":"DeviceCapabilityPIN","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports PIN entry (for debit or EMV). If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilityQuickChip":{"id":"components/schemas/DeviceCapabilityQuickChip","kind":"json-schema","title":"DeviceCapabilityQuickChip","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports quick chip.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapabilitySignature":{"id":"components/schemas/DeviceCapabilitySignature","kind":"json-schema","title":"DeviceCapabilitySignature","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"Specifies whether or not the device supports signature capture.  If this input method can be supported by the device, but the input method is currently disabled for all transactions on the device, then the value 'N' should be sent.\n"}},"components/schemas/DeviceCapability":{"id":"components/schemas/DeviceCapability","kind":"json-schema","title":"DeviceCapability","data":{"type":"object","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when using a non-UTG-controlled device."},"children":[]}]}]}]}],"properties":{"contactlessEMV":{"$ref":"#/components/schemas/DeviceCapabilityContactlessEMV"},"contactlessMSR":{"$ref":"#/components/schemas/DeviceCapabilityContactlessMSR"},"EMV":{"$ref":"#/components/schemas/DeviceCapabilityEMV"},"manualEntry":{"$ref":"#/components/schemas/DeviceCapabilityManualEntry"},"magstripe":{"$ref":"#/components/schemas/DeviceCapabilityMagstripe"},"PIN":{"$ref":"#/components/schemas/DeviceCapabilityPIN"},"quickChip":{"$ref":"#/components/schemas/DeviceCapabilityQuickChip"},"signature":{"$ref":"#/components/schemas/DeviceCapabilitySignature"}}}},"components/schemas/P2PEFormatType05":{"id":"components/schemas/P2PEFormatType05","kind":"json-schema","title":"P2PEFormatType05","data":{"type":"string","minLength":2,"maxLength":2,"enum":["05"],"example":"05","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/p2pe-format#tdes-dukpt---format-05"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift4 TDES DUKPT format"},"children":[]}]}]}]}]}]}]}]}},"components/schemas/P2PEKSN":{"id":"components/schemas/P2PEKSN","kind":"json-schema","title":"P2PEKSN","data":{"type":"string","maxLength":20,"example":"6299495001100E200041","description":"The key serial number which was used to encrypt the P2PE data.\n"}},"components/schemas/P2PEType05TDESDUKPTEMV":{"id":"components/schemas/P2PEType05TDESDUKPTEMV","kind":"json-schema","title":"P2PEType05TDESDUKPTEMV","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/p2pe-format#tdes-dukpt---format-05"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P2PE Format 05 TDES DUKPT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"required":["format","ksn"],"properties":{"format":{"$ref":"#/components/schemas/P2PEFormatType05"},"ksn":{"$ref":"#/components/schemas/P2PEKSN"}}}},"components/schemas/EMVEmptyCandidateList":{"id":"components/schemas/EMVEmptyCandidateList","kind":"json-schema","title":"EMVEmptyCandidateList","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When EMV is attempted but fallback occurs due to an empty candidate list, this field should be sent as 'Y' and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emv.fallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should also be sent as 'Y'.  If this field is not sent, a value of 'N' is assumed."},"children":[]}]}]}]}},"components/schemas/EMVTlvData":{"id":"components/schemas/EMVTlvData","kind":"json-schema","title":"EMVTlvData","data":{"type":"string","writeOnly":true,"example":"4F07A0000000041010500A4D61737465724361726457203CCEB572BE7DD0A38E62E6BD70E3DAACE9B46BD3BF65E188E7D8D68D2178DE1A5A10B1794BAC083B08F0A1444F189A5493255F201A546573742F4361726420303920202020202020202020202020205F24032512315F25031511015F2D02656E5F3401018407A0000000041010950508200000009B02C8009F02060000000004449F03060000000000009F34031E03009F3704C5BF918D9F390105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will contain all EMV tags in standard TLV format including the P2PE encrypted tags (5A and 57).  The P2PE encrypted tags (5A and 57) will have the entire TLV string encrypted and the encrypted data will be in a TLV format using the same tag. For example, tag 5A would look like the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted: 5A103737DA95D8062F647A0FF747CC496570"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decrypted: 5A084761739001010010"},"children":[]}]}]}]}]}},"components/schemas/EMV":{"id":"components/schemas/EMV","kind":"json-schema","title":"EMV","data":{"type":"object","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when processing an EMV transaction without using a UTG."},"children":[]}]}]}]}],"required":["tlvData"],"properties":{"emptyCandidateList":{"$ref":"#/components/schemas/EMVEmptyCandidateList"},"tlvData":{"$ref":"#/components/schemas/EMVTlvData"}}}},"components/schemas/CardEntryMode":{"id":"components/schemas/CardEntryMode","kind":"json-schema","title":"CardEntryMode","data":{"type":"string","minLength":1,"maxLength":1,"enum":["1","2","C","E","M","Q","R"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: The Card Entry Mode should be sent in an initial request; in subsequent requests, it should be left blank or not sent. When using a Universal Transaction Gateway® (UTG®)-controlled PIN pad, this field should be left blank or not sent in a request; the UTG will capture the card entry mode and return it in the response. When P2PE data is being sent from a non-UTG controlled device, this field is not needed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track 1 Only or Dual Track (Track 1 & 2)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track 2 Only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Contactless via card or mobile wallet"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Chip"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QR Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contactless MSD"},"children":[]}]}]}]}]}]}]}},"components/schemas/transactions_authorization_p2pe_tdesdukpt_emv":{"id":"components/schemas/transactions_authorization_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMV"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/EMVFallback":{"id":"components/schemas/EMVFallback","kind":"json-schema","title":"EMVFallback","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"When EMV is attempted but fallback occurs for any reason, this field should be sent as 'Y'.  If this field is not sent, a value of 'N' is assumed.\n"}},"components/schemas/EMVFallbackOnly":{"id":"components/schemas/EMVFallbackOnly","kind":"json-schema","title":"EMVFallbackOnly","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when processing an EMV fallback transaction."},"children":[]}]}]}]}],"properties":{"fallback":{"$ref":"#/components/schemas/EMVFallback"}}}},"components/schemas/P2PEType05TDESDUKPTMSR":{"id":"components/schemas/P2PEType05TDESDUKPTMSR","kind":"json-schema","title":"P2PEType05TDESDUKPTMSR","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/p2pe-format#tdes-dukpt---format-05"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P2PE Format 05 TDES DUKPT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"required":["data","format","ksn"],"properties":{"data":{"$ref":"#/components/schemas/P2PEData"},"format":{"$ref":"#/components/schemas/P2PEFormatType05"},"ksn":{"$ref":"#/components/schemas/P2PEKSN"}}}},"components/schemas/transactions_authorization_p2pe_tdesdukpt_msr":{"id":"components/schemas/transactions_authorization_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/P2PEDataOnguardSDEEMV":{"id":"components/schemas/P2PEDataOnguardSDEEMV","kind":"json-schema","title":"P2PEDataOnguardSDEEMV","data":{"type":"string","maxLength":2048,"example":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV TLV Data for tags 5A and 57 encrypted with AES 256 DUKPT. Contains the following information, separated by colons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ksn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key serial number (24 byte hex)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"track indicator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating EMV TLV Data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"length"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the encrypted data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encrypted data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted TLV containing tags 57 and 5A"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9"},"children":[]}]}]}]}},"components/schemas/P2PEFormatOnguardSDE":{"id":"components/schemas/P2PEFormatOnguardSDE","kind":"json-schema","title":"P2PEFormatOnguardSDE","data":{"type":"string","minLength":2,"maxLength":2,"enum":["03"],"example":"03","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ingenico Onguard SDE Format"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PEType03OnguardSDEEMV":{"id":"components/schemas/P2PEType03OnguardSDEEMV","kind":"json-schema","title":"P2PEType03OnguardSDEEMV","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/p2pe-format#ingenico-on-guard-sde---format-03"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P2PE Format 03 Ingenico On-Guard SDE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"required":["data","format"],"properties":{"data":{"$ref":"#/components/schemas/P2PEDataOnguardSDEEMV"},"format":{"$ref":"#/components/schemas/P2PEFormatOnguardSDE"}}}},"components/schemas/EMVTlvDataOnguardSDE":{"id":"components/schemas/EMVTlvDataOnguardSDE","kind":"json-schema","title":"EMVTlvDataOnguardSDE","data":{"type":"string","writeOnly":true,"example":"4F07A0000000041010500A4D6173746572436172645F201A546573742F4361726420303920202020202020202020202020205F24032512315F25031511015F2D02656E5F3401018407A0000000041010950508200000009B02C8009F02060000000004449F03060000000000009F34031E03009F3704C5BF918D9F390105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will contain all EMV tags in standard TLV format except tags 5A and 57, which will be sent encrypted in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"p2pe.data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"components/schemas/EMVOnguardSDE":{"id":"components/schemas/EMVOnguardSDE","kind":"json-schema","title":"EMVOnguardSDE","data":{"type":"object","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when processing an EMV transaction without using a UTG."},"children":[]}]}]}]}],"required":["tlvData"],"properties":{"emptyCandidateList":{"$ref":"#/components/schemas/EMVEmptyCandidateList"},"tlvData":{"$ref":"#/components/schemas/EMVTlvDataOnguardSDE"}}}},"components/schemas/transactions_authorization_p2pe_onguardsde_emv":{"id":"components/schemas/transactions_authorization_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2023-124-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/P2PEDataOnguardSDEMSR":{"id":"components/schemas/P2PEDataOnguardSDEMSR","kind":"json-schema","title":"P2PEDataOnguardSDEMSR","data":{"type":"string","maxLength":2048,"example":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track information encrypted with AES 256 DUKPT. Contains the following information, separated by colons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ksn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key serial number (24 byte hex)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"track indicator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = track 1 only"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = track 2 only"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = manual entry"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = dual track"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"length"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the encrypted data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encrypted data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted track/manual entry data"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dual Track Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual entry Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FFFF495A0000000200000006:3:0032:E394820DB97AF927B9B5E05F356750BBF5DFCCB3BC18B87E8FC3C9BC596229E7"},"children":[]}]}]}]}},"components/schemas/P2PEType03OnguardSDEMSR":{"id":"components/schemas/P2PEType03OnguardSDEMSR","kind":"json-schema","title":"P2PEType03OnguardSDEMSR","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/p2pe-format#ingenico-on-guard-sde---format-03"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P2PE Format 03 Ingenico On-Guard SDE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"required":["data","format"],"properties":{"data":{"$ref":"#/components/schemas/P2PEDataOnguardSDEMSR"},"format":{"$ref":"#/components/schemas/P2PEFormatOnguardSDE"}}}},"components/schemas/transactions_authorization_p2pe_onguardsde_msr":{"id":"components/schemas/transactions_authorization_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2023-124-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/CardNumber":{"id":"components/schemas/CardNumber","kind":"json-schema","title":"CardNumber","data":{"type":"string","maxLength":32,"example":"4321000000001119","description":"The payment card number entered in an initial authorization/sale request. This field will always be masked when returned in a response.\n"}},"components/schemas/transactions_authorization_unencryptedcard":{"id":"components/schemas/transactions_authorization_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","clerk","transaction","card","customer"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["entryMode","number","expirationDate","securityCode"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"},"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"present":{"$ref":"#/components/schemas/CardPresent"}}},"customer":{"type":"object","required":["postalCode"],"properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N","securityCode":{"indicator":"1","value":"333"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/ExtendedCardData":{"id":"components/schemas/ExtendedCardData","kind":"json-schema","title":"ExtendedCardData","data":{"type":"string","maxLength":4096,"example":"eyJ0aHJlZURTZWN1cmUiOnsiY3J5cHRvZ3JhbSIgOiAiRUhYRjhoZmpBaVhOQUtJQUFBQldYQUFERWhFUiIsInNlY3VyaXR5TGV2ZWxJbmRpY2F0b3IiIDogIjI0MSJ9LCJjYXJkQnJhbmRUb2tlbiI6eyJyZXF1ZXN0b3JJZCIgOiAiMDEyMzQ1Njc4OTAxIn19","description":"Base64 encoded string received from the i4Go call. This is used to pass extended card information for processing 3D Secure, Apple Pay and Google Pay requests via i4Go.\n"}},"components/schemas/transactions_authorization_3dsecurei4Go":{"id":"components/schemas/transactions_authorization_3dsecurei4Go","kind":"json-schema","title":"Wallet/3D Secure Using i4Go","data":{"title":"Wallet/3D Secure Using i4Go","type":"object","required":["dateTime","amount","clerk","transaction","card","extendedCardData"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"extendedCardData":{"$ref":"#/components/schemas/ExtendedCardData"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"extendedCardData":"eyJjYXJkQnJhbmRUb2tlbiI6eyJyZXF1ZXN0b3JJZCI6IjA0MDAxMDAzMDI3MyJ9LCJ0aHJlZURTZWN1cmUiOnsicHJvZ3JhbVByb3RvY29sIjoxLCJlY29tbUluZGljYXRvciI6NywieGlkIjoiRkU4OTRBN0NDNzI3NDVCRTIyRThBRkMzNjE2OUM2NUI5QkIwMjIxM0NGMTFBNDAzMTI0MjBDNUQ0MDU0RDY5QyIsImNyeXB0b2dyYW0iOiJCRC91UWZVQU9mMythTVVDbHV0eE1BQUNBQUE9Iiwic2VjdXJpdHlMZXZlbEluZGljYXRvciI6MjQxLCJhdXRoZW50aWNhdGlvblNvdXJjZSI6MSwid2FsbGV0SUQiOjEwM319","transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/ThreeDSecureCryptogram":{"id":"components/schemas/ThreeDSecureCryptogram","kind":"json-schema","title":"ThreeDSecureCryptogram","data":{"type":"string","example":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","maxLength":80,"description":"Ecommerce Cryptogram information\n"}},"components/schemas/ThreeDSecureEcommIndicator":{"id":"components/schemas/ThreeDSecureEcommIndicator","kind":"json-schema","title":"ThreeDSecureEcommIndicator","data":{"type":"string","enum":["5","6","7"],"example":"5","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-commerce Indicator as provided by the application generating the cryptogram."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure electronic commerce transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication attempted, non-authenticated security transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-authenticated Security Transaction"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureSecurityLevelIndicator":{"id":"components/schemas/ThreeDSecureSecurityLevelIndicator","kind":"json-schema","title":"ThreeDSecureSecurityLevelIndicator","data":{"type":"string","example":"241","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the electronic commerce indicators representing the security level and cardholder authentication associated with the transaction. This field must be present in all Auth Request messages for electronic commerce transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First 2 positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Channel encryption; cardholder certificate not used (preferred value for Mastercard SecureCode, Identity Check, and all eCommerce)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masterpass-generated transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital Secure Remote Payment (DSRP) with UCAF Data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No security protocol; cardholder certificate not used"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third position:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCAF Data collection is not supported by the merchant; or the merchant supports SecureCode or Identity Check but has chosen not to undertake it on this transaction; or authentication failed and merchant desires to proceed with the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCAF data collection is supported by the merchant and UCAF data must be present and contain an attempt AAV"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCAF data collection is supported by the merchant and UCAF data must be present and contain a fully authenticated AAV"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCAF data collection is supported by the merchant and UCAF (Mastercard assigned Static Accountholder Authentication Value) data must be present. Note that the UCAF Data is required for Static AAV transactions. This value identifies participation in one of the following programs: Maestro Recurring Payments Program, Mastercard Utility Payment Program, Maestro Static AAV for Masterpass"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant has chosen to share authentication data within authorization; UCAF data collection not supported"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureProgramProtocol":{"id":"components/schemas/ThreeDSecureProgramProtocol","kind":"json-schema","title":"ThreeDSecureProgramProtocol","data":{"type":"string","enum":["1","2","3","4","5","6","7","8","9"],"example":"2","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the 3D Secure protocol version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when processing for merchants in the United States. For merchants outside of the United States use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threeDSecure.version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.5"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.6"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.7"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.8"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure Version 2.9"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureVersion":{"id":"components/schemas/ThreeDSecureVersion","kind":"json-schema","title":"ThreeDSecureVersion","data":{"type":"string","enum":["2.0","2.1.0","2.2.0"],"example":"2","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the 3D Secure protocol version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when processing for merchants outside of the United States. For merchants in the United States use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threeDSecure.programProtocol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]}]}},"components/schemas/ThreeDSecureDirectoryServerTranId":{"id":"components/schemas/ThreeDSecureDirectoryServerTranId","kind":"json-schema","title":"ThreeDSecureDirectoryServerTranId","data":{"type":"string","example":"07e54000-2721-4df9-aa51-04fa0e079aa8","maxLength":36,"description":"The Directory Server Transaction ID is generated by the EMV 3DS Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. This field allows the merchant to pass the Directory Server Transaction ID during authorization in order to link authentication and authorization data for Mastercard Identity Check.\n"}},"components/schemas/ThreeDSecureAuthenticationSource":{"id":"components/schemas/ThreeDSecureAuthenticationSource","kind":"json-schema","title":"ThreeDSecureAuthenticationSource","data":{"type":"string","enum":["2"],"writeOnly":true,"example":"2","minLength":1,"maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Source for the cryptogram value."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACS"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureCAVVResult":{"id":"components/schemas/ThreeDSecureCAVVResult","kind":"json-schema","title":"ThreeDSecureCAVVResult","data":{"type":"string","example":"2","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a response field that contains 3–D Secure Electronic Commerce Transaction Response Code that contains the Visa Cardholder Authentication Verification Value (CAVV) or the American Express Verification Value (AEVV) results code."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV not present or CAVV not verified, issuer has not selected CAVV verification option"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV could not be verified or CAVV data was not provided when expected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV failed verification-cardholder authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV passed verification-cardholder authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV passed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 07 from the Issuer Attempts Server indicates that authentication was attempted. Issuer attempts CAVV key was used to generate the CAVV."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV failed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 07 from the Issuer Attempts Server indicates authentication was attempted. Issuer attempts CAVV key was used to generate the CAVV."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved for future use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved for future use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV failed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 07 from Visa Attempts Service indicates that an authentication attempt was performed. Visa attempts CAVV key was used to generate the CAVV. Note that Results Code value of 7 is also valid for American Express SafeKey responses, including those for non-U.S. cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV passed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 07 from Visa Attempts Service indicates that an authentication attempt was performed. Visa attempts CAVV key was used to generate the CAVV. Note that Results Code value of 8 is also valid for American Express SafeKey responses, including those for non-U.S. cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV failed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 08 from Visa Attempts Service indicates that an authentication attempt was performed when the Issuer ACS was not available. Visa attempts CAVV key was used to generate the CAVV. Note that Results Code value of 9 is also for American Express SafeKey responses, including those for non-U.S. cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV passed verification-attempted authentication. A 3-D Secure Authentication Results Code value of 08 from Visa Attempts Service indicates that an authentication attempt was performed when the Issuer ACS was not available. Visa attempts CAVV key was used to generate the CAVV. Note that Results Code value of A is also for American Express SafeKey responses, including those for non-U.S. cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV passed verification-attempted authentication, no liability shift. Only Visa generates this code; issuers do not."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV was not verified-attempted authentication (for Visa use only). If 3-D Secure Authentication Results Code value is 07 in the CAVV and the issuer did not return a CAVV results code in the authorization response, or CAVV results code = 0 in the response message and the CAVV encryption keys do not exist in V.I.P., V.I.P. sets the value to C in CAVV results code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV was not verified-cardholder authentication (for Visa use only). If 3-D Secure Authentication Results Code value is 00 in the CAVV and the issuer did not return a CAVV results code in the authorization response, or CAVV results code = 0 in the response message and the CAVV encryption keys do not exist in V.I.P., V.I.P. sets the value to D in CAVV results code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAVV Unchecked [AX]"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureAuthenticationValue":{"id":"components/schemas/ThreeDSecureAuthenticationValue","kind":"json-schema","title":"ThreeDSecureAuthenticationValue","data":{"type":"string","writeOnly":true,"example":"<Cavv>Y2FyZGluYWxjb21tZXJjZWF1dGg=</Cavv>","maxLength":80,"description":"Used only if both CAVV/UCAF and TAVV present in the transactions token contains the Visa token authentication verification value (TAVV) to support 3-D Secure (3DS) validation for token-based card-on-file, e-commerce, and application-based e-commerce transactions. Visa will allow two separate cryptograms in the authorization; one for token validation (TAVV) and one for cardholder authentication (Cardholder Authentication Verification Value).\n"}},"components/schemas/ThreeDSecureTAVVResult":{"id":"components/schemas/ThreeDSecureTAVVResult","kind":"json-schema","title":"ThreeDSecureTAVVResult","data":{"type":"string","example":"2","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAVVResult (Visa token authentication verification value)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAVV cryptogram failed validation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAVV cryptogram passed validation"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureWalletID":{"id":"components/schemas/ThreeDSecureWalletID","kind":"json-schema","title":"ThreeDSecureWalletID","data":{"type":"string","writeOnly":true,"example":"103","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides information about transactions initiated through the Masterpass Online platform or through the Mastercard Digital Enablement Service (MDES) and identifies the Wallet Provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"103"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"216"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"217"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Samsung Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"327"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant tokenization program"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecure":{"id":"components/schemas/ThreeDSecure","kind":"json-schema","title":"ThreeDSecure","data":{"type":"object","required":["cryptogram","ecommIndicator","securityLevelIndicator","directoryServerTranId","authenticationSource","programProtocol","version"],"properties":{"cryptogram":{"$ref":"#/components/schemas/ThreeDSecureCryptogram"},"ecommIndicator":{"$ref":"#/components/schemas/ThreeDSecureEcommIndicator"},"securityLevelIndicator":{"$ref":"#/components/schemas/ThreeDSecureSecurityLevelIndicator"},"programProtocol":{"$ref":"#/components/schemas/ThreeDSecureProgramProtocol"},"version":{"$ref":"#/components/schemas/ThreeDSecureVersion"},"directoryServerTranId":{"$ref":"#/components/schemas/ThreeDSecureDirectoryServerTranId"},"authenticationSource":{"$ref":"#/components/schemas/ThreeDSecureAuthenticationSource"},"cavvResult":{"$ref":"#/components/schemas/ThreeDSecureCAVVResult"},"authenticationValue":{"$ref":"#/components/schemas/ThreeDSecureAuthenticationValue"},"tavvResult":{"$ref":"#/components/schemas/ThreeDSecureTAVVResult"},"walletID":{"$ref":"#/components/schemas/ThreeDSecureWalletID"}}}},"components/schemas/CardBrandTokenRequestorID":{"id":"components/schemas/CardBrandTokenRequestorID","kind":"json-schema","title":"CardBrandTokenRequestorID","data":{"type":"string","writeOnly":true,"example":"12345678901","maxLength":12,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field uniquely identifies the pairing of token requestor with the token domain. It is assigned by the token service provider and is unique within the token vault."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay requests, this is mapped from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token.paymentData.data.deviceManufacturerIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}]}},"components/schemas/CardBrandTokenAssuranceLevel":{"id":"components/schemas/CardBrandTokenAssuranceLevel","kind":"json-schema","title":"CardBrandTokenAssuranceLevel","data":{"type":"string","readOnly":true,"example":"01","maxLength":2,"description":"This is a response field defined by the token service provider. This Visa, Discover, or Mastercard value indicates the assigned confidence level of the token-to-PAN/cardholder binding.\n"}},"components/schemas/CardBrandTokenPANLast4":{"id":"components/schemas/CardBrandTokenPANLast4","kind":"json-schema","title":"CardBrandTokenPANLast4","data":{"type":"string","readOnly":true,"example":"6810","maxLength":4,"description":"This is a response field that contains 4 characters that represent the last 4 digits of the actual cardholder PAN.\n"}},"components/schemas/CardBrandTokenAcctRangeStatus":{"id":"components/schemas/CardBrandTokenAcctRangeStatus","kind":"json-schema","title":"CardBrandTokenAcctRangeStatus","data":{"type":"string","readOnly":true,"example":"N","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a response field contains a one-character value that indicates the Visa regulatory status of the actual card number for which the token represents."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"space"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank/no value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regulated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-Regulated"},"children":[]}]}]}]}]}]}]}},"components/schemas/CardBrandToken":{"id":"components/schemas/CardBrandToken","kind":"json-schema","title":"CardBrandToken","data":{"type":"object","required":["requestorId"],"properties":{"requestorId":{"$ref":"#/components/schemas/CardBrandTokenRequestorID"},"assuranceLevel":{"$ref":"#/components/schemas/CardBrandTokenAssuranceLevel"},"panLast4":{"$ref":"#/components/schemas/CardBrandTokenPANLast4"},"acctRangeStatus":{"$ref":"#/components/schemas/CardBrandTokenAcctRangeStatus"}}}},"components/schemas/transactions_authorization_3dsecurecardnumber":{"id":"components/schemas/transactions_authorization_3dsecurecardnumber","kind":"json-schema","title":"3D Secure Using Card Number","data":{"title":"3D Secure Using Card Number","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_authorization_3dsecuretoken_gtv":{"id":"components/schemas/transactions_authorization_3dsecuretoken_gtv","kind":"json-schema","title":"3D Secure Using GTV Token","data":{"title":"3D Secure Using GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_authorization_3dsecuretoken_legacy":{"id":"components/schemas/transactions_authorization_3dsecuretoken_legacy","kind":"json-schema","title":"3D Secure Using Legacy TrueToken","data":{"title":"3D Secure Using Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/ThreeDSecureAuthenticationSourceWallet":{"id":"components/schemas/ThreeDSecureAuthenticationSourceWallet","kind":"json-schema","title":"ThreeDSecureAuthenticationSourceWallet","data":{"type":"string","enum":["1"],"writeOnly":true,"example":"1","minLength":1,"maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Source for the cryptogram value."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inApp"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureCryptogramWallet":{"id":"components/schemas/ThreeDSecureCryptogramWallet","kind":"json-schema","title":"ThreeDSecureCryptogramWallet","data":{"type":"string","example":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","maxLength":80,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ecommerce Cryptogram information"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token.paymentData.data.paymentData.onlinePaymentCryptogram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Google Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodDetails.cryptogram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Samsung Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3DS.data.cryptogram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"components/schemas/ThreeDSecureEcommIndicatorWallet":{"id":"components/schemas/ThreeDSecureEcommIndicatorWallet","kind":"json-schema","title":"ThreeDSecureEcommIndicatorWallet","data":{"type":"string","enum":["5","6","7"],"example":"5","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-commerce Indicator as provided by the application generating the cryptogram."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure electronic commerce transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication attempted, non-authenticated security transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-authenticated Security Transaction"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token.paymentData.data.paymentData.eciIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Google Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodDetails.eciIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Samsung Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3DS.data.eci_indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"components/schemas/ThreeDSecureSecurityLevelIndicatorWallet":{"id":"components/schemas/ThreeDSecureSecurityLevelIndicatorWallet","kind":"json-schema","title":"ThreeDSecureSecurityLevelIndicatorWallet","data":{"type":"string","writeOnly":true,"example":"241","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the electronic commerce indicators representing the security level and cardholder authentication associated with the transaction. This field must be present in all Auth Request messages for electronic commerce transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay and Google Pay transactions this value should be sent as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"241"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First 2 positions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital Secure Remote Payment (DSRP) with UCAF Data"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third position:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UCAF data collection is supported by the merchant and UCAF data must be present and contain an attempt AAV"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureXIDWallet":{"id":"components/schemas/ThreeDSecureXIDWallet","kind":"json-schema","title":"ThreeDSecureXIDWallet","data":{"type":"string","example":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","maxLength":80,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique tracking number set by the merchant and sent to the Issuer Authentication/Service in the Authentication Request message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token.transactionIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Google Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messageId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Samsung Pay transactions this is mapped from the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3DS.data.utc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"components/schemas/ThreeDSecureProgramProtocolWallet":{"id":"components/schemas/ThreeDSecureProgramProtocolWallet","kind":"json-schema","title":"ThreeDSecureProgramProtocolWallet","data":{"type":"string","enum":["1","2"],"writeOnly":true,"example":"2","maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Program Protocol must be provided by the merchant if they are participating in Mastercard 3D Secure and have previously authenticated using the Mastercard Identity Check or SecureCode program. It identifies the type of 3D-Secure program."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV 3-D Secure [3DS 2.0]"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay and Google Pay transactions this should always be sent as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ThreeDSecureWallet":{"id":"components/schemas/ThreeDSecureWallet","kind":"json-schema","title":"ThreeDSecureWallet","data":{"type":"object","properties":{"authenticationSource":{"$ref":"#/components/schemas/ThreeDSecureAuthenticationSourceWallet"},"cryptogram":{"$ref":"#/components/schemas/ThreeDSecureCryptogramWallet"},"ecommIndicator":{"$ref":"#/components/schemas/ThreeDSecureEcommIndicatorWallet"},"securityLevelIndicator":{"$ref":"#/components/schemas/ThreeDSecureSecurityLevelIndicatorWallet"},"xid":{"$ref":"#/components/schemas/ThreeDSecureXIDWallet"},"programProtocol":{"$ref":"#/components/schemas/ThreeDSecureProgramProtocolWallet"},"walletID":{"$ref":"#/components/schemas/ThreeDSecureWalletID"}}}},"components/schemas/transactions_authorization_applepay":{"id":"components/schemas/transactions_authorization_applepay","kind":"json-schema","title":"Apple Pay","data":{"title":"Apple Pay","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecureWallet"},"cardBrandToken":{"type":"object","properties":{"requestorId":{"$ref":"#/components/schemas/CardBrandTokenRequestorID"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"authenticationSource":"1","cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","walletID":"103"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_authorization_googlepay":{"id":"components/schemas/transactions_authorization_googlepay","kind":"json-schema","title":"Google Pay","data":{"title":"Google Pay","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecureWallet"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"authenticationSource":"1","cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","walletID":"216"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/AmountTotalIncremental":{"id":"components/schemas/AmountTotalIncremental","kind":"json-schema","title":"AmountTotalIncremental","data":{"type":"number","maxLength":14,"example":160,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When processing an incremental authorization the high balance amount must be sent.  For example, if the original authorization is $100 and the transaction is being incremented  by $60 then the total amount would be sent as $160."},"children":[]}]}]}]}},"components/schemas/AmountIncremental":{"id":"components/schemas/AmountIncremental","kind":"json-schema","title":"AmountIncremental","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with a $20 tip and $8 tax would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"128.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount  fields can specify up to three decimal places. However, the number of decimal  places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total","tax"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotalIncremental"},"tax":{"$ref":"#/components/schemas/AmountTax"},"taxIndicator":{"$ref":"#/components/schemas/AmountTaxIndicator"},"tip":{"$ref":"#/components/schemas/AmountTip"},"surcharge":{"$ref":"#/components/schemas/AmountSurcharge"}}}},"components/schemas/TransactionInvoiceIncremental":{"id":"components/schemas/TransactionInvoiceIncremental","kind":"json-schema","title":"TransactionInvoiceIncremental","data":{"type":"string","maxLength":10,"example":"0510093358","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10-digit invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway. For incremental authorizations the invoice must match the invoice from the original authorization request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Although the invoice number is sent as a JSON string it is a numeric value. No alpha characters are allowed."},"children":[]}]}]}]}]}},"components/schemas/transactions_authorization_incremental":{"id":"components/schemas/transactions_authorization_incremental","kind":"json-schema","title":"Incremental","data":{"title":"Incremental","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountIncremental"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceIncremental"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"authType":{"$ref":"#/components/schemas/TransactionAuthType"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"mPos":{"$ref":"#/components/schemas/mPOS"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192029"}}}},"components/schemas/CardExpirationDateResponse":{"id":"components/schemas/CardExpirationDateResponse","kind":"json-schema","title":"CardExpirationDateResponse","data":{"type":"integer","minLength":3,"maxLength":4,"format":"MMYY","example":1230,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Requires API Option \"RETURNEXPDATE\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card expiration date in MMYY format. This value will only be populated if \"RETURNEXPDATE\" is included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]}},"components/schemas/CardLevelResult":{"id":"components/schemas/CardLevelResult","kind":"json-schema","title":"CardLevelResult","data":{"type":"string","readOnly":true,"example":"2C","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of card used in an authorization/sale request. This field is returned in a response if the data is provided by the processor. See [Card Level Results]/guides/appendices/card-level-results) for a complete list of values."},"children":[]}]}]}]}},"components/schemas/CardMaskedNumber":{"id":"components/schemas/CardMaskedNumber","kind":"json-schema","title":"CardMaskedNumber","data":{"type":"string","maxLength":32,"example":"XXXXXXXXXXXX1119","description":"The card number field will always be masked when returned in a response.\n"}},"components/schemas/CardTypeResp":{"id":"components/schemas/CardTypeResp","kind":"json-schema","title":"CardTypeResp","data":{"type":"string","enum":["AX","AP","BC","CI","DB","GC","JC","MC","NS","PL","SC","VS","WP","YC"],"example":"VS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An abbreviation used to specify the type of card that was used when processing a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AX"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"American Express"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alipay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backed Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CI"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Citgo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover/JCB/Novus"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Private Label"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sears Canada"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WeChat Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IT’S YOUR CARD"},"children":[]}]}]}]}]}]}]}},"components/schemas/BalanceAmount":{"id":"components/schemas/BalanceAmount","kind":"json-schema","title":"BalanceAmount","data":{"type":"number","readOnly":true,"maxLength":14,"example":24.33,"description":"The balance remaining on the card.  Depending on which processor is being used, the balance may be returned for a gift card, debit card, EBT card, or other stored value card.\n"}},"components/schemas/CardBalance":{"id":"components/schemas/CardBalance","kind":"json-schema","title":"CardBalance","data":{"type":"object","readOnly":true,"properties":{"amount":{"$ref":"#/components/schemas/BalanceAmount"}}}},"components/schemas/CardSecurityCodeResponse":{"id":"components/schemas/CardSecurityCodeResponse","kind":"json-schema","title":"CardSecurityCodeResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned if card.securityCode was sent in the request."},"children":[]}]}]}]}],"properties":{"result":{"$ref":"#/components/schemas/CardSecurityCodeResult"},"valid":{"$ref":"#/components/schemas/CardSecurityCodeValid"}}}},"components/schemas/CardTokenResponse":{"id":"components/schemas/CardTokenResponse","kind":"json-schema","title":"CardTokenResponse","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/CardTokenValue"}}}},"components/schemas/CardDebitType":{"id":"components/schemas/CardDebitType","kind":"json-schema","title":"CardDebitType","data":{"type":"string","enum":["girocard","eftpos","Interac","Visa Interlink","Visa US Common Debit","Maestro Int'l","Maestro US Common Debit","Amex US Common Debit","Discover US Common Debit","DNA Debit","UnionPay"],"example":"girocard","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of debit card that was used when processing a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DB"},"children":[]}]}]}]}},"components/schemas/CardBinResponseRETURNBIN":{"id":"components/schemas/CardBinResponseRETURNBIN","kind":"json-schema","title":"CardBinResponseRETURNBIN","data":{"type":"string","readOnly":true,"maxLength":8,"example":"541333","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Requires API Option \"RETURNBIN\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first 6 or 8 digits of the card."},"children":[]}]}]}]}},"components/schemas/CustomerFirstNameResponse":{"id":"components/schemas/CustomerFirstNameResponse","kind":"json-schema","title":"CustomerFirstNameResponse","data":{"type":"string","maxLength":30,"example":"John","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a consumer’s first name. This field is returned whenever the customer name is supplied in the request or if the track/EMV data contains the cardholder name."},"children":[]}]}]}]}},"components/schemas/CustomerLastNameResponse":{"id":"components/schemas/CustomerLastNameResponse","kind":"json-schema","title":"CustomerLastNameResponse","data":{"type":"string","maxLength":30,"example":"Smith","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a consumer’s last name. This field is returned whenever the customer name is supplied in the request or if the track/EMV data contains the cardholder name."},"children":[]}]}]}]}},"components/schemas/ClerkResponse":{"id":"components/schemas/ClerkResponse","kind":"json-schema","title":"ClerkResponse","data":{"type":"object","properties":{"numericId":{"$ref":"#/components/schemas/ClerkNumericId"}}}},"components/schemas/DCCTransactionResponse":{"id":"components/schemas/DCCTransactionResponse","kind":"json-schema","title":"DCCTransactionResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing Dynamic Currency Conversion (DCC) information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned in the response if DCC was offered during the payment flow of a UTG/Commerce Engine controlled device or if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dcc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object was included in the request."},"children":[]}]}]}]}],"required":["rateTimeStamp","currencyCode","foreignAmount","conversionRate","marginPercentage","currencyMinorUnits","transactionId","conversionIndicator"],"properties":{"rateTimeStamp":{"$ref":"#/components/schemas/DCCRateTimeStamp"},"currencyCode":{"$ref":"#/components/schemas/DCCCurrencyCode"},"foreignAmount":{"$ref":"#/components/schemas/DCCForeignAmount"},"conversionRate":{"$ref":"#/components/schemas/DCCConversionRate"},"marginPercentage":{"$ref":"#/components/schemas/DCCMarginPercentage"},"currencyMinorUnits":{"$ref":"#/components/schemas/DCCCurrencyMinorUnits"},"transactionId":{"$ref":"#/components/schemas/DCCTransactionID"},"conversionIndicator":{"$ref":"#/components/schemas/DCCConversionIndicator"},"diffOverEcb":{"$ref":"#/components/schemas/DCCDiffOverECB"},"marginOverEcb":{"$ref":"#/components/schemas/DCCMarginOverECB"},"displayUnit":{"$ref":"#/components/schemas/DCCDisplayUnit"},"provider":{"$ref":"#/components/schemas/DCCProvider"}}}},"components/schemas/DeviceTerminalIdRequired":{"id":"components/schemas/DeviceTerminalIdRequired","kind":"json-schema","title":"DeviceTerminalIdRequired","data":{"type":"string","maxLength":32,"example":"1742","description":"To prompt a specific UTG-controlled PIN pad in a request, the API Terminal ID configured in UTG TuneUp must be specified in this field.\n"}},"components/schemas/DeviceOnlyTIDResponse":{"id":"components/schemas/DeviceOnlyTIDResponse","kind":"json-schema","title":"DeviceOnlyTIDResponse","data":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}}},"components/schemas/EMVTlvDataResponse":{"id":"components/schemas/EMVTlvDataResponse","kind":"json-schema","title":"EMVTlvDataResponse","data":{"type":"string","readOnly":true,"example":"910A0102030405060708090A","description":"This field will contain the EMV response tags in standard TLV format.\n"}},"components/schemas/EMVResponse":{"id":"components/schemas/EMVResponse","kind":"json-schema","title":"EMVResponse","data":{"type":"object","description":"Returned when processing a full EMV or EMV fallback transaction.\n","properties":{"fallback":{"$ref":"#/components/schemas/EMVFallback"},"tlvData":{"$ref":"#/components/schemas/EMVTlvDataResponse"}}}},"components/schemas/Receipt":{"id":"components/schemas/Receipt","kind":"json-schema","title":"Receipt","data":{"type":"object","properties":{"key":{"type":"string","maxLength":100,"example":"ApplicationIdentifier","description":"The identifier the interface vendor can use to programmatically determine where to print a specific value.\n"},"printName":{"type":"string","maxLength":100,"example":"AID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label that relates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"printValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. When present in the response, this must be printed to the left of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"printValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"printValue":{"type":"string","maxLength":350,"example":"AID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value that relates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"printName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. This must be printed to the right of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"printName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ReceiptArray":{"id":"components/schemas/ReceiptArray","kind":"json-schema","title":"ReceiptArray","data":{"type":"array","items":{"$ref":"#/components/schemas/Receipt"},"example":[{"key":"ApplicationIdentifier","printName":"AID","printValue":"A0000000031010"},{"key":"TerminalVerificationResults","printName":"TVR","printValue":"8000"},{"key":"IssuerApplicationData","printName":"IAD","printValue":"06010A03A40002"},{"key":"TransactionStatusIndicator","printName":"TSI","printValue":"E800"},{"key":"AuthorizationResponseCode","printName":"ARC","printValue":"00"},{"key":"TransactionCurrencyCode","printValue":"USD$"},{"key":"ApplicationLabel","printValue":"CREDITO DE VISA"}],"description":"Array of receipt key/value pairs that should be printed on the receipt.\n"}},"components/schemas/MerchantMID":{"id":"components/schemas/MerchantMID","kind":"json-schema","title":"MerchantMID","data":{"type":"number","maxLength":10,"example":15877,"description":"The merchant ID associated with the merchant account.\n"}},"components/schemas/MerchantName":{"id":"components/schemas/MerchantName","kind":"json-schema","title":"MerchantName","data":{"type":"string","maxLength":22,"example":"Merchant XYZ","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant’s business name as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantResponse":{"id":"components/schemas/MerchantResponse","kind":"json-schema","title":"MerchantResponse","data":{"type":"object","properties":{"mid":{"$ref":"#/components/schemas/MerchantMID"},"name":{"$ref":"#/components/schemas/MerchantName"}}}},"components/schemas/SignatureData":{"id":"components/schemas/SignatureData","kind":"json-schema","title":"SignatureData","data":{"type":"string","maxLength":4194304,"example":"iVBORw0KGgoAAAANSUhEUgAAA2kAAAEhCAYAAADlHOiOAAAABHNCSVQICAgIfAhkiAAAAAFzUkdCAK7OHOkAAAAEZ0FNQQAAsY8L/GEFAAAACXBIWXMAAA7EAAAOxAGVKw4bAACN0ElEQVR4Xu2dB5hU5dn3T97yJXnVqDTBWAABC2KhiFERUDQWLKioUWNAETQqRjT2CoioUbFFrNhBNEFFLIhSrIhiAaQEEI0NgdjzJvne99tvf7fc6zNnzu7OLjs7Z2b+v+s61+zOzsyeOeV57v/dnh9VVBIJIYQQQgghhEgF/7b2UQghhBBCCCFECpBIE0IIIYQQQogUIZEmhBBCCCGEEClCIk0IIYQQQgghUoREmhBCCCGEEEKkCHV3FEIIIYQQJc2//vWv6L//+7+jf/zjH9HXX38dbbDBBtF//ud/Rj/5yU9s+/d///e1rxQiHUikCSGEEEKIkuT//t//a8Ls008/jc4///xo9uzZ0f/7f/8v+tGPfhRtttlm0XHHHRcdf/zx0frrry+hJlKFRJoQQgghhCg5iJ4hzm699dbo6aefjpYvX27RNBdp//Ef/2ERtYsuuig68cQTTajxvBBpQCJNCCGEEEKUFAi0L7/8MjrppJOimTNnRn//+9+j//3f/43iZi9CrWnTptHEiROj7t27R//n//yftX8RorCocYgQQgghhCgZEGiffPJJNGjQoGj69OnRt99+G/3P//xPlkADnv/uu++i8ePHR//85z/XPitE4ZFIE0IIIYQQJQGi65tvvokuvPDCaMaMGRZBI72xJqhb++ijj+y9QqQFiTQhhBBCCFH0kM5I1Gz06NHRlClTchJoQITNNyHSgkSaEEIIIYQoahBjiDJqy+6++25LYcxFoMG//du/VW1CpAVdjUIIIYQQoqihnuzFF1+0KBrRNKJqIXRt9C0Orfd33nlnteAXqUIiTQghhBBCFC00Cvnqq6+iM88801ruU2MWQgfH9dZbL9p+++0TuzeyqPXPf/5zexQiLUikCSGEEEKIosTr0IYMGWIdHeMdGomOsf7Z2WefHQ0ePNgEWwiRNYRbly5dsv4mRCGRSBNCCCGEEEUHjT6oQxs3blw0a9YsW6g6hBqz//qv/4r69+8fDRgwIPrss8+y0h0RcZtttpltSncUaUIiTQghhBBCFB1Ezd56663olltuyerk6AKtZ8+e0RVXXBH95Cc/iZYtW5aVCkmKI1G0H//4x4n1akIUCok0IYQQQghRVLCm2ddffx2dddZZFiGLiy9SGHffffdozJgx0QYbbGDPLVmyJGstNMRbr169TKQJkSYk0oQQQgghRNFAxIwW+9dcc40Jr3gdGgJtww03jC644IJo0003tTRGFqtmC6NtPN+0adOoW7duahoiUodEmhBCCCGEKBq83f4999xjaY7hItSkOdLJcezYsdZWnwgZ0bNFixZZF8jwtYg5omjNmjVTPZpIHRJpQgghhBCiKCCtkTb7RNHi66G5QDvwwAOtFo2aNOrMEHUzZ87MiriR6ti7d+/opz/96dpnhEgPEmlCCCGEECL1eDdHBBoNQ4iMhRA1++Uvfxlde+21JtYQbbwHcfbmm29m1K3xN69HU6qjSCMSaUIIIYQQIvX84x//iObOnRs98sgj1m4/nrpIHdoZZ5wR/exnP6sSXqQ6Lly4MPrwww8zom78nWgbQg3BJkTa0FUphBBCCCFSDWKLLo6//e1vrWlIUprjfffdF+20004m2ByiaDNmzLDHUNQhzrp27aqujiK1SKQJIYQQQojUQkdG0hyJoH3yyScZtWXUnCG4evToYaLL69AAUUb0bc6cOVnvQZxRuxYKOiHShESaEEIIIYRILdSSvfzyy9F1111naY4hpC22a9fO6tRCgQZE20h1pB4tXB+N92y55ZZR8+bNo//4j/9Y+6wQ6UIiTQghhBBCpBLE1TfffGPt9lm8OhRbtM1ff/31o9NOO83WQ4tHxWgs8sEHH5iwC9dHI4rGe5TqKNKMRJoQQgghhEglpCveeuut0dSpU7O6OZLm+Otf/zo6/PDD7ec4pDiSIhmmOlK/RsStdevWEmki1UikCSGEEEKI1OFRNEQazULCaBhRs1atWkUDBgywaFp8MWreu2rVquj111/PaL1PemOXLl2ibbfdVgtYi1QjkSaEEEIIIVIFggxh9oc//MEWrQ7THL2b42WXXWb1aEl1ZUTdnnzyyaxURyJue+21V1b9mhBpQyJNCCGEEEKkCqJfr7zySvTAAw9kNQshTZFFq/fbb7/opz/9aZbYoqsj76H1PumSDq9DpKmroygGJNKEEEIIIURqoCsj0bM//elP9hhfhLply5bRKaecYtG0pIWoeT0NQ0h1DCNwvHe77bZTV0dRFEikCSGEEEKI1ECjDyJokyZNymgWQiSMyBkCLb5odQjvnz59emKq41FHHaWGIaIokEgTQgghhBCpwKNoCDRq0sIoGuKqffv20RFHHJGY5gie6kg9WryrY7NmzaJddtlFIk0UBRJpQgghhBCi4LjAQqC98847GV0ZEWQ0+7j55pst3bG6dEXSGxcsWBC99957Ge/3VEcWsVZXR1EMSKQJIUQZgPGDRxoDhkd+F0KINMH4tHTp0ujyyy+P/v73v1eNU97wgxTHDh061BgJo1GIpzqG4xzv79u3b7UROCHShkSaEEKUMAgyUobWrFkTvfvuu9Fzzz0XzZs3L/r666+zFoYVQohCgrC6//77bW20MApG5Ktt27bRJZdcUqPIov4sKdWR9xOFO+igg9TVURQNEmlCCFGiIMK++uqr6M4774wOOOAA21j4lcfTTz89+vjjjzMMGSGEKBSMV59++mn04IMPZrTNB6JgtNwnklZTFA1hR0fHFStWZHR1RJgRRUOoKdVRFAsSaUIIUYJgrGDwnHHGGZY6RH3H559/Hq1atcoeH3vssWjQoEH2mtBjLYQQjY3Xoo0YMSKr5T61Zy1atIiOPfbYWlMVEXeTJ0/OSHXk9byPKBpiT4hiQSJNCCFKDDzIpAuNGjUqeuKJJyy1ESHmRgspQaRAzpkzJ7r66qvNoBFCiELB+EQtGunY8cWnEVj9+vWLttpqqxrXNkPYUcdGPVqYys17WrdubV0daR4iRLEgkSaEECUEhgqe6CuvvDKaOHGiGS3hOkGOe64ff/xxi64lvUYIIfKNj0XXX3+9OY/CsQiB1aZNm2jIkCG1RtEQeg8//HC0evXqjEicpzry/qSFr4VIK7pahRCiRHBj55FHHonuvvvurLShOPwNj/PChQtrfJ0QQuQLxNWyZcuiV199NatGFmF12GGHWcv9mqJgjH04pObPn5+RGYCoI8WxW7duWhtNFB0SaUIIUSJg4Lz11lvR6NGjaxVoDsbNypUr7VEIIRoTdyzdfvvtVisbjlmIMmrRBg8eXGstGe/74IMPoilTpmQ0DOEzPNWxplRJIdKIRJoQQpQApAjhSb7sssvq1AyE9J927dopDUgI0eggqJYvXx5NmzYtq6MjUTTSHDfYYINaBRYOqhdeeMEEXyj0EHc0SKKro8Y4UWzoihVCiBKAtMWXX37Zujjm2lYfwwcjZtttt1VbaiFEo+JRNOpik6Jom2yySXTcccfVGkXjcxB4M2bMyBB6jGnNmjWLunfvrlRHUZRIpAkhRJHjxg7roRFNyyV10bum0aIfL3NNBflCCNHQIMref//96KGHHkqMog0bNixaf/31a3UgEY0j1ZFutfG10RBopDvKCSWKEYk0IYQocsLC+7D1dE3gWe7QoUN0+OGH1+qpFkKIhgZhRvSfmthQXBHhpxatT58+OY1NfA5LjcQ72fLeo446ygSfnFCiGJFIE0KIIgcj5YYbbrBoWi6t9PEwt2rVKrr22mstpUgF9UKIxoRxilb511xzjbXdD0FUsXA1Qq22CJhnEdB6P4zGUX+GSNPaaKKYkUgTQogihijaZ599Fs2bNy8rZSgJBBkpRCNHjow6d+6sKJoQotEh4j9p0qToww8/tLRHxBYb4oo6smOOOcbEWm3wOQsWLLC1HsNoHJkCvXv3ts9QwxBRrOjKFUKIIoYmIdSiUdtRWxQNY2W99daLTj/99OiAAw5QLZoQotFBjJGa+OyzzybWz/bs2TPnCD/jH2tChg4qxjTGNro6ygklihmJNCGEKFLwHLMeGu2rSflJMngcbxSy//77m0hDrMnDLIRobIj+E/mfO3dulpOIMWnAgAE5iSsicIg9ImlhR1vEXceOHW0jtVuIYkUztBBCFCmk+ngULWxfnYQ3CiHNkXRH1aEJIQqBN/pwxxJCjY3aMSL8jFO51JEh9p588knr7BhvGLLXXnspU0AUPRJpQghRhGCUUHBPR8faomh4kzfddFMTdDzKuyyEKAQ4k6gfmzx5ckb0CzH1s5/9LBo4cGC08cYb5ySuGPemT5+esewIkTgyBujqqLXRRLEjkSaEEEUIXuTZs2dHr7/+ekbBfBw80hg/Y8aMMQ+1DBchRKFAmD3//PNZjT4Yp9q0aRPttttuOUXREHtE5BBpjIUO76WjY/PmzZUtIIoeiTQhhChCMFAmTJiQtTZQCO2rqT0bMWKEFePjYVb6jxCiUDBu0S6fKFgIKYo0+iBFMZdaWT7n0UcftWyCeKpj37591TBElAQSaUIIUWTggf7888+tYL66xasRYxg8/fv3t9SfXI0fIYTIB0S8GLfmz5+fEf3CmUTka++9985JXJHa+NVXX0Xjxo2LvvnmG/udjfGtadOm1npfGQOiFNCMLYQQRQbCbMqUKVkF8yEYOzvvvLM1CiGaVtuisEIIkU+Ift14441ZNbQIKhp9INRyGadIdVy4cGG0ZMmSjM/hZ9Z+zGURbCGKAYk0IYQoIjBEMHJee+21ahuG0BikVatW0R133GH1aLnUeAghRL5AWJGayLiFWHOI+JOG/atf/coec4H3L1q0KCt1m0hartE4IYoBiTQhhCgiSHUkzXHGjBkZKUNOWIdGJ0el/QghCg1jlbfLD5cL8YYh22+/fU7OJJxSNB+599577TMRamyMe5tttlm03377qXutKBkk0oQQoojAQPG20/FUR/dKH3HEEbZoda6eaSGEyCdE/elGG4/+E/UaOnRozk2NcFKtWLHCxF7opOJzDj300Jzb9wtRDEikCSFEkYAoQ5wh0sI1hhw8yO3atYvOPfdci6apUYgQotAQOVu9erXV0SY1DOnUqVPOKYqMe0TkQrHnzqk+ffoo1VGUFJrBhRCiSMDAQaCR7hhfGw2DZ/3114+GDx8etWzZUnVoQohU4NF/hFWY6ohTiU6MW265ZU4OJXdSxRfCZj207bbbztZH09poopSQSBNCiCIgbBiCoRKmDLkn+fjjj4969Oghb7IQIhUwTtHog+hXUsMQujrWJdWRxftJdQydVIx3/jnKHhClhK5mIYQoAvBAU4vBQrDxtdHwSLdv3z469dRTtR6aECI1eA0Z0f94qiMRNCJpuUb9EXk0TOLRnVSMdYizgw46SE2SRMmhmVwIIVIOaT60r3722Wejb7/9NiNlCCOF+rPLLrtMaY5CiFThNWTUpIWNjhBUCLRcnUq8l0yCeD0u6Y1du3aNtthiC6U6ipJDIk0IIVIORsnLL78cXXfddRkpQ4Cxs++++0Z77LGH0hyFEKnBUx0RVkmpjnWJfhGFI4oWb+HPmEctWq4pk0IUExJpQgiRYkgXWrlyZXT11VdHX3/9dUYtBh5oPNGDBw9WmqMQIlUwViGq3nvvvYxxyxt9sNUl1THewp/xDpF21FFHKdVRlCSa0YUQIqVgjNAk5NFHH43efvvtrFo0jJ3u3bvbQrBawFUIkSY81TGsIQNv9IFjKZfoF6mOa9asiZ566qmMujYEHlG0Fi1aKNVRlCQSaUIIkVIwbubOnWtRtKSOjhg5rA2Uq7EjhBCNAWMVUS9v9OEwTiHSjjzyyJyjXzin5s+fH61atSojIkeK49FHH600b1GySKQJIUQKwTD55JNPoiFDhkTffPNNhnECeI47duxodR2Kogkh0gR1YwsXLrQtnupIV8dmzZrlHP1C5NHVFtHn8F4+g0wCjX/1gznmq6++ij7//PPob3/7mx3fsLmLKDwSaUIIkTIwcL788svoggsuMKEWdjNzPNWnefPmSvURQqQKxixq0cIaMvAoWq7RLwQeIuKFF17ISPdm/Ovbt68JNdr5i9xhfqFLMEsjDBw4MOrSpUvUs2fPaNasWYlzjSgcEmlCCJEiMGjwbo4ZMyZ64oknrPV+HG8YghdZBfNCiLSBsf/II49kGP2MW6QoUo+Wq0jj/RMmTMiK8vA5OKmU6pg7iDPmE5ZDGDt2rAkzlnX59NNPo6VLl0Znn312RrRSFB6JNCGESBEYJW+88UZ0ww03VBXch55owIvMGkMYO7l2RxNCiMaA6Bf1Y/EFrIn4+5pmuUS/GPcYA+fMmZNR18bnNG3atE4LYZcrHEPmFBx/77//fvTAAw+YOBsxYoQ1Y3Hxy3kieyOeVi8Ki0SaEEKkBK9DYwINjRsIhRreY6JoarsvhEgbjGMTJ06scjI5RP3rsqYZgoEW/oi0UDxQg0aqI5+j8S8bRBfCjCVbEMuvvPJKdOqpp0b7779/dO6555pYC+ucEb3rr79+tOuuuyozI2Xo6hZCiBTAhEmdwMUXXxy98847GQu2hmCUNGnSxLzIKpgXQqQNxBn1aGH0y7s6HnjggTmPWwiNyZMnZ6Q68jmIM8Y/pTp+77xjruBYMX8QHVu+fHk0derUaPjw4RY169+/fzRp0iSrQUO4uQOQaCbHkvnkzDPPjK699lr7XaSHH1We4Mw8GiGEEI2KF3Jff/31luaIlxOjJD48u6Gzzz77RPfcc0+00UYb5eSRFkKIxoCxDJGAOKDhh4sr0hJ/8Ytf2JqPpCrWNm7xPmqnaDLy6quvVgkLPqdTp062ZhpNQ8opksaxZcOhx8YxYSPauHjxYlvsm8jZyy+/bAIZ4UZUM4xCAscMoUz07JBDDomOP/74aMcdd7TMDDWhShcSaUIIUUAYginmpjj+vPPOM0+nT6rh8OxGzcYbbxyNGzcu2nfffeVJFkKkCsTB/fffb2l11Dg5CIKzzjrLNn6uDQTGY489Fp122mnWHt7Hwg022CAaNmxYzp9TLPD9EKaIsPgj8wGPHM+333676vGjjz6K3nrrLRNqXk+GyPL3xuFvpDOut956Vs987LHHRrvttpv9jviVwy99SKQJIUQBIZWH1CA8xky67jEGH5598mSSbdu2rbVKLjcvshAi/SAWzjnnHGtQEaY7Ej2j2+Puu++eU7MPGl1cfvnl0W233VbVcZBxkCVHZs6cGW211VZFEfVx8RUKr/BnhJX/TodFHkl35zkcdjznoozXhhtzhX9OaMqHYotjRNSMNEbOAYt/I9CIRhI541xoHkkvEmlCCFEg8BYjzKjT+PDDD7NqOJh8wwkXz7F7kfEoCyHKAwxyxApjBIY5hjUGNgY40RHqiwptbDNekW5HquOyZctsPyF0LiGywjEtCd5H/dQBBxxgTS4QJMD3JPKD2KOOqrHATPbNBRGP/jP7688B+xu+lhb3bIiuzz77zB5JaUeA8VpEmb+HR97n4otHf84/PwneC1wDHCc2rg+EGQ7Abt26VTVtIQODc1LbeRCFRyJNCCEKAEYXnRxJ55k+fXr097//fe1fvi/oZnJmEg0nX6Jn1GLgBc3FGy2EKH6oK8LIv/rqq62Rho8NW2+9tTWFoKU9P5MKjXGOcCuEEc5+0rBiwIABlqLoIAxOPvnk6JJLLok23HDDtc9m42Mdzqs///nPNjYSRXJ+9rOf2fqRhx56aFWDC94TFy8855/ljxA+D/67P8cjnxU+Tyo6ESdEFcITkYnQQmCxDytXrrT38Df/nfOD8PL38XeeY+Nn3+LP1RXOr4t1fkbMtWzZ0urMWrRoER1xxBEm0rgmXJgVWsiLuiGRJoQQjQyTKZP3yJEjozvvvNMMAZ+kmUR9DaEw9ZGJ1huGYIw1tgEmhGh8MOJJ/Rs0aFD0/PPPmzOH57j/Mc49asKY0KVLl2jbbbe1VuubbbaZ/R3DnEfGFTfS62uoh+aiixgft3gkQnTFFVdEd911V8Yi/OwbApO2+QhIf59/RrghchBpo0aNsoWWEX7APtMoafTo0fbZpDsigmgqgnAC3kt9FRvNS/g7P8+bNy9q06aN/czrETBsPM9r2PiZz2Ef3n33XfuZZk5s/J1H32ceffPfeeS8wLoIr5rgnDM3cAz93P/85z+Pttlmm2iHHXaI9thjj2jzzTe3LAtEmZ9/UbxIpAkhRCPCBM6Ej0fYOzn65M4k7OkoPB+KNAyUm2++OTrssMPUMESIMoH0xgcffLCqEUd1hj/GOwY5hjvGOYY80bUePXrY73Tv4zWIGyJSiB7GG3f28HtoDvJ/+Jv/PxcjdGxE4DA+IYQQM4gjfkdMIqJI4WZM4z18LiKH6Bfvd9FDNIr3tW7d2gQSr/XPQqQlfVcfG32fwfcrxL8Hj/6zEz7nPyf9Hn6m/70x4bj5OeX8+Tlt3769ibI999zThDjnmHPO39h4T3h8RHEjkSaEEI0EEz9e4PHjx0fnn3++GTZE1RwMEGo3SG3CSPHhmYkaw+jNN980Q4YJXAhR+jBGeCOOMDpVGxjqbuDzyJjhjxjyRFuoceV1m2yyidWSMbbwP9j42SNQLsJ8POIxvjG2EfXivfwewv9jPxx/Pfhj+J5QIIWUovjw8xEXZKSFdujQIdp0000tWoYoQ5C5WPPXSZSVNhJpQgjRCDDUYsBQf3bCCSdYalAYKWPiZUKmuPvJJ5/MqFHD8+ztq/GCCyHKA8QRUTREGlGohgLDns0dPvwcmoP+sz9WJ5ziJJmUdRURSZ8BxSRGOK4uwHhEgLH/LqpcMDOet2vXrkqUsSHGEGa8xjfmB/8MUT5IpAkhRJ7BwKEz25w5c6wFMlEyr7UA95xSh0HtBp3NPMLGRE4nM2rR+vTpY5O1EKI8IPXv8ccfj0499dToiy++yFksFYKGEleNKdKSPpPn2Bh7/edw43k28Nf4c/47Yow6MYQVIgwxRlMPnifllEee5++8x8UYc4E/x+eI8kYiTQgh8ghDLFEx2k+ffvrp0ccff2yGl8OETOrR8OHDreaCaBm1HQ6iDHGGSEOsMXkLIcoDRBnjAWPHE088kZFO6KIAeF2hBVxdxVX4vIsSvoPX6IYwNnoUyt+Xy2Ntf2MjlZx0T34mvRMnGSmgiKnVq1fbz2wsB8BzrVq1sjGd53C+kaLOviHCGMvZ/Ny44OLv/sj/8d/5WYjqkEgTQog8wfDKJP7GG29EQ4cOjRYvXpwh0JiomdDPOOMMa1tNGuQrr7yS8RoibBdffLG1sCbtUQhRXhB1Z7kOOjyyqDG/M3bgtKGJBIb+kiVLLB2SFGqEDo9E4xE83sSjocw9Fxc8+u/8zzA7wKHOlnEr6T38jtBBeDJO7rzzztG0adPsZ2B/eR3NRehcyVIDiCTEEvV0iCN+pmsjP8+fP9/+zmdST8dzCCeanfC/EGDx9/J3fkd08Tm8Ltx8P5OeAxddPOeb/02IdUUiTQgh8gBDK53ZFi5cGB111FFVETQfcpncMQ5OPPFEqznBCKPF/po1azJes+WWW0ZPP/20GRh4ZYUQ5QdjByKMTo9//etfzXnDYs+0XEcUIMhYuwshM2nSJEuNZExB1CGU6MSIWENMMb4kmX7+HEID+Nxw8+dwLCFyiDiR0sdnvvXWW7YgP0LNX0v0i8X3EZJ0p/X38MhnIMZcGCEqGee8i6XD61gvjUiivxbijxDutz8mvS7+XPg6IdKERJoQQjQwDKsYIIsWLaoSaAg2B2MCgcbfrrzySjNyLrroomjcuHFV3miMBoycfv36RbfccosZZUKI8gWR5REyxhCvX2KscFOOv3lUy6NoLs5oVkQjEro1Et3yRiSMRWFTEj47TPtjIx2QtED+5mKIR/43ooqaOZoieTMkHExEwIiMEa3y18Y3YN9J6aSLJSLUI2m8x51UCDs5qUS5IZEmhBANiAs02uWTvpgk0PAIH3jggdFNN91knmLWDOrWrZul5YTgfX7kkUdsrSPWwhFCiPrC2FTXSJo/hj+HIABZ/JmoHkKOzwfGK3cwsZh1TfAZpCr279/fUhD5HYgAhgv4C1FufH8nCiGEWGdCgUYNWnUCrWfPntGNN95oHb94D10fqcuIg6ecVCF1dBRCrCsILCJcRKQYW+Ib44y3emfjtWxhFCwOkTNSuknHdIEGiLSuXbvm5FxijKSGDCeVCzRApNENl4wCIcoRiTQhhGgAEFsUn1fXJMQFGh7nu+66ywQahhEGyrPPPpth4ACv33vvvS0tKck4EkKIQsMYN3PmzIyxjvEKcYYzqjYHE+MmYyBZBaFDC5HIgtp77bWXnFSibJFIE0KIdQSBRSQMgUaKowu0MH0IsYVAowaN+jIMD7zGCLsZM2aYR9q91bye9B6K5akXEUKItMH4xjhH5oDXogHRNxqa0MSEn2uC99HUhC38DMbHgw46yKJojIdClCO68oUQYh1AaCHQKJoPm4TEBRpeZQTapptuWuUZprj/4YcftrV4wjQf/r7bbrtZqiPRNiGESBuMWR999JFt4fjFmOVRtNqyABB5d999d8aYyXsYMxFppDwKUa5IpAkhRD3BMKEr2oQJEyyCRpezMO0HgUaKY69evcwQCQUaBgn1a7Nnz67qZubgPfZajNqMHCGEKAREvsgeCLMGgFRHHEy11aO5g4sxMBw3SXXcbrvtbJOTSpQzEmlCCFEPaHVNO+s777wzOv/88629dbiYK2k+3sWRGjRPcXR4Py2uw7bVgIHSrFmzqHv37hmvF0KINMF4R6pjOO7hVGLc2nPPPWsVWIx7Tz75ZPTBBx9kROJwTlGLpnpcUe5IpAkhRB3BuECU3XDDDdGoUaPs51BoIdDCddDiAg0wbDBQiKKFTUN4HWk+CLXa6jmEEKJQMIbNnTs3y8lEPVrTpk1rHL+IvFGP+8ILL9hjmB6OSBs0aFBOnSGFKGUk0oQQog6QlkPdGdGzMWPGWDSNqJjjAo30x9GjR2ekODqe6vj6669npPngNcZA6d27tz0KIUQaYcz729/+Fv31r3/Nqkfbf//9a80C8EwCRFoo8nifR9EQfEKUMxJpQgiRAwgritspkqfrInVo1KOFAg2jgsWp8QJfdNFFVW324/Ce9957z9ZHi79/yy23tFRHGShCiLTCuPX0009bNC1ej0ZXx9qiYDinJk+ebFE0zyRwJxX1uGoYIoREmhBC1ApGBMYEi7YeeeSR1jKfgve4BxlRduGFF9qGWKtOaCH2PM0nTHXEsPGGIWo7LYRIK4gsImnxTAAiYUTSanIyecOQJ554IuP9vKd169bR9ttvX2skTohyQFaAEELUgBsUNPjo37+/CbUkcbXRRhvZgqwnnXRSjQLNUx1pvR8aKN6qnyiaajGEEGmGFMVnnnkmKxOAejTGr5rq0XgvUTTSHcP3Ez07+OCDrR5XTiohJNKEEKJaMCaoOXvooYesxoxUx/h6PhgWP//5z0100fCDerSaDBTSgxYsWBCtWrUqw0AhEkerftpO1+SFFkKIQoLjas2aNdGHH36YNYbtt99+NUbBGDtxcj3//PP26GMpYybiDJGmVEchvkciTQghYmA4EOVi3bPzzjvPmoR89dVXGa2mPfLVtWvX6J577om6detmLfdr8wDzub54awgpjrvuuqvaTgshUg3Oq1mzZmXVoyHOiKTVJNIQdfPnz89aeoT3MP61adNGTioh1iKRJoQQAV5/RmMP6s/Gjx9v0bTQoPAOjnRhRKAh1HIRV3ig+WwiaWGqI59Hy2pa9qsWQwiRZhBnixYtynBaeT1aly5dahRZpHoTRSOFPEwZJ3qmBfyFyEQiTQgh1oKXl46N1Esg0GiRz+9hgxAMEGrOTjzxRIuIbbbZZmZg5GJYIPR88dbQQMG4oRYNoVdTqqQQQhQaxrG33norw3FFBgFp34yH1Y1h7qRicf/QSUWaZIsWLSySltQNV4hyRSJNCFH2eHojKY3XX3+9pTiy/g9e3zCdxxuE0F7/4osvtp/rEvni82bPnp31uYg8omiqxRBCpBmcS0nrozEObrvttjZGVuewIvJGR0eiaPGGIWeccYa62goRQ3eDEKKs8fRGujYOHDjQFqj+5JNPslJ5MCDwEk+cOLHWDo5JYNCsXr06mjJlSoYHms9o3ry5RdLkRRZCpBnGsSVLlli9bpgN4E1DqhvDeC3ijPRxnFQOUTdqeYmiyUklRCYSaUI0EExCeAfZwslLpBfE0tdff23pjQg01i6j/iz08nr9GY1BWLx1l112qbWDYxJE6iiWx0CJe6A9iiYvshAizeC8ostt6GgCImhNmjSpNrOA17/22mvWNCR8L6+nFo310ZTqLUQmsgiEWEc8EkM74ueee862pFQ5kR44L3RXxNgYOXJkdNppp1kkjXMW9w4TMcOIeOSRR6xzWX26L/r/QwyGXR35HD4P4ScvshAi7SCwvLOjg3Npww03jDp37pzoaGL8Y2wl1ZG50udFXksUbe+991ZXWyESkEgTYh3B6GbSOvDAA6MBAwbYRtOJOXPmZHWwEoWHKBbnhaYgRM/uuOOOqvb6bjxgLCCaNt5442j06NHRVVddZfVn9V1kmv/Jwq1cE6EXmVRH6jgQaXVJnRRCiELA+EW6Y3wc22abbSwqliTSyEx4//33zUkVijucYKR5k+qo8U+IbCTShFgHmHw+++yz6Mwzz4yWL19uCxRTdzRv3jxb/Pipp54yz6GEWuFBgGEgIMioi0CgJXVvDNMbqT/71a9+ZdG0dakXQ8iTShmP1CH69tprLxXMCyFSD2MX4owMhHjGAVG06sZIxr/HH3/cnGPhWMu4x/iay/qSQpQjuiuEWAeYsB566KFo5cqVVS2FPbWNiYxFkImyKfWxsGBQIJZZ+4zUxnPPPdfOD+cpPC8YGT/72c+iQYMG2fpn9a0/C/HrAcHHo+PRul69etU7QieEEI0FTknmM+a9+LhJ+/0kkYYo+/zzz80xFo5/RM5IcSTVsbo6NiHKHYk0IdYBJiAaT4TeQYeoDV0CL7zwQltTJlwXRjQeGBScI+oh+vfvb4/8Hqbr4MX17o2kN9Jevy7rn9UEhg3rorGFDUkwaLbbbruoY8eOSvURQqQe5rTFixdnpCwC41eHDh0SxzGE2bRp08yRGY5/OKZYa1JZBEJUj+4MIdaBmiYnYDIjfx+jPy4MRH7x6BkNXVj3jAgaDV3i6aecO6JlvXv3tuhZQ6Q3hiDOWcA6Hk1FAB588MEqmBdCFAWILOazUGwhsKjX3XrrrbMyDnwMvvPOOzOiaJ5S3qdPHxNpQohkJNKEWAcw5KkpatasWaJR76luc+fOjS655JKsnHyRH+LRM1JS+T30ACOM8ObSlYyaQk9vpD6ioVpBc/4RZ4i0MJLqkTu6RirVUQhRDDCufvzxxxkiDScXAo2UxbizifGWKBr12qGD0tvud+rUqVoHpxBCIk2IdQJjfpNNNrEaJ9aIwfCOG/gY6ngTqUl6+OGH1fExjyRFz6hDi4tjzhFijM6K48aNM5Hm3RsbMqqFMcP/T0p1pDFJ0vUihBBpg7GVBayJpIVjaXXZJLyecRcHGWOyZxHgoGLs3WeffZRFIEQtSKQJsY6Qtka0BmOfRYmTIjFMakxYF110UVXHxzD1TawbHEu8tnRupIuYR8+SWuvjxSV6Rlrjo48+apFQUm/y4dElejZjxgyLpobnm2umb9++iqIJIYoCnExejxaOZTicaBoSHz95PYtXz549OyuKRrMQtd0XonYk0oRYRzwqQ00T62khEIiQxD2ETFTffPNNdMEFF0RvvPGGhFoD4QJ4wYIFFjmrLXpGs46bb77ZzpUvTp2PwnXOLamOiLQw1ZH9ID2W60UiTQhRDCC64vVogNCKt99n7GN+I9WRcdgzR5gTmRsPOeSQvI27QpQSukOEaACYbDC4SZm74oorLP0jyQDHC/npp59GxxxzjNWpqeNj/cEQ4PiRgsOC1Ihjomi1Rc8eeeQRa9hBq/2kOsKGAmMGscgWGjb8T2rfmjdvrlRHIURRwBgWr0dj3mNsZSHrMCrGa1grdMKECTYWO4x9bdq0Udt9IXJEIk2IBoRJCOP/+uuvj1q1apU4EbmwoDU/k56EWt3xxiCk07Ao9fDhwxM7NyZFz7bYYotG8eKS4jh9+vTEro6kOvIohBDFAMIrqbPjzjvvbALNM0c8ivbcc89F3377bUY2A1G0wYMH25isKJoQtaO7RIgGhggaE9fIkSOrrXVCmLF22kknnVQV+RG146mN3hgEgfb8889bGmlY91Co6JmDoYJImzJlSoYI91RHmoY0xn4IIURDgDhbunRphkhjbmOMjUfR3n//fWu7H459jHctWrSwVEeleQuRGxJpQjQwCAQiNQcccEB0+umnJ3oN3dtIbdrQoUNt0WtF1KrHRc8XX3wRPfjgg5bayCPRMyJVaYmeORgq1XV17NWrlwk1pToKIYoBxl/GMRyK4ViLOGvfvn3GWMY4/dhjj5njLBz7EGY4JRmbNfYJkRsSaULkAcQAkxEi7cADD0ycmFyo0e3xhBNOsBRIhBrPi+/hWHBMODavvvqqCV+WO0hqDMIxJ4Vw4403tpQaOjc2ZvQsxFMdeQzPJ/tHFE2pjkKIYoFx9i9/+UuG6ALmtE033bQqksbfSXGkRjh0OvJ3X7xaY58QuSORJkSe8ImJRiK05ufnuFDztWSIqCHUFi1alBUZKkcQNmHd2YABAyx6RjG6L0odih9E2AYbbGDt9EltvPjii/PaubEm2K/qUh2pyaAeTamOQohigbGY9vthSjkwx4Xt9xn3br/99mqjaG3btlUUTYg6IJEmRB6hLgpP45VXXmn1UzWlPs6cOdPEyAsvvJBVcF1OYAgwyc+fP98aghx55JFWhJ4UaWTCR4ghyFiD7p577rH1dwoRPXMwTkhzTEp1JKqqBayFEMUE41h17fepv2Y842+M24g0xJrD33BQHnrooYlL0wghqkciTYg8g3GOaPjd735n6XcUWse7PhI5I4JGJI2IGkXXRIzinstSxid5xM2IESMscsaE/7e//c0m/TC6GKY24qG95ZZbLMWR3/HaFtIQQEg+/PDDWamOGCi03le6jxCimGBspm46FGmMwd40hJ8Z90hzxMEYvo7xmOZNRNE84iaEyA2JNCEaAYRay5YtoxtvvDEaN25cVSOLMKKCQc9ER8SIzpDUXtHFMN5WvtTwtEY6gl133XXR/vvvH91222323eN1Z961EdFLaiPH8pJLLrGFodNQkM45RGzPmTMnK9WxSZMmFklTqqMQophAdFGTFo7FjGneNMQdbDQMSYqi9evXT1E0IeqBRJoQjYSLCxbypG6KOrUkYeET3vjx461RBi3mk+qwih3E2Zo1a6IFCxZEZ511lokzRBqRtLg3FhA31J117NjROjaS2six9MhkY9eeJcE+L1y40LZw/9m/7t27ZwlzIYRIM8w5iDPmoFCkMR5Tj8ajR9GWL1+eNe4RRevUqZOcU0LUA4k0IRoRhASG+rbbbmtC45hjjjHhxmQWwmRIFAnBMnDgwKqOhknipZggIoinlVb6rLlzzjnnRD169DDBtWLFChOn8e9Higze2C233NIagiBwOW6kNpI6mAZx5iCkiaLFUx3ZT2rrtD6QEKKYYMwm1ZH2++GYhrNpp512sugY8xJRtHDhfsZlnJD77LOPzXmKoglRdyTShGhkPGWPCNCoUaNsLa/NNtvM0kHiggOjn8nxoYceshotvJWsDUYKZOjVTDsIL0QnkbNp06aZ8GS9MKKFLjzj38fFGWuKDRs2zJYqGDJkiKWKpiG1MQ7GCeJsxowZWamOTZs2tXXb4mJcCCHSDOPyxx9/nOg8Y+N55qekKBqZDjRyUi2aEPVDIk2IAkH6B1E0momwphcTGr/H00I8qkaNFt0O6QDJpIjgSbNYwwPrNXZM4KQyIjTZ/6lTp9r+h/ULjoszxBjNQOh6STpk69at7fm0TvicByKfRNJCY4Xz2bVrVxNqaYr6CSFEbTCWxevRgLGMZiDMQQ888IA9xqNoxx57rD1q3BOifujOEaKAMHl5+iMpf6NHj05sKgLemn727NmWJkj6HA02Vq1aZc/z9zAdpRAgzIj+Ub+wevVqa51/2mmnWW3dtddeawtSk+qIOEtqhkJa4DbbbBMdd9xxFjm79NJLTZxRi5Z2byyC1BewDr8b34nGJkRKhRB1h/sJscCWNG6I/IE4i9ejkQ3CeMyYNmHChMQo2i9+8Ytot912Uy2aEOvAjyqNusJadUIIg0mQnH5qtW699dboz3/+s0XQMP7jtymTJJMfk2SLFi0sGnf00UdHbdq0seeYJBGAjVEHwH4zQSNO2IgksTg3beg///xzew7hFvfEgk/2QPonYu68886zgnTETTFN8CwVQBrns88+a98XENqcH44Hj2lL0RQirSDGGPsYE3H4MC4ypnXu3NmiM9R3pt1xUwqQbo9TkGgZ5wI4DzvssEM0duzY6JRTTrE1LX25GP5GvTC1wwg11eEKUX8k0oRIEdyOTHakjrz99tuW3sgjv7vhHwdDhYmQ6Bv5/3SNJDJHRI7nEWy8hslzXWH/EFvsI/vj2zPPPGONTaZMmVKVxoiBFXpXQ0KRibBEnLHfiDOiZsXmfeWYrFy50tIaEabu7ef4ExW8+uqrzXARQtQO9w9j3osvvhhdfvnllkbMPcYYRv0uCyMjDhgrVOeZX3A+nXrqqdGkSZOq5iDmEzo20sCJNS3J5HBTEudanz59onvvvTfaaKONGsVRKESpIpEmRArhtkTkEElDACHWPvvsMxM/7rGMgwGDuGGSZEMwsHXp0iXq0KGDRar4O9Ec33hP0iSKkRRuHi1jW7JkiRWSz5o1K3rzzTejjz76yCZv37fqhBnwPzGqEJTbb7+9tWdmQifKxD4Xq2ec737//fdbF05q8ByOOeu4nXzyyUp3FCIHGPsY92jAM2jQIIvkML7wvEfeGT+6detmjYe4x4p13CgGSKfHifbOO+9Uje3MI3vssYc1sUJA+5zE+fEoGqmOiqIJsW5IpAmRYhBIpJgQpcGTefvtt1ukhueYGKu7fRFfGC4IIjYmVYwZxBobDUpatWplnmiacYRCjc/EM4oo5BGBxgSN+KCAnIkao8mjafy9pmHE9wWRwnbQQQeZOEOkYWwxkRd7GiB1du5tRlwD37t58+bW+IQCexmSQtQO9w8p09TcEsXx6E0I4xXj1kknnWTLcjCOcb+Jhod5YM8994yWLVtWNc7jUCOStmjRIpsjHMZyUhxphIVYS3IACiFyRyJNiCIAYUS0Bg/z448/bt0dqQPwNEjEXG24WGLzKBobE2lcpHkEjZ8RYR5J8+dqg8/j/zBpI8zweu+1114mzhBmPIdwLIVJnGND4XzPnj2zUh1ZI4i0H6U6ClE73DtEznB4MM55DVQSjGE4nljChJpcxhXRsDDWUwvI2IZYc9zh5g2rgLmE9MZx48bZuIeQE0KsGxJpQhQRCAJPg3z++eejyZMnW0dBjBk2F1KFwEUg4oSNxacPPPBAE2esEVYqUbM4iGeavNDFMp7qiAHZr18/GZBC5ABjG+May3QQRattLCNLoGPHjpZeRw2uotUNC/MNNdGkO5L26DCOYzqGUU5EGanrdClGrDEfCCHWDd1FQhQRCBwMftbconj+lltusc6BpPwwQZJeRyojXk5em89IFZ9NNIz9IVJEXRkeVNY0e/rpp62FPj+T/sL+8rpSE2iAYcl39TRHwEDBaEGcYtAIIWoGo5/MAFKGcULl4mwiikMaHp0HcZaIhoVzQAQtfi4Y6xBwDuMdHTeHDRumddGKFM6nZ+vwGJ5fUTgUSROiyPHoGgbOwoULrZCbmgA80TT58LoxDBoe2bjtc731mXARV2yeKskjAo01zXr06BFtvvnm5m1FmCBK8HDzmlJIZ6wJjBc8zNTPsAacF9bz/d2rjEAt9eMgxLrCvfPaa6/Zgve03M/VSGQcor4VR0mzZs1K0hFUKJhXaFx1wgknWN0tMG/ExzPGfXcaqqNj8cG9hzjDQYLTl4ZjZIAguBWdLiwSaUKUCNzKGDaIMgQZ3jBEGt0XvSMjjT9YmNS9o76FwwCijEnWH4nMtWvXztL32rdvH2266abWKp/1irwpCcLMBVw5wbFmwW5Pz/LjSCMDoohsTHRCiJqhvomIGB1Sv/3227XPfg9jkUdn3MnkMEYhDK666ipb7kK1UA0HKfQ33nhjNHLkyKxz4kKMMZ9MCmrRcEwpc6C44F7i3HKe2bAbyMQ544wzoqFDh2r+KjASaUKUKNzaGDR4yXzjdzaEGWLt008/zejOBRhDdCNkgm7ZsqVNwjwXRtH8ZzecyhWOIes43XbbbRbJBIwXPPp49lnwFRErhKgexiMyAIjG04THm1E4CK9evXpZYx7WY4ynNiIMPJKjroINB3MDqfQ33XSTnaMQP8YY9KyXxlqQOPLKfU4oNpjnZ8+eHQ0cONAcudgJ3G+777671XriABGFQyJNiDIljKKFwwCTLBOwT7YyeJLh2JHqSOczDEsmN0CUeRtqpToKUTuk1U2dOtUi0p5W53ikZuzYsebV//Wvf20Nevx+A8YqHCMYlSzoL8dIw4BI+93vfmdp20kijXPTpEmTquNOZoUoHsgEYa07nCMffvih3YecV+4znB40viKTRhQOuTyEKFMwbIiIYdAwufrmUTIGawmM6sFIZD2nNWvWZBiMeCF79+5tjzp+QtQO3nw61cYjZMCYdOyxx1okrXv37tEpp5ySldKIgCCSTU1b0meI+oHzjoZQ1Ykvj2AqY6D4YM5yEU4EDYEGnEcyaYYMGaLU1RQgkSaEEPWASY0i66TUK5Ye0AQnRO0gsHB0TJkyJaOlO+AsYtHqfffd1x7ZqDvjkb+FcD8+/PDD1nQkHvUR9YPj+P777yceT47/JptsYsY8nXvlkCoeEN84NYiUvfjii1VzGA5a6qnPO++8aKeddqpWnIvGQyJNCCHqAUYhdWehYckkR/qP1mwSIje4fxYsWGDRNOplQzASWaiaVDruJzaEAYvix6NpRAZWrFhhnxWvaRP1g/NBQ6Sk48nxRzzTVEpRtOICUTZ37lwTaYg1RDiZNaQ5st7n/vvvb7WGEt6FRyJNCCHqCAYh3n/y+MNUR4wVj6JpghOidjAYiYDFI9IYjURoSKfj0WtkvVFF3IgkOoDQY3H/+GeJ+oEjirrbsGYZOO44olgXTcZ8ccE5paZz8ODB1tXR5y9E93777RedfvrpJtb8fhOFRWdBCCHqCN5/0rMwBkMDBoOlW7duWV5+kX7wJvvSFXiXMWDCDQHA3+MGq6g/HHPSE2fMmJGV6kgUjQgaTXjCSA3RtDZt2tjaaPF0LD5j4sSJWfelqDtE0eheS1OkJDDoW7VqpShaEYFA43weffTR0SeffGK/A05FltW54oorLJVYWSDpQd0dhRDVghGFpw3jh8ewhX986HBvKh44NmoWeGTA52d/LHavK9+bFCA60bFGmhuXfDeMx1mzZlmxvTyR6YdrGkOFja6CrCeIl5l1BCmq92uca5YuZzvvvLMt4I4YR4hjoCqKUH8QU97VkeMeQutvugqSUhd3eiCiWXiX1Kyvvvpq7bPfQydIug3SQlx1ofUHx8R1110XDR8+PCsNleufxfs7duwog75IwMHEvIVAY45iDmfswtHBvUbq/rbbbmvnVqQHiTQhRBUuyjBaER88Uli8aNEiWwgbg2jp0qXmYU0CLxziZKuttrLJm3oFjFsWwcZTt/XWW5vhhHHL5OBCrpjAYHn33XetbTGpQBwzYHLr16+frdXEekEinbjTAYFAFIdUOxrA0IqaLmcYM+6ECEUa1ynXLTWHdO+kLorielLxZKjWD4TZqaeeaoKL8+FwnHF4PP3009GWW26ZNUZwD7KuGrUz1KGFNVO6D9cdjifH95e//KUdXx/jHIz5Z555xlIeRfphzMPpxELxDz74oDk5HJwaOEP23ntvNYBJIRJpQpQ5DAEM4hhJpHTRVp4NA4maKybspEhaEm7M8ogACzdEGUJt8803N+OKCb5z587mJfeoRDEItuq8+DV5/kVh4RrnOsbp8N1330V33XWXLeDKwsgINZ7n+nZxVhNcyzgacEgcf/zx0TnnnGMd0RS1qRscZxan7tKli0UuwzGF43nVVVdVdXJMAkcRa6eNGDHCzqnD+cFJNHPmTItoy+isG5wXji0RtNtvv90iaiEcz3322ceMfdamE+nGBdqYMWOiG2+80c4nzwHz7eGHHx7dcccdds8Vw/xbbkikCVGmYBQhvhAd8+fPt4J71irCg4pgc2HWUEOECzjEGBtCZrPNNou222676Mgjj7Q1kDyNjMhEWo0rvP+/+c1vLNXRvf98Lzz/pFl16tTJDEVReOLXONf3888/b23FcUi4MKsPnGM8z9Qg3nnnndGmm26aVSMlqofz8vbbb1tEmjQsh+OKuEJkcU9Vdy8huqdNm2apkjTxCc+jL7C82267STzXERwWODD69+9v58UNeoexG5F2//3323EW6cUF2qhRo8wxFQo0xirmqkcffdTGLs6rSB+SzUKUGUTCMFoxbB577DGLCCGSrr322mjevHk2MeOZxghqSB8On8X/RtgwcRDBIG3wz3/+sxlaPXv2tBoIjGk8uRhxafMhYQhy3EiN4/g4THCkABEdlDey8Ph1Rp3Z448/btc4RieRl/D6qq9AA/4HRs/rr78eXXTRRXbP8JzIDUQynn13dDg4akglpdV+Tc4O/oZAZosbmAiNcePG2TkWucP1y3V866232rWddD0zvmmMSz+IMc4h9xgCjTnXBRqOCzJaHnjggahly5YSaClGd5oQZQITLuIMEUaqCh5s6kEQaggmBvSahBkTMxEuBngMKdKQ4huRBU9dxIiqKRrmog1jDWN62bJlJhTZL1JtXnvtNUsnTJNY4/gsXLjQ0kBDA59jQut9vrvSqwoH1wnXC9fN+PHj7fpGoHGNI64xQDFUGup64nO4p6jPwdkgUZAb3PekOhKxQVCFcA+dccYZNsbUBOMRrznooIOyomWcB843AjAtY0cxwLngOqaZS/y8gMa24oB5ylMcb7jhhgzBzdyMA4S/IdQUaU43SncUosRhcGbCxSiiIxfRKpp/1NZSHJHFgM4gziM1V6RFeCMQctjDSZvPYWKgvoRIxaeffmobRjEb/4uNnxE4Nf1f/ieijzWShgwZYg1IMMgK3aDBazVuu+22qjoYjkHz5s2tO9YOO+ygJhIFgmsLwfTOO+9YKhbCzB0P9YmYIQL8+q7pegWu1z59+kT33nuvFeLLmK0Zxh68+DQyCLs6Ms5QT0b3uVzqnRhLcOaQCUATHzdEOXdEtYmm0cJfaai1w7EkQ4CsBsSzOxzC657rmmNJuiPXutId0wfjHfPUhRdeaE2R3DEFzE3M30T+TzzxRK2HVgRIpAlRomBYYgxhBD3xxBPRhAkTLJ0RQ5aBPOnWZ8BmEkYQsZEihreN4n46MyKgGOh5XWjEAp/Hxv/FWPKN9Vhobb548eJo7ty5ZgiwIRwxBJhAkvaF/4VXHa8fNWC//e1vTbixf4UwgtlHDEEifaRp+sSHYYkhSG5/06ZNZaA3MpwHT6FFQBMJQJxxbbnRXh1cw1zPnEM2rjk2ziHPU7OBcwOjh/uI/8N1y/0TwudQR4VQV01i7RA5J8LJuQojNtzfl1xySXTyySfbz7XBPclneZOLMHWS99N4hAYkOJRE9XAcuX84hiNHjrSffUzmXmBM93GN+4TmSDRJYrwT6YExjywCItGMRWEKNmMS98EFF1wQnXTSSXZ/aJxKPxJpQpQY3NIYkQzQNEnAgCFyxmCdJIjcIEUQka5Ie3HWUqGRBxECRBETM6+pqwDhfzHB83+ZQNgv0i1p6c8CtnSRJH0Q4YixlmRU83/x+LF4Kulr3vYcw7gxYd9feeUVE66kUvlxZOI766yzbGM/RePA8eeawaCk1uy+++6LVq5caY6J6sQZ1y+GCdc61zYba5/hhKDzKNcWhj7RHBdrbHwe7flpFvPHP/7R/k9cqGGwErmhbTn3i0iGscC7OoZLWHA/Ez2ra0SascO7PIbdVjkHRHxcTNR17ConuI+orYw3C/FjxqOfJ44rDVlozKLujunAx0Kuf+o5WVKE+yK8txBlzOtXXnmlRdMk0IqEypMrhCgRKg3Hiq+//rpi7ty5FZWDdcVGG21UUTnBoiZs42ffKgfpikpjtWLjjTeu6Ny5c8U111xj76ucpCsqDdWKSsN07ac2LHwun89+VhprFZVirWLYsGEVrVq1qqicPCoqjYCM/fR9rRRmFe3atasYP358ReVkVFFpSKz9xMahUgxUXHbZZRWVoixj35o3b15RKTTt2IvGgWPNNcC106tXr4oNN9ww8brxLbzWK0VZxSmnnFKxYMGCis8++6yiUnDbtVgp7ir+9a9/2fVZadys/U/fw+/8T147atSoikqDJ+t/8NkPPvigfY6onu+++65i+PDhds7C48f56du3rx3j+PGvCc7ZrFmzKlq2bFlRKeyqPo9z3rZt24o333zTXiOSYRzlmFca8DbGxs9J/N7iGPfs2dPGblF4GK+4p956662KLl262NhUKcqqzhf3AfMq9sDq1at1LxQZSkYVogTAY0YEAS/o9ddfbx5RUhxJ06q8z9e+6nuPW+XAbREEFnplAUvSgVgTjRQjUrWoPePv+YpU8bl8PhEoPLGkCl566aVRpTEVVYo1W7wWr1/oSffvR5rk6aefbqmbpLS5x7cxwFNJW3AeHfYRLz1brp5/UX+4fjn+pB5S+E4tEvUzRNOSroVKA8WirtTOUDPGtU6khkfqKkml5W9ci0TXiBJwfXKPhPA755frcvvtt7frNw77tnz58oz7TWTCfUyEnzqyMDUROP40ASHNOn78a4LzwjIepCHHxwxSITnfjTlOFBvcT0nNQrgPuHc6duyYMRdwfVNrzPEVhYVzQMSMrJSBAwdWZaX4GOTnkM7JNBAhgsYYJ4oHiTQhipx/rc1DZ80gDBUag9B9MBysHQZtxBmpjLfccoulAlG3gchwYVQXA2ld4X+RTsnkQfMNUgYxqgYPHmxrqGGwhQYC3xXhef7552d1rcon/A+MSibB0OBjwuOY8x1EfnGDhBTZE044wa5zjHDOS/w6d3FGPeUxxxxjqVl+rXOdIcrqY6zwuTTP4TEO13Lbtm0b9f4pNrh3SKvjHIb3kZ+vgw8+uM73EscbgYdzJ/5erg22UHyIHyBll0ZPpAojnkPhxTHFicf1Hl7TvIZxV86IwsKcxHl48sknzXFJCUE4FjJvkn5P12Ha8DPvS6AVHxJpQhQpDNJMrCw+jReNrlwLFizIiiowWDPJ8kjdDZE2mlwccsghFkVACCUZnY2NRypat25tzQOo7+nVq5dNNOH+YVjwHRFpvkBnvoUa4nDixIkZkyDHlGO3yy67mEEj8gfXM+ecxahpOEGtZVIk1Q12rnOub4TZ1VdfbdHahrrWq6s75HMxhNJwL6UV7p8XXngho14GEFfUy9T3/GB8sl4a5z506nB9MNaRYdAYzpxiwp0e1FjSEZVx1eF4tmrVypxh/BweU+C9bBJqhcHHQ5YZQaBRL4sjIpybcHrsv//+VoOmhfaLF4k0IYoMBmKMHVK+fL0zomhE08KBGjB4MCpJWaGw/sUXX4yOOOKIKoM1PvmmAYwCIh0e7Rs0aFBWmoZPUkxARElIhcynwcDxxvvPo8Oxo803qSThvomGBeOR6CmiPPQYh0Y+cA64TrhuEGdcO/yMcMJACaMB9YX/yXp+8f/NZ+NkIIVSIi0Zjhn36ZQpU8zp4bhBScMixqT6wLHv2rWr3Yvh8WecoMkP965EWiacg5deesla6YdZF34+fv/735tQ45qO3zucS5pRxe8DkX98PLziiiusUyM/h/cT8xJzPo15JNCKH4k0IYoIFyfU4VB3xjpDntoYTpgM1Bg8rNlEutekSZOsLS8phAzgaRRnIRgFHhG5+OKLo1GjRtUo1Gjxn6+UJo4rnng6ZvE/HSY+amHSKnZLAc4pXmI8+kSAcURgkISCnGPvqY1cK4j2XXfd1cQZtWNxA3NdwNBnH+IGP8KAe4v7TddCMpw3omh0dgzvIwQWqYpEpPm5PnDMGS+ocY3XC3INcf+Ghmy542PnNddck5WJwPGjy+lhhx1WlQIfPy+8n/sgPI8i/3AN45zFWXXHHXeYQAsjoO6UxVnBGmkSaMWPZhMhigCPnmFsEBFDoFF8Hx+kwSMK1HdgsNIkASOIwbvYvPx8F6JqtBVOKnzmu1PETg0bj/Fj0RAwMZJGikc+NGaY/EgnCfdHNAxc70RdcEAMHDjQ0nri6Y2Ir/Bap/kN1wFCCYO9IcWZw//HIRAXaexHjx49ZBBVA+cTRxLnkfMawrmiYQhCe10ELsee+htERvg53L+Mg/Esg3LF7y3SHN9+++0M8cr8gDC77LLLqgTajjvumHVecFz95S9/yboPRH7w+f+jjz6yRaipQ4uLa84RDkMyZW666aaqBmCiuJFIEyLluNcTUUZqIwuOJjVMcC8aKXgIM9K9iCjEhU2x4YZD3759LcXDjQcH4wvDmdqjMG2noQiNPMc99xxrGeYNCwYgtZakqHHOaTTB73GDhOPPAusXXXRRdPPNN1d1Bc2nI4Lriw6OodDwqC//X0ZRMoxhK1assHMZOlLcsKQejWO4LjDGkfLIFooK/t97771njhaJiu/HM8TZfffdlzVeci6OP/54WzuQa9mjaEmRNByEOp75x0U1mRw4rKZPn57V5MXnSFKGzzzzTEXQSgiJNCFSinvPwugZhkbcg4aRyISK54zURiIKPOYj3atQYHQhQI866ihL9Qi97j6J0SBg7ty5dswaCj8HRHRCjzNGCzn/2267bV5FQbnhAo26JQwSjjvnNjQkQ4MERwTRM687yyfsG/fe448/boY/++T7RVou96eiqslwD7EkSDwtm3NG3WCLFi2yhEBdYTxgvHNx4fg9TGfW8B4uR5g3uL9uvfVW6+oYRqY5F9SgUYvG+Mq8wTFlYfdQ9AKfo0ha/gkdVsx78UWqwbMJqN2mkRY1hBqHSgeJNCFSiEfPqD3z6Bm56PGUHYwR0gGp56AbYjGnNtYG34fvxWRFalnoecdYwICmRo+al4YyHvgcGlUsXrw44zMxBL2bXCmI4DTg55BUHmrQvGNZSGiQcL1z3TfWtY4ww1gKo2jA/Yho5FqQYM8Gg3L16tV2XsPzyX1D5Ib0LR4bAsbDPfbYI8tIRZzNmjWrrEUa16k7s5555pmszACEGWmOzCcucnke5x+/h0KN+Uk1afnFx0MiZzgn4y32wcdDarbJKPAUR81JpYNEmhApggGYydMX660peoZRSP0NgzMduljTpthTG2vDRSlrZOH1DaMnGGB4d+lgGY++1BfOBR74+OTI/6U4mwlRrDtukLBI+dChQ6NPPvkky6DmWBMxo1EM1zzXfmMaJFwLdFGNCzH+P7WJ+Y7kFSucx/nz50fvv/9+hlHPvcxyGyyg31DHjuuBZj7x6wKBzWL5nMOGGBeKEY4BHRlpFhJPl2MuwfG13377ZTi/gOudRiKhSOO9b731lp3Pcj2e+YRzRTopzUFYEzLJQcs1jiij/oya7VBci9JBIk2IlOCGKnUbpHohRGqLnlErVd3Cz6UKBh0595dffnli2uPIkSOtbigUtfWFY0/qHY8Ox5/FvzEGNSmuO37dk6qT1FLaHRKkFLJWXSEMEvaRNCMMfX52AcAj12KfPn2yjFvxPTg46DQXd5xgZNIwhI6MDTVuIShIQ95mm20yxDTnjLRxatPKMfrj9xh1u/EGSzj1WrZsGf3hD3+wqHT8XHCf4RwJ7zdEGp8RzzAQ6w5jH2MgYyE12N7R1gnHQ+4r6nbzXYsrCodEmhApwD1nd955py1KTatqJtXQoPDBGe8ZxcEINIRaOXrQEKR4fXffffesaBpGyNSpU804XBcwPkjTIsUtbtR4Fzk31kX9cOMRgYZBwj0QHmsMRs41tX9+vRfCIGGfSNdj4Xg3Sv1+JMoQFwXiexi/ELcsPh4ampxXHCx05WxIccvn8nk09PGMAoQhG9fZq6++us7jQrHhziuyLUhzDL8/xwthds4551TbbIK5pUOHDllzDOeTFLzwvIr6w3ni3JDmTUo/nVApeUiyATp37mzp3qTcJwlrUTrozApRQPBIMoH+9a9/jc477zxrEEKbXZ4L01GYIMPoGSItn63G044bF2effXaW0c5Eh9glpWddvLwY5jNnzrQoWjw1yOvRRP3hmHKO8AZTUxE3SNyQ79Wrl0XQEGoItkJc79yPOE7i3fC4Bojslet9WBvcO9yL8fEMAcVYRrpjQzuYEBr77LOPXT/huWJc8OYl5QTjGGmOiLQwzdENfmr4aNte3XjG8aSLalzA8bmklodOFVE/XKAhesmiSWqxz/li/CNSTO05j97gRZQuEmlCFAgMUgZijD8GZvechZOeT6Rh9IxuaMo//954YA2fQw89NMOA4PitXLnSuvCFaYp1hfdSjxZ+BoYfETTq0Uq59i/feAQNY+TCCy9MFGiIcCKWtNcnnbdQQojriWY03Kfhvcn9R6oe92PcgBXfn2NEAVE0RFoIxibiNh9GJueCDnfh9QQYwizVQeQnFG+ljN9npDkuW7Ys45hw/bZt29bSxrnXqosE87o999zTxrvwXHEv4FxEXIQCXNQNjh2OA1JxjzzySMvciNcMcm5wRuIcJIKGQCuUw0o0LhJpQhQADAVyza+//noTaElrQTE5+sCs6Fk2HAOMvOOOOy4rmoZRiAc/HvnIFd6DOGM5g7hhzgSJUENIiLrjRgnRsTPOOCMrxdENEmotKIonDYvjXSg8GsQ+h4YTYsBrqqozcMsZzimRK5qGhOIAY5+W+zQ6yoe45b7cfPPNozZt2qx95gf4G01p4gKuFGEM45q95557LM2RMdHHQo4DYyeNqRC0NZ0HXsvfOaaMfw5zFU4s6jTL4XjmA44h52jGjBk23iF6w/MEHHOcsqwlyJhZSIeVaHxkZQjRiLiByvpPiDNEWrw5CIMvkyLF2r/73e8sTUXRs2Qw+OgOR21LGNnCQKR5yLx58+pVM4HRwTlas2ZNhgGCWGCx3HwYl+UA1zhGCO3QSXFMEmh49fEo33jjjY2y/llNeCSCaBARA8eN3L322ss82iITFwgcNx5Do5N7yNvucxwbGsZPxspf/OIXVdEG37iXqVcNr7lShTmFDoysJRiPzHAOSHM85ZRTcjL4uQfpYBqOsX4v42AMsw1EbnANkkFABg2lDm4HhHC86dhME5HRo0dXtdgX5YNEmhCNBAaCpzey9llScxCMFgwLGhEQRRg2bJg8ZzXAMcFYprtemDqFAYFRTUOK0LjOFYTdU089lSXwMFbUer9++DmhIxwRtHiXuVCg0WY/DctJYDRhRNE+Poxys184TnbddVc5ThLgvBJBi6eI+jlGQDGm5Qs+O6njJucT50upiwrmFATApZdemtjNkeVLhg8fnrPjj+NIN9t4ih3j4+TJk02Ih/eHqB7GQY6bd3BEoLF0TNJcQ9dNXnPSSSeV/PI6IhmJNCEaAQbgML0RQ4GJLfRuelpD7969LUWFVCpFz2qHiYtj1rFjx4xjhSHGGnOrVq2qswHBe33xUAcDE2OFBhY6J3WHY4pAoxaJlLPQUA7Tr1gDLQ0GCfcmEQhqG+MpSBirxxxzjAmOfESDih2OF8ctHsHB8CRtK36vNjRcO56WHIoKxMtLL71koiU8n6UE34u55Y9//KNF0uL3Gdcs3RxrS3MM4VwxxtI1MzxvHE8cGKS1xkWGyMYdVcwt5557bvTQQw+ZWOPYhdcj1y1p3hdffLEt3B9P5xflg2YXIfIIAy8GC7nmLEqJSKtp3RPqzigMRghgtMoArB03PKhxwXh2MA5pmT59+vQ6GRC8D8OGzo5hlBPDjy5occNP1A7HH48+6bt0Lw3Frws0IpRE0PDyp8FjzDXA4tXvvvtuViQinzVVxQ7HisY9GKBJQpwoWhj1zgcYtNTvkoUQGrc4a1gvjfG4VCM/3Ftz5861NMd4qinzDEuXMI7Fo2I1wbnj9TgOwywCn9+SBLnIhLmEzBkch2QL0NU2XofukWbEMHYADg1+l0ArX2QBCpEn3BNPtyYG5erSGxmEEWVEzxBpnncuIZA7HC/qXDBC/Li5AUFRdigKaoPzU13r/S233NIeRe5wPEm9oosjxmN1Ao3U1LSk9GA4sc/XXnttlqGLscp9yn3L/otMuG/uuOOOLAOU80qKKHV8jXGOEdDelTAEhwHNLkLhXSrwnXCGnHXWWXb9hnMNxwMHCFG0+kRmGPdwTHC/hu/lf7L+3HPPPZchysUPcIw4H9TZYguQSRO/P3ws5O80rPI10CTQyhvNMELkAQZfBBktxklvpAtWPL0R4wGjFO8k9U8YMEyeSqWrOxwzjAjqJsLjx+ToIi1XLy+GBukoocGB8MPIoXhe5yd33FFB0TvXeCh4OKacsx49ekQ33HBDwZuEhHC9PPDAA9a2PDTmuWc32WQTW4dLYj0bH/fijVY41xigxx57rI1xjSFucdxQ2xtGfsBFGo+lhN9rtNuP1zh5hIY6NNIc6yOSGfdIU6ULYfh+/79/+MMfLHUvFIbljh8bRBnHHqdPPJMAGPewBRDBrIFGJ818R5tFcSCRJkQDg1HHZEXb7tNPPz36+OOPbVAOvfEYDhilpHexDlSTJk3M6NOgXH84pkRkQuOZSZJjj1ALje3q4BwhJIh6hkYOBgoTZ9OmTSXS6gCRTLzCpO5grHA+HM7XTjvtZIXx1F+kRaBhZH722Wcm0uKikija4MGDLd1RHu5scGwkNVrhnqElfmOmiCIkiKTF/x/jAE4Y7u9wTC5mfNzCEcJyLdx38euWFEecTHVJcwzhPQiH3XbbLSuKzDFlwWwEIiI9PPflimcQ4KhlvUcyBeLRTeD6pEEIjqo0ZROIdCCRJkQDwsRPzdn5558fjRw5MrH+jEmSWgkmU5oPaFBuGDD68fLyGBohLtLi3sskEBEYG++8806VEceGkUktR1qERDGAwU6DEIrf44Yb1zvX/RVXXBHtvPPOds7SgBu7999/f7WL//br109RtAQ8ipaWRiuIaJxf1KaFjhX2k0WtiWiEToNihnuNJiGXXHKJOUPCe40xq127dtaoYl2PP/ftoYceap0zw3vW7xtS9uMisRxhruH6ogad475ixYqsMdDTG3H+cd44rmnKJhDpQCJNiAaACYmJ8osvvoiOOuoo8ybHvWYYDaT6kGvuOefq2tRwYIhRcM0WHlPEFjVm8WhmEniESYViQg3hfR06dJBxniMeTSbqhFALHRWcJ7qWYsDQga++nv18wH4i0BFp8WgEBhULp5PuGBr94nsY/xBoSY1WOGakOjb2/YPBSwQpdIJxTtk/jOjQaC5WPPKLoV/dvTZixAiL1qyrM5BxFaH329/+NqvzsIt0skPeeOONjCh0ucB1hQ1ApJZOtYxx8XMCfhyJsBH9xGZgfGksB4YoHnRFCLGOMBEhABiYGWxZ3DMpcsCkRrcmPI3KOW94OJZ4d0l5DL2RnAc6unF+4qkmcTiPL7/8cpZw5vNY/FXGee0QncBAw2isrlHIaaedZmsFpuke4DohCnHrrbea0RteK5z/HXfcMfr1r38toZ4Ax+7zzz+PHnzwwSzjnOPFOk8YpY3tkGI8IEU5HqnFmGY5iLjxXGy4MCKdmHsNoexwr3HMaRRC3WdDXbfcC6Qp//73v8+KzHFcaVzC+cbZxbVQKtHKmuA74tRB+JNBQ6SRyGZ16Y1EzHBakB5KM6pC3BuiOJBIE2IdwBhhIsJzSP1ZkgeRQZnULjyMFAV790bR8HBciVDGjy/GC+emJqOMc8brSHfkZ8QDGwI7qQ5DJIMomzVrljkjkgx2DEbulTQdT/YRI+vRRx+NnnnmmURjl455OFpkTGXD8XrllVeyomg4NajfK1SjFf4/11vcucI48OKLL2bsa7Hh1yz3Ge324ymGfq+x9EtD3muMiThXaIiVJP64FqjD5h4nzTxei1pqcA2RNcBacaeeeqrVlRFNQ0CH54Pjz7EiBZf2+9gDaarFFelEFocQ9YSJhwkI45+JkMd4ihSDMuuf3XTTTbaIL0beuqaciOrh2HrzkNAowXDwtvrVgceTaFu8VoV0PBZyxTARNYPxiyf97LPPzoomI5wxSkgBiqdKFRoMLcT5Nddck2VUci3tvvvuFkmVQZUNxwoxPmbMmERRTsSApiGFELf8T+p/qUsLxwPudYREMYs0xjKiNXROjUdsuE5pt083wXyk1PN5fC7nnOMbT1lm36j7Y14kBTZem10KcO1w3FetWhWdd955lh3AmpyMe+E9wM9+vJhHJk6cGO26666qRRc5IZEmRD1wwwRPISmOGPZhzZMLtK233tpSUWhoofqz/IMhhhigq1soAjBgSL/BeAgN8BCMCIR2eB4Bg4fW/op+1oynC9ZUG3P77benznvsKWOkHiEwQ8MdI4paHtqLK5KaDPcUUTREbnjsOOdE0WiIUKi6Q/4n55B60nA8YAzgGkU8VDcepBnuLfb9oosuyrpm+Z7UAFKHls97jc/l8ydPnpzV/Ifxk+viyy+/jIYOHWpRtaS1wYoR5hK+Bwui0/gIpyALt/Ndk+YX5nxSbkkBpbEKmR4qdRC5ohlHiDrCIMwgPWXKFJuAfHB2MOQwSligGq+ZL0opA69xwHiIr4/EOeMcIdRCj3MIhg/RtlBcMMGSnkKDCwns6sEo89QrmuLws8N1z/VPlzNvFJIW2G+cLThS2O+wfg4jCmOKmh6lJSXjYyF1OEnpdgg0OmKGAqmxQaQxHoTnj/3kPse5Vt14kFbcqTBkyBCLpMXnHu41FkT2dvv5hHNMfTXRvKSIGuLRUwFJj2RZGlIBuc+KTRxz3BkrEGcs1k5q49ixY6MPPvggK2sAuOY5F0Th77vvPutyS0SXeUkCTeSKrEYh6oBPkKx9Qpv9eMQAQ56BuVevXibQmMAK5UUuVzDGEAPxVBKMMYrrQ6+z4yKOdMe4V5rPYmKVyK4ejllN6YLUrmCkpc2DzDnnmiCKlrTfRAgOP/xw+1lkg7E9derUrMWTuW+IotENs9DjH+NAUl0a40Gx1aW5KL777rvNoZSUXvrLX/6yQdrt5wpjY+fOna3OivuFfQjPt+/znDlzbEFn0gJJgVyzZo0J+zRH1ji2PucTCXzsscdsHON7eGpjXOTz3bnmiZ6dcsopVqPG9Ze2FG9RHMjqECJHfLCeMGGCRdCSBBopjaQ/skA1tWgy7hofF1aItdBY4FzhxU0yyji3RNn4e2ioe1ROUZTqcSMMgVZdumC+amPWBfaT/SU9M17T4/tNmqPSlJPx8ZC0ungUDSMVgbbVVlsV3DDlXNKsKe604fxTl1YskTSOL8cZcUYDqrhTAbFExBfnIfVOjXXcXZQwTrJfpIYjEMN7xiOXpGh6gw3Ezm233WY1XUTb+Ht4DRUSjisOHLJk5s2bZ+KMbrTs9+zZs6tq7MLjjyBmnqBzY/fu3S11nrGF7o1y1Ir6IpEmRA4wkWPIka5xwQUXVE0qjgs0CqVJ/UCghel2ovFgssQgow4lNBQ4h88++2yiSONcEkULzykw6VLfJpFWPURT6IjIFqYLeupVGtMFXWBgVFaXMoZBxjWkc58M55r15BC64X2DOEhLFA04n+3bt7f9CveF8QBHW7GINI/6nnnmmYlOBa/55LvGBWm+4bjikMQ5RhkAS814k6zwmCNquG4QP9OmTbOIFOKHyB91jaFgCwVQvvGIGceY/7969WqLEPtSIYwF77//vokzXhMXk1xjZAlQn4Ywo0ss94AfAyHqi0SaELXAZIhBd8MNN0SjRo2yQTw09Jn8GYwHDRpkhdzq2lR4MKzjETDOI+ulsTEhh2AUEEkLjU0mXoQ2n1PoaEBa4ZiyphgRp6R0QToisphwmiLK7CNpYqQjs4VRIAxKhMV+++0XDRgwQB7wamD847yzLhrHz/Hjl6ZFv9knxmPES+i0YQwgTbMYRBrjEoKS+SWeweFOBSKaXvNZiGuW/8l9Tt0Vzo9hw4bZ2Mn+sI8h3IN8B0TP/PnzowceeMAWf0YQ8T0QSAg2MhsYV3htQ4s23wfmdv4P+0HEjOgex5H7f9KkSbb+H6I4POaOH/tmzZpF/fr1s6UQWMCfaJqcO6Ih+FHl5JSO+LIQKSQUaGz8HE7qTP4INFJMTjzxRIumyaAvPBjhTLB4QjEEHNKeMCDCRYkZApmI8YIuW7asSsAxyfrES/MQkQnHDePluuuus7b63Bs+nXBfUI9JMw7SfdJisLB/XBvUkxD15toIHS5cEzT8oQEKjRBkaGXj5x1jmshN/LyT7sbxa926dWrGQs4zEV3EQCgqEZKkD7Zr1y5LSKQFrk/2n+uV6zasQ0MYIRIOPvhgW+YFB2EaUnOZI4mYISiJkr300ksmtpKiUA7fhX3HMcbGvYhwY+xl8Ww6JTN+8xquK84Xj7yPn8Pzx3P+fxBjbIzrbOwbG8eVyCT7huOO64BH9htBFs7zcdgHxgaOPWsAMqdw7NlnjRmiIZFIE6IaGKRzEWhE16hDU+1KeuA84Y0dOHCgeWQdUlJOPvlkS0lhUgUm63feece8uKS5OJxbvMEsYsy5FZlgyFCfgSGFceP3BgYSxxbDhTWyMGTSAgYYDQy4LujsF3rHuZ9JU6bT4y677GIRAJENx4yoA+edTnfx8849Q0pemu4ZBAKd+EivQ2A6REAQlHTgS6NzDVHB/uIEpM17GK3meCMKunbtat+BCBbXcJrgWkFUErFkLTHGWX7n+doiYy7GEGw88t0QaTvuuKO9H3HE/cw4Te0j4hvRDYz5HTt2tOvUBRr/mywYUi097d03Po/r2B10SXC8Q3F2zDHH2D7stttu9nvajr0oERBpQohMKgftikrDs+LSSy+tqJz8KioH4IrKQbpqqxyoK5o2bVpx2223VXz11VcVlQP82neKNFA52VZ88sknFe3bt6+onFirzlvlhF9x0EEHVaxZs2btKysqKg2fikrjraLSAMg4x5zfyZMnV/zzn/9c+0rhcHy5PwYNGlRRKXwzjluluKno1atXRaWhlKr7otKgq1i6dGlFjx49bB/Dfa40AiuaNGlScd1111VUGnIVlYbd2neJEM77F198UVFpoFZUirCMY1gpGCr23HPPipUrV1ZUGr5r35EOOPeVIsfOcbjP/M7z/D1tcKy5FivFpc1BXKPhvnO8d9hhh4oXX3yxolKgrH1X+uBe4vgy5jKe/upXv6qoFFN2/cTn1do2jgFzb6UoqqgUZzZmc2wYq5s3b17RokUL2/h8/5m/8ZoNN9zQ/idzQPxY1rQxf/A/eT/He/DgwRVPPfWUjX/MDZwnIfKFatKEiIFHjajZhRdeWG0EDY/xlVdeaQXSeNEUQUsXpL7g8SRlLTw3lROqef/DtBu8qESCeM6pnJzt/dQm4MUVmeB9fvXVV62VNsfP4bhzP1x66aWpiiyzj6ReUTea1CiECCs1KGxpWyYgTRC5eOGFF6x1PT87ft5pOU5kI233DNchzWvi1yPjAY1PeEwTRH+IOM2YMcPq0IighfvocxBZHPGFpNMG9xL7RxSMyBPp49SCEm1t06aNRQCJWucyVnAMGHs4NszLpIESGWP8JguCCBob6ev+M3/jNUTROI6MBbWdb/aZ/WEsYA75xS9+YevS0RCE5Tr22muvqrqzMM1SiIZGV5cQAS7QEGfjx4+vVqDdeOONluIogZZeMBQ7depkkyiCjI1zuWLFCuvUhSHEc0zadCYMzzPvpQaC861JOBOOGUYS9T3cH6HBQ/rVvvvuazUkaTEcOb8YcyybQVts9t0FOsYY+0wHT/6eJmGZNrg/MHrpbovgDe8XzjXnnS2NgoF7uFWrVokiDeO9NqO9MeHaJHWPGimcCqQ7IkwcvgPXKXWgXLcInGJwKnAOXKwhes4++2xL0yS9mLRouiHyN4QR429jj7scV0QXx5Y6uB122MFqku+55x7bTxajps4Sccb30LwgGgNdZUKsBaPDBRoiLO69ZABngOZvffv2lUGXcnzCDY1JwCh799137XmEGrVJdPcKX4c487XWRCaIHo4fLbT52cGwIopCFC0t0SgXaBi7GL0Yvy7QAGMLMT5mzBhbF43zLrLhmBE5o1EI9UU+LvI8xioGNrWeOK3SaLyyTzjX2MLrku8Rfp80QJSXhhZnnHGGXbvhPcb34BjTROTAAw9M7fGuCY4/9xljBXVjCHuiU7NmzTJBhDCizgtBRJSNMZxxuKHnWj6P+5/9QJTx/w499FDrTIooe+qppyzqh6CkdpH90PggGhuJNCEqwUDHY4mxlpTiyCSBEcffEGjFODmWG4gGIjpxmJy94QHb4sWLMzzVwPnu3LmzRFoMRC0i949//GNGEwMgIkVKEBGLNBw3jFtS2TB2SRsjghbuLwYajUJY+1DrGtYM9wdiZvLkyWuf+QGMbtK/aOiQ5vuF+x6DPBy3/XoOr4tCgkBjgW1S7ZNa7eP8oMERTTiKfQ7iuuGcMG4QQSP1EcGGMHKR5K38EW6MK23bto2aN29u4g2HKeeTY0I0kc/hHvaN39n4GwILgc77EFzM5XwegowIGf/HRRmCEZGI44H38FlpcDiJ8kTdHUXZgxcVgUZ+PwZbdQKN2gBPcZRASz8YXu+9954ZkNQrMNQx2TJxk15zzTXXmJFw7bXXWht5zjvwGgwB6iaYrBF74nuIRP3pT3+yqImnDXK88DDTah9DJw2t112gXXHFFdHDDz+cJSi5pxFmd999d9StW7eiSRkrBIyPRHRYzgKRFhe7GLPPPfecLV2Q5kgDYwA1h+yrO2W4TunsyL3OPV9IXKARJWPNxnhaLtdor169rNU+126pO5C47piHuZc5X+5Uo0sjj9zfS5cutePCmn1sXIsrV6609zNnAym6jOMILqLBnG/qEzn3XK++8TvzgRCpApEmRLlSORFYd8ZKQz2xg1blRGhdo+gA9vXXX6uLY5FBpzm6+YXntXJCrqg0zK37IB3H6Pb44x//uOrvvLZz584VlZO+uvzFoKNZnz597Dgxffi23nrrVVx11VV2jxQaOslx3ukiV2mYZd3TnOtKIVkxYcKEim+++UbnuBa+/fbbittvv93Gx0ojtuo4/tu//Zsd3yuvvNI6PqYd9vHggw/O6OzJ9+nQoYPd64WkUqBVLF++vKJ3797WgZBj6/vI9l//9V82jlUKlFR2omwsmK8rBZsdg++++87uX+bvL7/80s4v45Nv/M7G3xiXeD3v4/2650WxoHCAKFvw1BE9wTtMFI2fec7BU0lKRZjiKE9bcYGHlBQXvKQO57hy8jbPNZ7VRYsWZUROeS11Spz/SgNp7bOCY4R3H0925dyx9tnvITqJlx+vdiHhfBKNIOL95JNPJtaV4kUfPXq0pY2lpXYurRDFIO2OFLCk9FYaV1DvR9pZ2iH7gZTMMAuC78O4H7+eGxOP+jIHxRvbAOl2XLPMQ5WCsuQjaDXBuWN85phw73oaI/M0KZOM9b7xO1uYFsn7eL/ueVEsSKSJssQF2l133WU1K6Q7hoY6xr1q0IofRDV1aaG4xgCiDgWDiIWNac8cGp+ce+/sKH4AUcv9glEZGjkcW1prs6BsoZwYnFNSMak1PPLII+28JqU4YrTR+KdYmy40Jj5G0oUPEeEpgoChy8LBv//9780ALgbnFeea/YzvK9dOoUQax5SxiI6ZpFzGG9u4U4E0fMYkRIYEhhDlg2YoUXZguGHAUatCzQqTZGiAYJzjnaMGTQKtuMGYxJMaF1ycb2pUaMcfnnvAMPJImvgeDEc8/NOnTzdDEjAWMXg333zz6PTTTzdjvRAGpN/PCDMiaAsXLkw0dhFoEyZMsIgfXnXd0zVDVJJ1oeJronGOOX6/+c1vbI2uYrlP2G8iL3G4TnDSNbZQwynI//3d736XGPV1RyERNjrNqm5SiPJDs5QoK9ygmzJlinXQSoqgIdCIoOGRlzFX3CDS2rdvn+U9xxiiqciHH36Ycf6Ba6BHjx72XvE9HCOOF1t4vDDQWYuuUE0jPNqDkTtw4EBLXUVQuMGNUUtaHo0WiAJ27dpVTpcc8CYWSWmOnHPSBn/7298WlXBgP9ni555rhWso/I75BscQcw/zDHNR/Bj7PISjUGm5QpQvmqlE2RAKNFIc4xE0jHKiAUTXtA5aacD5w0CPCy6EBlE0IkOk7zkYcB55kyH/AwgfjlVSvczRRx9tQqixjUjuXe5hUsGI5CEqkgQadTwsmOsRNBm7NcO9gWihg2dSmiNj5DnnnGOPxeTI4H6m7Xr8/DMvNGYkza/b888/v2o9zlCg+TGWo1AIoTtflAVMwBiYtAgn/786gcbEqTb7pYMbZoi10DjDECWKRmpcGBlCnGHUFyIqlGYQP9TMEGFxOKYYkLvsskujp7yxH9QScr+OHDkya9FfzjVRnm222cYWyCWCJmO3dhALjJO0eWdB5aQ0RyJoRJqLJc3R4dzjeItfA8wNjSXSXKANHTrUUm8Rw+H44/MQc5QchUIIzVii5GHypUaFtWeY/OKLhDIxMhkycZ544omaGEsIDEvOJUItNM5Ik1uyZIkZTaFxhuFJxzqJtB/AiFyzZo1tcUFLKlbTpk0b7X7xe/mjjz6yKMP48eOzUpbZF5wsCDPqThFqquepHT+2M2fOtEV941FTopLUoLFeWrEK3qRrwL9j+F3zAXMOzgTmGdJzEWhhDZoLNLI8WCtNjkIhhEYAUdIw8eINplaFVtFxgYZB5wKNyVECrfTA+PFomuMpTmGaESA81DQkE4QsDSTC+wYw2omiNVbbfQxaUsOoi0Mcvv7664mGLvcwKZhE0GhqUohUzGKE8/uXv/wlGjZsWJbw5b6giQWLvhdbmmMa4Ngy97hAqy7FEScir9E8JIQAiTRR0pAWtXjx4uhXv/qV1azE07WYDPFaukCT8VF6cJ5pY52L0cP5p4ZNBtIPcM8QRQvvHURPY0YdEQwIMlLEiKDRaj/ewZH98EgE66BxHqmZE7XD8f3ss8+iiy++uFpH1nnnnWdNeIrZgZEULeNa9i0fcN8w95Cam9QkJBRovuac5iEhBEikiZKFyRGDA6ON9KiwvoI0EtJJMPiYHDUxli6c63i6YxIYo7Rp32yzzZRmFEAk7dlnn81KKeQ4NWnSJO+CFsFAHc+YMWNMKMTvZUCMcY7phkdLczrjNYZ4LAW8Q+bdd99t7fbjYpxI6RFHHBH179+/6NNGEUhxuNeJEubje3Gdcr3iCKxOoCGAlWovhEhClogoSTDsyP9n4osXwLtAI2WKTo4SaKWNe8lrE15cAzREwLgvZkO0IcGA/9vf/mZbPP2NtZvyGVXxVGWMXLo3ItLiDX84T6QzEjW7+eabFYmoIwgGas/ofsnx4+dQRCB+aaQzYsQIGzOLWUDwvRCZ4fcDxgXfGgquXSK9NS2u7pFfnApKtRdCJCGRJkoO76BFiuMbb7yRUQCPUUfR+/7772+LhMrjXvpgfGEM1WaEITiIDul6+AFE2ttvv50h0CDfqY4Ysxi1GLcDBw6MJk+enFUnxfnkXmaNtkceeSTq3bt30QuJxsSFBI1CaAVPNC0uxL0OrRTGSa7ld955J6OGEZgTGjKSFl67Bx54oNVDJ6XmckyvvPJKpdoLIapFIk2UFBgZGBssVB0XaOAdypgcqVMq5voKkRsY7e3atatVpPE6am5kLP0ADo8vvvgiI3oFGJkbb7xxXu4fT7/zBaqTohCcKwxb2pQj0BBqarFfN0hrpMPpmWeeafVo4TnmHsCxQR1V586dS6K2j+9HVDb8nlwviCWup4YQaVy7XKukNnLtVlc7yf9kHTQa3EigCSGqQzOaKBl8gsQrzJpOSQKNSMldd90lgVZGYHxhjNVmhGEoUZMmg+kHcHq89NJLGREWjiPHaKeddmpwUYQBTRSc1vqkOHr9WZKRe9JJJ1mKHve0OjjWDW9mQXpoUkMlIpIcf1L1SmX5Aq5huleG1zLXcUM5ZtxBSHMbaifjxxWYc6idxEmoddCEELUhkSZKAhdorIvEQqz8HKa14AmmboW0KYw6dX0rHzAwfasO/pYv4VHMYHhS2xkathwfnBwcr4Y6Vogwrz/DwCWCg1ijttThHHHfIqS5x2kSsuGGG8rZUkc4pjRUQqDR+TapUQhNQhBppZI+ylzA9yb1MJwXEPwsucHjusBnc59cf/31du3GO2SCz0FXXXVVdNRRR9mx1VgjhKgJjRCi6MHAI6WEtCc8lPHaFfdeEkFzr7soHzA8N9lkkxpFGoYoBhTGmgynHyDF8NNPP81KNXSR1hC4g4X1zxAHvkB1PC0N8YBBTRfCgw46SA1C6gHHlPNJR1sW94+n4nk6OM0sOC9EhjgXCLlQ3BQbfG9SEPke/n1d9LPoeX2FvjsXaKxD1LGm5jbMPVy71KmpdlIIkQuyRkRRwyRJWiML29IIBAMknCA9NQrxRm0Fhp4oLzCSuEZqEl8YTETRZPRngjjDUI+LNFLEGsLIxJmCCECYIdAQavEoOOeNerOePXvaAtXeIERium4wLiIg6Gj71FNPZaWDI1gQ35deemlVp8wBAwZY45BJkyZFy5Yti1atWmURI8Qd5y58f1rh2uWaeuGFF2y/Ha4fFjtHpNXnvnfnAnMPwovHmprbkILfrVs3XbtCiJzRSCGKGgwNus9hTJAqFaaYMPHibce7Sbt9JsuaoimiNOGc+zpp1Z1/POk0wljXtKdSAuMWQxSjPDTGEWe5dMusDU8RQzSE65+F/8vvYSJnCAeMXRwtMnLrhgs0Ogl6vW4ovLn+EWg0XDrttNOiBx98MJo6dapt1157bXTqqaeaSCZadO6550Zjx46N3n33XVvkHBHP56dVsHGdvfrqq9Fzzz2X4cBDlHbs2DFq3rx5nR0OfjwfeughaxCycOHCLNHLNYogY+7x5jalUt8nhGgcNNOJooXUFbpnhQLNJ0kmXYqyqQ+gQFvey/IFo4hrgZTH6uB62X333RVJC8CIxwESGvMOx7S+xib3KBEN7l0M3DvuuCMrRQwQDtScIRyoQSMdFcNaRm7dcEFBiiMdMxFVYaTS08GJoL3yyivW8MJTHBHNvJ4On59//nn08ssvR/fff380fPhwEx9EP4m0zZ8/3/5HOAanAb4n3wWhSdTLr2WuIQQT0cK6pL/zfo4HDUjOPvtsm19qcy5Qg6bmNkKI+iCrVRQlGAOkNg4bNiz68MMPswwDomYYECeccIIEmohWrlxpW3UQQWOTSPsBDFxSt8L0rXWFz8LIJTWMqMz06dOzRAOGLAYtogxxNnjwYDUIqScINK9Bo6lSKFSAax4xQao4aaS04mdsTYIxlvOHwCYCSuojog4BxFhLhA2xxt/SINb4/0S37r333uitt97K+F5cS506dYp22GGHnK8rvjuC75lnnrF1NhGrfNfqnAs0tqHTsDoJCyHqiyxXUXRg0GHYMQnSHjw08ABBRlSENCq1OBaAUK8Jrhl1dsyE+2rp0qWJkbS6gsFMZAajlg54YYpY+Pkcf6/hIUWMSITu4fqBKOF4jxw5skqghWOlR3sYJ6mp8vXCcj3WnFMECsLlgw8+sBRJomuINdILv/zyy4xGHY0N0a25c+dG11xzTUYqIt+PawoHXy4p8FyfHvklaojTgJ/57nHnAtE5ombjxo2zJSLkXBBCrAuySERRwYSJscEkSLcuN/J8osXIY+HiP/zhD2Z0qMZIYJwh0lq0aLH2mUy4ZjCmMFol0n4AA5QUtrgTBDimuRrf3J/cp4gyxBkirbYUMQTadtttZ0a0zkndQRwhkk488cQaBRoRNm8HTyrpkCFD7Pm6Cgs+m/9BjdoDDzxgkTXS0F977bWCRNb4/rTBZ6FuruEwGkyU9rDDDov22GOPGr8n++tC9/HHH7fvQ30zojT8Lvzswo/GIFy7RCXlXBBCrCua/UTRwGSIR3PWrFnR6NGjs1J3mHzbtGljAq5169byYIoqli9fbjU1SWBINVS3wlKCe4tUubhI43ki2bkY3V4P9cQTT5jh/vzzz5uRG0+h5F7FqULrdy1QXX84J4hfRDDii3TSmgQaIs7FBOeADARS9BhHmzRpYiKZ1+d6Hvg/jNG0pKdRh6dBIta4Drgecrlu1gUXVtSbLVmyJCPN0TtYsk81pcF7Wu6CBQuskQobKbrx1FyHa5f/R/dRosByLgghGgKNIqJowDvKpIt3NG7oETFjomQttB133FGt9kUGdHBDXCQZiBihDbnuV6nA8eI+Cx0hwO8Y3PHnQ/ibp4iNGDHCFkbmZ54L34fxH9afIdK4j+VgqTscVyKWb7zxhtXi8hh3ZPk4STMWREUY7UFUIFxIfcQRhrPr2GOPtYgmoo735irW+J+IRRqOEFmj/pBmI/PmzTMBla80SAQZETS6WMbXgeP+5vvedtttUcuWLROzLDwiSJ3z7bffbiKTKFo8dZPj4FuzZs3su1188cV2Hcu5IIRoKCTSRFGABxavPgKNSTj0jmJkMPmSRtWlSxe1ORYZ1GYMukhTJC0TjltSxIzfaTBR3XF1Q5coDkYu3Rs95S0EUUDEgXWqiEBoger646IYcYUgRqCFdVjgAo0mIWEELcTPSdOmTaN99903uvrqq6NHH33UBAjt6l2s5YpH1kiDdNFDVIqaNQQcQi4UkfWF7+kRRDouxteB8zli6NChietl+jW7evXqqv3EuYBjwVPqQzgGpEjvt99+0bRp06LjjjuuzsdGCCFqQyJNpB4mUIxFWhlTCM5k7Lj3l1oXPMAYGBJoIg7pjtWBAUe6o8RBNklCDIOV5+OGqxu6XpfEPZm0ODW40UztDgJNi/zWHx8fWayZ9eYWL15sY2R47ohM0mYfgXb00UcnCrQQzgOpgQgRUsepVXOxRirkRhttVKflEPzaIELFwtiIILZnn33WukQSmUXE10ew+fefPXu2XXPUKvO//LP4nj5HIBB9juD4eFqjizManxAVo0slUWScgyEuYlkEm/mI65z0Ro5TTcdTCCHqw48qB6pkd6gQKYDLkwmXRUPxkDKZu8HHRItHFEOP1BwMBxnaIg6GGOsasRgvxlgc0pUQCkQOdP38AClev/nNb6y2KHSMYIxSu0SDBNJIuR8xsDF2H3vsMeuAR9SbCErcyAUEAyIBo5naIKU31h+OL8ed8Y86XYQF5yKc1r0OC4Hmi/rXR1BwH3EdEFkieoSoIX2R39mPUGAlmRWhoONnzjnjNwKK9Mzu3btbVJV0QTbuxZpEO/+P78p3vu+++yzqx89hWqI78ajPoxswQpXPZX+5Pt9//30Td2RhEB3mOb5n0v6zv3wWDUdoTMUxZT8lzoQQ+UIiTaQaJs05c+aYQUcqS2j0MUFus802Zizi2ZShJ5LA6Jo6dap1Z0sSaSxyTf0KdSqK5PwAKYoYo4gu7kMHA5tjxn258cYbmxOFxiBESFg3i9+TxBnv457FuOUz99xzTzN6JYzrB2IEpxXRrYkTJ5pY41p3ON4INOqk7rzzTksFR6Ct6zWOOOJ/c54Ra7TepzEIv3s0rCazIhRrwPln7Gbftthii6hv376WWsn1gYjjO5BG6PvtTgHEIdcb1xLroPF7+P0RT3xmr169rFaZa433ci0T4R0/frw1sqGhEOIz6ZoF9o/9QOAhBHv06GGfpflGCJFvJNJEamHSpCaAonMm1dCbz8SJ8UEEZJdddsmqMRDC4ToirQqhTypeCIYfSzZQy1Ndi/5SxyMSbBix3FsYxhjiRLpI6UIAhCDOEHAsEM6xIxqRFFFx+EwM5p133tkiMN5gQaK47jBlMxZ+/PHHthYXKeAce88wABfEHTp0iO6+++5o6623tjEyLpDWBb9u+N/vvvuuiSVqzRD31QmekPi+8LsLNvaVNEKalvzyl7+0dGSEEd8dYYooI/0yFIehKcPnEK099NBDLQODz+N9t9xyi63pxnxCmiXHMTxuIYg8jiG1ZtRCH3HEEeac0HUrhGgsJNJEKmHiZFLFSJwwYYJNxH6pMkH6xMnGZNyQxocoLTDgXn75ZauBoTV4CB560hwR+zRLKDcwprm3iDQ++eSTZmAjwFjolzb4HBcaKPB8CMcNY5r71LckcYahy+u4X0855ZTo1FNPtZ8RgaLuEClCFBH5pU4MoYbQCKdxxkcXxLTTR6ghLPI1RvK/XawhGEkdJEXWr4tcCfePn/3aQXDxnXjk2sHRwnXLxueH393fhygjgkYqM9c39z/Hif10YZZ0vQL/i+PFvEJ3y1//+tfRVlttZZ/JPgghRGMhkSZSCRMrdWgUwsfr0DBA6ATHekrUs2jiFDWBUXb//feb4KfOKgRjjM5spDFR01hOYKRSw0OtDo4Q0sC4zxBgpJ1RX0a04ZBDDslIE02aMpIEAMYuhi4LBxPFZGkM7l3dr/UDgcH5omEFNWhEN4l2hiBQiDhRe3bFFVdYih6COOn8NDQu1nCEkIZIV09SYtlPnm8MXKR5tIvr2cVcdaLM4X0cK65RHDekkXL8XJw1xjEUQogQxexF6mBCp80+hjMTvAs0wLNK6gvefQxAGXyiNjDOaAqQZKRhyCH0eSw3iMpgTFPPhHglEoLRzz1HFz7qmLgX/f7DCK/Opxc+jzGLsYvoPfjgg01U0BSCKIju17rDdYvTijQ9xC7por5uVwhjI10GSYFkzbnGXrPLzzspgXTaxclGvfDgwYOtwUxjiEWuQ65XjheClmsakVaTQOOaZC7BMUF65NNPP21pkXSxZGzAaSGBJoQoBBJpIlVgODK5nnXWWdYhjgnW8cmUFsl4ODFKhKgNDDSMxCSB4dGecjTCEGCsZZZUl8Nzf/zjH6N+/fqZaKtOnMXheBJ5oKEPtVCk2yHWuFdl6NYdzhGppjRmITpGm/2444rjihhDlCHOiIwi1go1PnINsD+kzdIJceTIkSZ8Tj755Kht27YW6SNq1dBwHHK9xphLiJiR4sw+Md9Q44Y469SpkzqOCiFSgUSaSBWkXDFR0owAQ9Fh4mdSZZ0bun5hBAiRCwiMZcuWJQoNjDquLbZypDoBhrOEvxGxCR0lNUHEAUFGNIJatj59+lRFIkTdwLHAWEjjJBanZtxLWljZ0xtpsEHUishlWiKW3FsIHa6BHXbYwZxrzzzzjI3vLOGAQGJMz1VYVUeu4syFWZMmTaxJEHWXpI0y1/Dz9ttvXyXO1nWfhBCiIVBNmkgNpO+sWLHC1rOiriFsp4x33he+1Xpooi5Q03jOOedYl0KM3BCMMtLxaA6AAVdOcL9Rd0Yzjy+++KLGaFlt0wRCjAgEHR9pWMGxVJpY/UAUk6734osvRpdeeqmt8Ydgi6fseWYBXQfpYNiY9Wf1hQgg1x0OOFKQaVbDmD9z5kwToR7VjV9v/jvOlFCUhY/xjddyjBCyXItE9mgexFpstPhHJHq9Wbk6aYQQ6UYiTaQCJmbSephEaauMUeIwwXqnOdrtY4gIkStEg/Dijx07NiM6Cwh+F2nlFp3F6OfYsMSF33M1TQfV/Q2DmEY+l19+ubV6b8w6qFKC88H1SZr3NddcY+l3iDVSHsNjz7FlDCRiRjMc6tQQa8UWscQJx4Zo49ojckt3SL4va2IuX77cvhMLTvMaRCi1knx/ooc8z/cmXdF/pjkN657xGn7meOI06Ny5s0XI2Lg+JcyEEMWARJooOFyCGCMsiurdHP2yZCIl2jF69OjomGOOsclZBqCoC0SJWMiaNvMYeyF41+kSSgfCchT/HI/FixdHQ4cOrVoQOF6f5iRNFdyLGLykkBEVIZomJ0rdQZgwBpIOiEBbunSpCZf4uSAqRJRyp512MscD4oPf81Hj1dggUn1DvPHdw2wKv/74e3gt+nwQRtnY+J3jwvUpUSaEKEYk0kTBwUBhcVGiaHhKwxoY0lGos6COgWL4UjBGRONSk0hDXFCXwoK55dgogOGfY+LRG9a3ItXYO+Lxd+45Nn73mqj4tMF9yrpUCF4aWJTjsawPiBCiPXSzJRKJSEOscfzDY4zoIKpEtOg3v/mN1agVQ3qjEEKI+iORJgoKBp8vWk3LZgwUB6Nk8803tzTHbt26yUMv6gXdQjGAb7vttozrC6hL4fpiXaRiSxdrSBAFRG5IMXvjjTcs3YxmKzRYIALRsmVLa04xe/bsaMyYMXZMw6mD1xDRofU6HR0L2V2wGODYIY45jrfeemt03333RStXrrRzwJgYgkBGBLdr185qK/fbbz/LKCjn61UIIcoBiTRRUDBKpk2bZnUV1KR5eg/eYU9zPPbYY5XmKOoNxjANMog+ECXyIQ/jFxHy1FNPWWe3co/Sclw8xcwjOWyeNsaGqDjqqKNMrBEBCgUFr+M+JaLGQsYu1HTf/gDHk8wBIpJvv/22iS4ag/B7mNoHYfTs8MMPt9cSPaOmSql7QghR+kikiYKBUUJHL9IcFyxYkJGKhiHCAri0laZuqNwNaFF/EBI0yDj66KOj119/3a4zDGAiPyz8S2c8mjBITNQOx27JkiUW+aZ1ebxbpkfUWCZj1KhRtvC8Gol8L84Qvhyvd955J7ruuuuil19+2SK78cYgwHin6JkQQpQ3EmmiIHDZ0c2LFDQWOw3TpyjypuseAg2hhpEnxLqAuKDlNws0k85HdGLvvfeOjj/+ePuZa07UDvcoooLa0b59+5qThWMbTiMINQQGXfVGjBhRUs0t6oOnkpI+ynj35z//2cY+jmM8tRExS/SRa5JmNoqeCSFE+SKRJgoChgvRs6RmIRgoZ555ZnTWWWcpwiEaDK4xBAWPbgxT56gobd0hIkS7dFJIiazFlzbg+HJsSVm+7LLL7D4nElROjS64zjgu1JrdfvvtJs74meeSOmjiKEDM0jr+97//fbTHHnsoeiaEEGWMRJpodLjkaBZCC2mMl7CZA4bzlltuGT399NPRFltsoQiHECmEe5joEO37SSOl0QgCOB4ZQmAgPIiqXXLJJdY6nt95vlTFWijOqM2jqygNWThe8bozwEmAeKU5C5HdU045xZxTjIWKngkhRPkikSYaHdJ8WDyXRXTXrFmT0SyEZgM33XRTdOihh5oXWQiRTlyo0fiCur6XXnrJImxJKXyIEO5numgSIafWipRInDClINY4Fogzjgfi7M4777TlDFycMcbFp1oEGEKM49KvXz8TZ+FxEUIIUd5IpIlGhcuNLo40HnjggQfMgHEw5HbddVerRWP9KnmRhUg33M84XVjna9iwYdHMmTNNqPFcHO5n7nGiREOGDDFHTNu2bU2UFGtkDfHFd+U7z58/Pxo/fnz0+OOPW3aApzXGp1i+p0cYd9ttNxNnu+++e8lHGIUQQtQNiTTRqJAS5VE02qF7FA0DjmYhLCy8zz77qFmIEEUEQgVhgkg79dRTzRHDve73dwhRIsQatafHHHOMLVbPEgiINZ5Pe40gU6anNK5atSqaPn169MQTT9i45t0ak743IML4nltttVV08sknWwSN46DURiGEEHEk0kSjwaWG8YYRx7pVYRQNUUa3vXvvvdfEmgwWIYoL0hy9xTzR8Pvvv9+6GFKHlTTNeC0WESREGrVtvXv3tgXGGQ8QLrwmDZEl9p/vgTBj++CDD6K77rrL1otbsWKFjWUIt3iqp+PibJNNNokGDx5s4oyf+Z5qXCOEECIJiTTRaOBhnjdvXnTAAQdYLZobNAgy1kIjitanTx9F0YQoUphOECuIM0TaPffcU2PTDPD0P+57BBuLYXfr1s3WWtt8881NyPF3jzY1lgOHaBjfhYgg23vvvWeRwieffNKEGWLNo4VJ06h/LxdndKz1Wlu+q+rOhBBC1IREmmg0PIo2adKkrCjaIYccEt1yyy2KoglRAiBcEDGffvqprQ3GPf/555/bc9WJNeDeR9ggzNgQadtss020//77myOH7pCIGzYiUDy6cAu3XKNvTH84i9gnHnEkMTYhvli7kRTGhQsXRk899VS0evXqKsFWXXQQ+P98BwRnmzZtLHIWijNFzoQQQuSCRJpoFPBI41Hv2bOnGTtJUTRq0TDMhBClgddusZA4y22Q5hyKtZqmH4QW4wMRNI+kIco23XTT6Oc//3nUvn17W4eNjoi8joYktLHnkS0kFG3h/+TnpUuX2pIgdKlkbJo2bZo9539HlPE9ahKXwL6xj4gzFuGn3o7MAMQZ45rEmRBCiLogkSYaBbzS55xzTvTggw9aKpSDZ1m1aEKUNqFYe+ihh6zRhtdyEb2qrpYrjgs3j6LxyO/xjdfFo2k06AjHHuD/JkXSfFqMf0Yc/o6AZBxr3rx5dNBBB9l4RpdaxJmnaAohhBB1RSJN5B1SnzDI+vfvb22q3SONgYMwo25FHR2FKH249xFrdEWkPpXmG3PmzLHnEEeIuVwFW74Ip8QkkcZzCETGKyJkrVu3jk488UQTZvxMDZqnYQohhBD1RSJN5B2ML9ZEY2006tL8ksPL3KlTJ6v3oKObjBohygOPWiHO6Ag5ZcoUa2U/Y8YMe46/sVXXlCOfxP8fooyxyVMuEWbbbrutpTSecMIJFkFzwUZkL0nYCSGEEHVFIk3kHdZDGzhwYDR16lSr73CoJ7nqqqui4447zlKDhBDlh3dRxJlDTdgbb7xhXRRp2LFkyRITa0TgeA2vZctntM2nRMQW4ovIGIvr08CEmtrtttsu6tq1q9WeIcwQb0IIIURDI5Em8grGlTcMIcXJjSs8zqQGsZ4SaySRHiSEKG9csCHMcOh89NFH0aJFi0ysffzxx9bc45NPPrEaVxdsLtqYysJHqGl68wgZj17bxjjE77yfBiWs20aN2RZbbGGbR9L89UIIIUS+kEgTeYVUprFjx0YjRoywVEcH7/Sxxx4bXX311dGGG26oFCEhRAYutjyKxiObCzM6MDKm0OafhiS8nuffffddS0FcuXJltSKN8YZGIgitrbbaykQXnSHpGkkKNngbfaJpXmOmcUoIIURjIZEm8soXX3xRtTZamOpI233WRevXr595poUQIldcwOUjkqYomRBCiDQgkSbyBoYS3mzqN3h0wwkjiEVeZ82aFbVo0UIGkRBCCCGEEAGyjkXeIDWJBgBE0FygAWlEvXr1sjQiCTQhhBBCCCEykYUs8gbF/4sXL7bHENIbia4pzVEIIYQQQohsJNJE3kCc0ZktFGnUf7hIU+tqIYQQQgghspFIE3mDjmwvvfSSpT061KNtvfXW0WabbWY/CyGEEEIIITKRSBN5gRq0L7/80oRaWI9G9zQEGusNqZ21EEIIIYQQ2UikibyAMFu2bFlWC2xEWvv27RVFE0IIIYQQohok0kReQJyxEGwYRQPE2aabbmpiTQghhBBCCJGNRJrIG99+++3an36AlvutWrVS630hhBBCCCGqQZayyBtJNWc855sQQgghhBAiG4k0kRc8YpZUexavUxNCCCGEEEL8gESayAuINK89C1MbqVH75ptvsmrVhBBCCCGEEN8jkSbyAumMtNnfeeedM5qE0JJ/yZIl9iiEEEIIIYTIRiJN5A1EWteuXe3R+de//hXNnDkz+uc//6m0RyGEEEIIIRKQSBN5A3HWrVu36Cc/+UlVyuP//M//RAsWLIhWrFihaJoQQgghhBAJSKSJvEGa46677hp17969KppG9Ozvf/97NHbsWGvRj2gTQgghhBBC/IBEmsgbRM9Y0HrIkCH26NE0Uh3/9Kc/RTfccEP09ddfK6ImhBBCCCFEwL9fVsnan4VocBBmLVq0iN56663or3/9q0XO6Oz4v//7v/bcJ598ErVr186e/+677yzKhnBbvXq1te/n/Ult/IUQQgghhChVflSh7g0iz9As5KOPPooGDBgQvfnmm9E//vEPS3tEfFGvxrbRRhtFrVu3ttch0hBnhx9+eHT55ZdHG2ywQVUUTgghhBBCiFJHIk00CggzBNrQoUOjxYsX2+/xtdJciPE8Aq558+bRuHHjor333jujjb8QQgghhBCljMITolH48Y9/HHXu3DmaOHFi1KdPn2jjjTe2OrUwlZEUSC1yLYQQQgghyh1F0kSjQuojdWdvv/12dNddd1k7flIcqUdbb731TLSxEDaPhx12WDR8+HClOwohhBBCiLJCIk00OlxyiDW6PJL2+MEHH0TNmjWLVq1aZbVp66+/vv2tadOm0U9/+tPoP//zP9e+UwghhBBCiNJHIk0UlOouP6JpQgghhBBClCMSaUIIIYQQQgiRIlToI4QQQgghhBApQiJNCCGEEEIIIVKERJoQQgghhBBCpAiJNCGEEEIIIYRIDVH0/wEAS/P5fqBk2AAAAABJRU5ErkJggg==","description":"The base64-encoded data sent when a signature is captured as a Portable Network Graphics (PNG) file.\n"}},"components/schemas/SignatureFormat":{"id":"components/schemas/SignatureFormat","kind":"json-schema","title":"SignatureFormat","data":{"type":"string","minLength":1,"maxLength":1,"example":"P","enum":["P"],"description":"The data format the signature data will be in. \"P\" for PNG format.\n"}},"components/schemas/Signature":{"id":"components/schemas/Signature","kind":"json-schema","title":"Signature","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SignatureData"},"format":{"$ref":"#/components/schemas/SignatureFormat"}}}},"components/schemas/SurchargeResult":{"id":"components/schemas/SurchargeResult","kind":"json-schema","title":"SurchargeResult","data":{"type":"string","enum":["P","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of the surcharge eligibility check:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass - Card is eligible for surcharging"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fail - Card is not eligible for surcharging"},"children":[]}]}]}]}]}]}]}},"components/schemas/RulesTransactionId":{"id":"components/schemas/RulesTransactionId","kind":"json-schema","title":"RulesTransactionId","data":{"type":"string","readOnly":true,"maxLength":20,"description":"Transaction ID for the rule check\n"}},"components/schemas/SurchargeTransactionResponse":{"id":"components/schemas/SurchargeTransactionResponse","kind":"json-schema","title":"SurchargeTransactionResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing surcharge information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned in the response if Surcharge was applied during the payment flow of a Commerce Engine controlled device."},"children":[]}]}]}]}],"properties":{"result":{"$ref":"#/components/schemas/SurchargeResult"},"transactionId":{"$ref":"#/components/schemas/RulesTransactionId"},"percentage":{"$ref":"#/components/schemas/SurchargePercentage"}}}},"components/schemas/TransactionAuthorizationCode":{"id":"components/schemas/TransactionAuthorizationCode","kind":"json-schema","title":"TransactionAuthorizationCode","data":{"type":"string","maxLength":6,"example":"198399","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization code provided by the consumer’s issuing bank. It is provided in a response if an online authorization or sale request is approved. Following a referral response, it is also specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/manualsale"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests."},"children":[]}]}]}]}},"components/schemas/TransactionAuthSource":{"id":"components/schemas/TransactionAuthSource","kind":"json-schema","title":"TransactionAuthSource","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"E","enum":["E","O","A","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a response, a code returned by the processor to indicate which host issued the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engine (Online)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM (Online)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Platform (Online)"},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseReasonCode":{"id":"components/schemas/HostResponseReasonCode","kind":"json-schema","title":"HostResponseReasonCode","data":{"type":"string","maxLength":3,"example":"04","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a response code from the host."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pick Up Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pick Up Card, Special Condition"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Such Issuer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lost Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stolen Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"46"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Closed Account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"57"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trans. not Permitted to Cardholder"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop Payment Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revocation of Auth Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revocation of all Authorization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Merchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"19"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-enter Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"51"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not sufficient funds"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"59"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspected Fraud"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"61"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exceeds approval amount limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"62"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricted Card (card invalid in region or country)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"65"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exceeds withdrawal frequency limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"75"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowable number of PIN-entry tried exceeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"78"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blocked, first used"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"86"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot Verify PIN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer or switch inoperative"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"93"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cannot be completed - violation of law"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"96"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System malfunction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash service not available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash request exceeds issuer of approved limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"14"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired card or expiration date missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"55"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN incorrect or missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"70"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN data required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"82"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative Online CAM, dCVV, iCVV, or CVV results"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional customer authentication required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline for CVV2 Failure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not honor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Honor MasterCard with ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"39"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No credit account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"52"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No checking account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"53"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No savings account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"58"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not permitted-Terminal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"63"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security violation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"66"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Acceptor call Acquirer’s security dept"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"67"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard capture (requires ATM pick-up)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"68"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response received too late"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"71"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN Not Changed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"76"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsolicited reversal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"77"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Data including AVS failures."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"79"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Already reversed at switch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"80"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Financial impact"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"81"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cryptographic error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unable to route transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"94"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge amount not permitted on debit cards or EBTfoodstamps"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge amount not supported by debit network issuer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CV"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Type VerificationError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acct Length Err"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check Digit Err"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CID Format Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HV"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Verification Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force STIP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN Change/Unblock failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New PIN not accepted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unable to go online; offline-declined"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-38"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been denied by the Gateway because 3D secure Authentication failed. Reason: {}"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The “Reason” part is optional and may appear according to detected reason."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline Retry Later"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other, generic declines may be classified as a Category 4 response code."},"children":[]}]}]}]}},"components/schemas/HostResponseReasonDescription":{"id":"components/schemas/HostResponseReasonDescription","kind":"json-schema","title":"HostResponseReasonDescription","data":{"type":"string","maxLength":73,"example":"Pick Up Card","description":"Returns a description from the host.\n"}},"components/schemas/HostResponseReattemptPermission":{"id":"components/schemas/HostResponseReattemptPermission","kind":"json-schema","title":"HostResponseReattemptPermission","data":{"type":"string","maxLength":40,"example":"Reattempt not permitted","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one of the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reattempt not permitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the reasonCode returned is classified as a Category 1 response code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reattempt permitted 15 times in 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the reasonCode returned is classified as a Category 2 or Category 3 response code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reattempts permitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the reasonCode returned is classified as a Category 4 response code."},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponse":{"id":"components/schemas/HostResponse","kind":"json-schema","title":"HostResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the response code detailing why the transaction was declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Visa, the response codes are categorized, detailing how declined transactions may be re-attempted for approval. To avoid fees, merchants are responsible for preventing additional attempts based on  the information returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for this field is dependent on the processor. Our demo environment does not return this field in the response."},"children":[]}]}]}]}]}],"properties":{"reasonCode":{"$ref":"#/components/schemas/HostResponseReasonCode"},"reasonDescription":{"$ref":"#/components/schemas/HostResponseReasonDescription"},"reattemptPermission":{"$ref":"#/components/schemas/HostResponseReattemptPermission"}}}},"components/schemas/TransactionResponseCode":{"id":"components/schemas/TransactionResponseCode","kind":"json-schema","title":"TransactionResponseCode","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","C","D","e","f","P","R","X","S","I"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is approved without requiring additional authorization because it is less than or equal to a ceiling amount. (The ceiling amount is the original authorization amount multiplied by the tolerance per the merchant’s settings with Shift4.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is declined. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Shift4 automatically declines AVS/CSC failures if the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options#poshandleavsfail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POSHANDLEAVSFAIL Api Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not sent in the request."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an error condition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/response-handling/understanding-avs-and-csc-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AVS or CSC failure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An AVS or CSC failure has occurred (credit card only). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This value will only be returned if the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options#poshandleavsfail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POSHANDLEAVSFAIL Api Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was sent in the request."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/partial-approval"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial approval"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A partial approval has occurred.  Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the approved amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice referral"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction requires a voice referral."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[blank]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status is unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The approval status is unknown."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an error condition due to the card being expired."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA Online PIN required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contactless EMV transaction requires strong customer authentication to continue. The terminal must gather the online PIN if supported by the device form factor and CVM list then resubmit the transaction request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"I"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA Interface switch required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contactless EMV transaction requires strong customer authentication to continue. The terminal must look at the form factor indicator to determine if the transaction should be declined, switched to EMV contact or tapped again using CDCVM."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"J"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft decline after exemption request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction was soft declined. Returned when requesting an exemption by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.exemptionAction = 02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the card issuer rejects the exemption."},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionRetrievalReference":{"id":"components/schemas/TransactionRetrievalReference","kind":"json-schema","title":"TransactionRetrievalReference","data":{"type":"string","readOnly":true,"maxLength":12,"example":"402F9H0230S0","description":"Reference retrieval number assigned by the authorizing agency. This value is printed on some receipts.\n"}},"components/schemas/TransactionSaleFlag":{"id":"components/schemas/TransactionSaleFlag","kind":"json-schema","title":"TransactionSaleFlag","data":{"type":"string","maxLength":1,"readOnly":true,"example":"S","enum":["A","C","S"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a transaction is a sale (‘S’) or credit (‘C’).  In an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/getinvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, an 'A' may be returned to differentiate an authorization from a sale."},"children":[]}]}]}]}},"components/schemas/AVSPostalCodeVerified":{"id":"components/schemas/AVSPostalCodeVerified","kind":"json-schema","title":"AVSPostalCodeVerified","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies whether the ZIP/postal code was verified (‘Y’) or not (‘N’) in an AVS check with a processor."},"children":[]}]}]}]}},"components/schemas/AVSResult":{"id":"components/schemas/AVSResult","kind":"json-schema","title":"AVSResult","data":{"type":"string","minLength":1,"maxLength":1,"example":"X","enum":["A","E","G","N","R","S","U","W","X","Y","Z","1","2","3","4","5","6","7","8"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the response code returned from an Address Verification System (AVS) check with a processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address matched, but ZIP/postal code did not match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error (AVS data is invalid or not allowed)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"G"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issuer does not participate in AVS."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No street address and no ZIP/postal code match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issuer system is unavailable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AVS service not supported."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address information unavailable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"W"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address did not match, but ZIP/postal code matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address and 9-digit ZIP/postal code matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address and 5-digit ZIP code matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the ZIP/postal code matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name and ZIP match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name, address, and ZIP match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name, address match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name matches"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name incorrect, ZIP matches"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name incorrect; address and ZIP match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name incorrect; address matches"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder name, address, and ZIP do not match"},"children":[]}]}]}]}]}]}]}},"components/schemas/AVSStreetVerified":{"id":"components/schemas/AVSStreetVerified","kind":"json-schema","title":"AVSStreetVerified","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies whether the street number was verified (‘Y’) or not (‘N’) in an AVS check with a processor."},"children":[]}]}]}]}},"components/schemas/AVSValid":{"id":"components/schemas/AVSValid","kind":"json-schema","title":"AVSValid","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simplified AVS result based on the merchant’s list of accepted responses as configured with Shift4: (‘Y’) if accepted or (‘N’) if not accepted."},"children":[]}]}]}]}},"components/schemas/AVS":{"id":"components/schemas/AVS","kind":"json-schema","title":"AVS","data":{"type":"object","readOnly":true,"properties":{"postalCodeVerified":{"$ref":"#/components/schemas/AVSPostalCodeVerified"},"result":{"$ref":"#/components/schemas/AVSResult"},"streetVerified":{"$ref":"#/components/schemas/AVSStreetVerified"},"valid":{"$ref":"#/components/schemas/AVSValid"}}}},"components/schemas/RiskTranId":{"id":"components/schemas/RiskTranId","kind":"json-schema","title":"RiskTranId","data":{"type":"string","example":"DDWT0P3LG6LL","description":"This is the unique transaction ID for this response from the 3rd party risk provider. Store this value and use it to find additional details about this transaction within the 3rd party risk provider's UI.\n"}},"components/schemas/RiskAssessmentDeny":{"id":"components/schemas/RiskAssessmentDeny","kind":"json-schema","title":"RiskAssessmentDeny","data":{"type":"string","enum":["D"],"example":"D","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the answer to the risk assessment."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deny. Try another payment method"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskResponseDeny":{"id":"components/schemas/RiskResponseDeny","kind":"json-schema","title":"RiskResponseDeny","data":{"type":"object","description":"Returned if risk assessment was performed and not approved.\n","properties":{"tranId":{"$ref":"#/components/schemas/RiskTranId"},"assessment":{"$ref":"#/components/schemas/RiskAssessmentDeny"}}}},"components/schemas/UniversalTokenValue":{"id":"components/schemas/UniversalTokenValue","kind":"json-schema","title":"UniversalTokenValue","data":{"type":"string","maxLength":50,"example":"97032276-5944-00000001-16985FD179D","description":"An identifier for a card or payment account across all Shift4 merchants.\n"}},"components/schemas/UniversalToken":{"id":"components/schemas/UniversalToken","kind":"json-schema","title":"UniversalToken","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/UniversalTokenValue"}}}},"components/schemas/PaymentAccountReference":{"id":"components/schemas/PaymentAccountReference","kind":"json-schema","title":"PaymentAccountReference","data":{"type":"string","maxLength":35,"example":"05280D8G7Q04UZBI7NOSPGSURP130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payment Account Reference (PAR) is a value assigned by the BIN Controller, which is defined as either an issuer or card brand. This field is associated directly with the cardholder's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value enables merchants, acquirers, and payment processors to link a payment token to a cardholder’s underlying payment account."},"children":[]}]}]}]}},"components/schemas/LighthouseResponse":{"id":"components/schemas/LighthouseResponse","kind":"json-schema","title":"LighthouseResponse","data":{"type":"object","readOnly":true,"properties":{"data":{"$ref":"#/components/schemas/LighthouseDataResponse"}}}},"components/schemas/AmountCaptureRequest":{"id":"components/schemas/AmountCaptureRequest","kind":"json-schema","title":"AmountCaptureRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with a $20 tip and $8 tax would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"128.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"required":["total"],"properties":{"cashback":{"$ref":"#/components/schemas/AmountCashback"},"iiasAmounts":{"$ref":"#/components/schemas/IIASAmountsArray"},"surcharge":{"$ref":"#/components/schemas/AmountSurcharge"},"tax":{"$ref":"#/components/schemas/AmountTax"},"taxIndicator":{"$ref":"#/components/schemas/AmountTaxIndicator"},"tip":{"$ref":"#/components/schemas/AmountTip"},"total":{"type":"number","maxLength":14,"example":160,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during a /transactions/capture request will result in the transaction being voided."},"children":[]}]}]}]}]},"checkTotal":{"$ref":"#/components/schemas/AmountCheckTotal"}}}},"components/schemas/AutoDistanceDriven":{"id":"components/schemas/AutoDistanceDriven","kind":"json-schema","title":"AutoDistanceDriven","data":{"type":"integer","maxLength":5,"example":167,"description":"The amount of distance the cardholder drove the vehicle.\n"}},"components/schemas/AutoDistanceUnit":{"id":"components/schemas/AutoDistanceUnit","kind":"json-schema","title":"AutoDistanceUnit","data":{"type":"string","minLength":1,"maxLength":1,"enum":["M","K"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure that corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"distanceDriven"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miles"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"K"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kilometers"},"children":[]}]}]}]}]}]}]}},"components/schemas/AutoLateAdjustment":{"id":"components/schemas/AutoLateAdjustment","kind":"json-schema","title":"AutoLateAdjustment","data":{"type":"number","maxLength":14,"example":35,"description":"A dollar amount for late adjustment fees for an auto rental, including refueling charges, a surcharge, or charges for damage incurred during use.\n"}},"components/schemas/AutoNoShowIndicator":{"id":"components/schemas/AutoNoShowIndicator","kind":"json-schema","title":"AutoNoShowIndicator","data":{"type":"string","minLength":1,"maxLength":1,"example":"N","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not the cardholder picked up a reserved rental car."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer did not pick up the rental car"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer did pick up the rental car"},"children":[]}]}]}]}]}]}]}},"components/schemas/AutoAdditionalChargesGasoline":{"id":"components/schemas/AutoAdditionalChargesGasoline","kind":"json-schema","title":"AutoAdditionalChargesGasoline","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/AutoAdditionalChargesLateReturn":{"id":"components/schemas/AutoAdditionalChargesLateReturn","kind":"json-schema","title":"AutoAdditionalChargesLateReturn","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/AutoAdditionalChargesMileage":{"id":"components/schemas/AutoAdditionalChargesMileage","kind":"json-schema","title":"AutoAdditionalChargesMileage","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/AutoAdditionalChargesOneWayServiceFee":{"id":"components/schemas/AutoAdditionalChargesOneWayServiceFee","kind":"json-schema","title":"AutoAdditionalChargesOneWayServiceFee","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/AutoAdditionalChargesViolationFee":{"id":"components/schemas/AutoAdditionalChargesViolationFee","kind":"json-schema","title":"AutoAdditionalChargesViolationFee","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/AutoAdditionalCharges":{"id":"components/schemas/AutoAdditionalCharges","kind":"json-schema","title":"AutoAdditionalCharges","data":{"type":"object","description":"The codes used to provide a reason for additional charges in an auto rental sale. Multiple codes can be specified for the same transaction.\n","properties":{"gasoline":{"$ref":"#/components/schemas/AutoAdditionalChargesGasoline"},"lateReturn":{"$ref":"#/components/schemas/AutoAdditionalChargesLateReturn"},"mileage":{"$ref":"#/components/schemas/AutoAdditionalChargesMileage"},"oneWayServiceFee":{"$ref":"#/components/schemas/AutoAdditionalChargesOneWayServiceFee"},"violationFee":{"$ref":"#/components/schemas/AutoAdditionalChargesViolationFee"}}}},"components/schemas/AutoDriverLicense":{"id":"components/schemas/AutoDriverLicense","kind":"json-schema","title":"AutoDriverLicense","data":{"type":"string","maxLength":20,"example":"1889624485","description":"The cardholder's driver's license number.\n"}},"components/schemas/AutoDriverName":{"id":"components/schemas/AutoDriverName","kind":"json-schema","title":"AutoDriverName","data":{"type":"string","maxLength":35,"example":"John Smith","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a sale/authorization request for an auto rental, the customer’s name exactly as it appears on their driver’s license."},"children":[]}]}]}]}},"components/schemas/AutoDriverTaxNumber":{"id":"components/schemas/AutoDriverTaxNumber","kind":"json-schema","title":"AutoDriverTaxNumber","data":{"type":"string","maxLength":20,"example":"192012838","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the driver’s Tax Identification Number."},"children":[]}]}]}]}},"components/schemas/AutoDriver":{"id":"components/schemas/AutoDriver","kind":"json-schema","title":"AutoDriver","data":{"type":"object","properties":{"license":{"$ref":"#/components/schemas/AutoDriverLicense"},"name":{"$ref":"#/components/schemas/AutoDriverName"},"taxNumber":{"$ref":"#/components/schemas/AutoDriverTaxNumber"}}}},"components/schemas/AutoRentalAgreement":{"id":"components/schemas/AutoRentalAgreement","kind":"json-schema","title":"AutoRentalAgreement","data":{"type":"string","maxLength":9,"example":"123203592","description":"Contract number for an auto rental agreement.\n"}},"components/schemas/AutoRentalCity":{"id":"components/schemas/AutoRentalCity","kind":"json-schema","title":"AutoRentalCity","data":{"type":"string","maxLength":18,"example":"Las Vegas","description":"City where rental car was picked up.\n"}},"components/schemas/AutoRentalCountryCode":{"id":"components/schemas/AutoRentalCountryCode","kind":"json-schema","title":"AutoRentalCountryCode","data":{"type":"string","maxLength":3,"example":"840","description":"Country where rental card was picked up.\n"}},"components/schemas/AutoRentalPostalCode":{"id":"components/schemas/AutoRentalPostalCode","kind":"json-schema","title":"AutoRentalPostalCode","data":{"type":"string","maxLength":9,"example":"83145","description":"Postal Code where rental car was picked up in U.S. postal abbreviation format.\n"}},"components/schemas/AutoRentalRegion":{"id":"components/schemas/AutoRentalRegion","kind":"json-schema","title":"AutoRentalRegion","data":{"type":"string","maxLength":2,"example":"NV","description":"Region (State) where rental car was picked up in U.S. postal abbreviation format.\n"}},"components/schemas/AutoRental":{"id":"components/schemas/AutoRental","kind":"json-schema","title":"AutoRental","data":{"type":"object","description":"Information relating to where the rental card was picked up.\n","properties":{"agreement":{"$ref":"#/components/schemas/AutoRentalAgreement"},"city":{"$ref":"#/components/schemas/AutoRentalCity"},"countryCode":{"$ref":"#/components/schemas/AutoRentalCountryCode"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"postalCode":{"$ref":"#/components/schemas/AutoRentalPostalCode"},"region":{"$ref":"#/components/schemas/AutoRentalRegion"}}}},"components/schemas/AutoReturnCity":{"id":"components/schemas/AutoReturnCity","kind":"json-schema","title":"AutoReturnCity","data":{"type":"string","maxLength":18,"example":"Las Vegas","description":"City where rental car was returned.\n"}},"components/schemas/AutoReturnCountryCode":{"id":"components/schemas/AutoReturnCountryCode","kind":"json-schema","title":"AutoReturnCountryCode","data":{"type":"string","maxLength":3,"example":"840","description":"Country where rental card was returned.\n"}},"components/schemas/AutoReturnPostalCode":{"id":"components/schemas/AutoReturnPostalCode","kind":"json-schema","title":"AutoReturnPostalCode","data":{"type":"string","maxLength":9,"example":"17721","description":"Postal Code where rental car was returned in U.S. postal abbreviation format.\n"}},"components/schemas/AutoReturnRegion":{"id":"components/schemas/AutoReturnRegion","kind":"json-schema","title":"AutoReturnRegion","data":{"type":"string","maxLength":2,"example":"NV","description":"Region (State) where rental car was returned in U.S. postal abbreviation format.\n"}},"components/schemas/AutoReturn":{"id":"components/schemas/AutoReturn","kind":"json-schema","title":"AutoReturn","data":{"type":"object","description":"Information relating to where the rental car was returned\n","properties":{"city":{"$ref":"#/components/schemas/AutoReturnCity"},"countryCode":{"$ref":"#/components/schemas/AutoReturnCountryCode"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"postalCode":{"$ref":"#/components/schemas/AutoReturnPostalCode"},"region":{"$ref":"#/components/schemas/AutoReturnRegion"}}}},"components/schemas/AutoCheckOut":{"id":"components/schemas/AutoCheckOut","kind":"json-schema","title":"AutoCheckOut","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Auto Rental transactions"},"children":[]}]}]}]}],"properties":{"distanceDriven":{"$ref":"#/components/schemas/AutoDistanceDriven"},"distanceUnit":{"$ref":"#/components/schemas/AutoDistanceUnit"},"lateAdjustment":{"$ref":"#/components/schemas/AutoLateAdjustment"},"noShowIndicator":{"$ref":"#/components/schemas/AutoNoShowIndicator"},"additionalCharges":{"$ref":"#/components/schemas/AutoAdditionalCharges"},"driver":{"$ref":"#/components/schemas/AutoDriver"},"rental":{"$ref":"#/components/schemas/AutoRental"},"return":{"$ref":"#/components/schemas/AutoReturn"}}}},"components/schemas/CardOnFileTypeCapture":{"id":"components/schemas/CardOnFileTypeCapture","kind":"json-schema","title":"CardOnFileTypeCapture","data":{"type":"string","enum":["U08"],"example":"U08","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the type of the card-on-file transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a transaction as an Incremental COF transaction. For example, a hotel which authorized a customer’s card for one night at check-in might increase the authorization amount to cover two nights when the customer decides to extend their stay. Shift4 automatically detects this scenario and sends the appropriate value to the processor."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/card-on-file-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card On File Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for additional details."},"children":[]}]}]}]}},"components/schemas/HotelArrivalDateTime":{"id":"components/schemas/HotelArrivalDateTime","kind":"json-schema","title":"HotelArrivalDateTime","data":{"type":"string","example":"2021-04-12T15:39:01.594-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arrival date and time of a guest’s hotel stay ISO8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). For hotel transactions that are a straight sale (such as advanced deposit, no-show charge, and late charges), the arrival date needs to be one day before the sale date."},"children":[]}]}]}]}},"components/schemas/HotelDepartureDateTime":{"id":"components/schemas/HotelDepartureDateTime","kind":"json-schema","title":"HotelDepartureDateTime","data":{"type":"string","example":"2021-04-15T09:18:23.283-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Departure date and time of a guest’s hotel stay ISO8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). For hotel transactions that are a straight sale (such as advanced deposit, no-show charge, and late charges), the departure date needs to be the day of the sale."},"children":[]}]}]}]}},"components/schemas/HotelPrimaryChargeType":{"id":"components/schemas/HotelPrimaryChargeType","kind":"json-schema","title":"HotelPrimaryChargeType","data":{"type":"integer","minLength":1,"maxLength":1,"example":1,"enum":[1,2,3],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest’s transaction type at a hotel."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lodging"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restaurant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Shop"},"children":[]}]}]}]}]}]}]}},"components/schemas/HotelSpecialCode":{"id":"components/schemas/HotelSpecialCode","kind":"json-schema","title":"HotelSpecialCode","data":{"type":"integer","minLength":1,"maxLength":1,"example":1,"enum":[1,2,3,4,5,6],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to provide additional detail for lodging transactions. If a lodging charge does not match one of the listed descriptions, the default value of ‘1’ should be sent in the request. When a value of ‘4’ is sent, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field needs to be sent as well."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Special Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assured Reservation/No Show"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advance Deposit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delayed Charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Express Check-Out Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assured Reservation/Normal"},"children":[]}]}]}]}]}]}]}},"components/schemas/HotelAdditionalChargesGiftShop":{"id":"components/schemas/HotelAdditionalChargesGiftShop","kind":"json-schema","title":"HotelAdditionalChargesGiftShop","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalChargesLaundry":{"id":"components/schemas/HotelAdditionalChargesLaundry","kind":"json-schema","title":"HotelAdditionalChargesLaundry","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalChargesMiniBar":{"id":"components/schemas/HotelAdditionalChargesMiniBar","kind":"json-schema","title":"HotelAdditionalChargesMiniBar","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalChargesOther":{"id":"components/schemas/HotelAdditionalChargesOther","kind":"json-schema","title":"HotelAdditionalChargesOther","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalChargesRestaurant":{"id":"components/schemas/HotelAdditionalChargesRestaurant","kind":"json-schema","title":"HotelAdditionalChargesRestaurant","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalChargesTelephone":{"id":"components/schemas/HotelAdditionalChargesTelephone","kind":"json-schema","title":"HotelAdditionalChargesTelephone","data":{"type":"string","minLength":1,"maxLength":1,"example":"Y","enum":["Y","N"]}},"components/schemas/HotelAdditionalCharges":{"id":"components/schemas/HotelAdditionalCharges","kind":"json-schema","title":"HotelAdditionalCharges","data":{"type":"object","description":"Reason codes for additional charges in a lodging sale request at the time a consumer checks out.\n","properties":{"giftShop":{"$ref":"#/components/schemas/HotelAdditionalChargesGiftShop"},"laundry":{"$ref":"#/components/schemas/HotelAdditionalChargesLaundry"},"miniBar":{"$ref":"#/components/schemas/HotelAdditionalChargesMiniBar"},"other":{"$ref":"#/components/schemas/HotelAdditionalChargesOther"},"restaurant":{"$ref":"#/components/schemas/HotelAdditionalChargesRestaurant"},"telephone":{"$ref":"#/components/schemas/HotelAdditionalChargesTelephone"}}}},"components/schemas/HotelRoomRatesNights":{"id":"components/schemas/HotelRoomRatesNights","kind":"json-schema","title":"HotelRoomRatesNights","data":{"type":"integer","maxLength":2,"example":2,"description":"The number of nights being charged at this rate.\n"}},"components/schemas/HotelRoomRatesRate":{"id":"components/schemas/HotelRoomRatesRate","kind":"json-schema","title":"HotelRoomRatesRate","data":{"type":"number","maxLength":14,"example":159.95,"description":"The per night room rate.\n"}},"components/schemas/HotelRoomRates":{"id":"components/schemas/HotelRoomRates","kind":"json-schema","title":"HotelRoomRates","data":{"type":"object","properties":{"nights":{"$ref":"#/components/schemas/HotelRoomRatesNights"},"rate":{"$ref":"#/components/schemas/HotelRoomRatesRate"}}}},"components/schemas/HotelRoomRatesArray":{"id":"components/schemas/HotelRoomRatesArray","kind":"json-schema","title":"HotelRoomRatesArray","data":{"type":"array","items":{"$ref":"#/components/schemas/HotelRoomRates"},"example":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"description":"Room rates broken down by rate and number of nights.\n"}},"components/schemas/HotelCheckOut":{"id":"components/schemas/HotelCheckOut","kind":"json-schema","title":"HotelCheckOut","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Hotel transactions"},"children":[]}]}]}]}],"properties":{"arrivalDateTime":{"$ref":"#/components/schemas/HotelArrivalDateTime"},"departureDateTime":{"$ref":"#/components/schemas/HotelDepartureDateTime"},"primaryChargeType":{"$ref":"#/components/schemas/HotelPrimaryChargeType"},"specialCode":{"$ref":"#/components/schemas/HotelSpecialCode"},"additionalCharges":{"$ref":"#/components/schemas/HotelAdditionalCharges"},"roomRates":{"$ref":"#/components/schemas/HotelRoomRatesArray"}}}},"components/schemas/transactions_capture_token_gtv":{"id":"components/schemas/transactions_capture_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","required":["dateTime","amount","card","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"amount":{"$ref":"#/components/schemas/AmountCaptureRequest"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"clerk":{"$ref":"#/components/schemas/Clerk"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send this object only if the capture amount exceeds the authorized amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/card-on-file-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card On File Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/CardOnFileTypeCapture"},"transactionId":{"$ref":"#/components/schemas/CardOnFileTransactionId"},"transactionLinkId":{"$ref":"#/components/schemas/CardOnFileTransactionLinkId"}}},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"N","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"N"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_capture_token_legacy":{"id":"components/schemas/transactions_capture_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","required":["dateTime","amount","card","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"amount":{"$ref":"#/components/schemas/AmountCaptureRequest"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"clerk":{"$ref":"#/components/schemas/Clerk"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send this object only if the capture amount exceeds the authorized amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/card-on-file-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card On File Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/CardOnFileTypeCapture"},"transactionId":{"$ref":"#/components/schemas/CardOnFileTransactionId"},"transactionLinkId":{"$ref":"#/components/schemas/CardOnFileTransactionLinkId"}}},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"N","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"N"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/CardToken":{"id":"components/schemas/CardToken","kind":"json-schema","title":"CardToken","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send this object when using a card on file."},"children":[]}]}]}]}],"properties":{"value":{"$ref":"#/components/schemas/CardTokenValue"}}}},"components/schemas/AmountTipBasis":{"id":"components/schemas/AmountTipBasis","kind":"json-schema","title":"AmountTipBasis","data":{"type":"number","maxLength":14,"example":130,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount Commerce Engine will use to calclulate the tip percentage amounts on the tip screen. This is an optional field that will be used instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a scenario where the percentage calculations must be made on an amount other than the total amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, you have a $130 check and you make an initial payment of $30 using a gift card leaving a $100 remaining balance. When you process the remaining balance and you want to calculate the tip percentages based on the original $130 check total you would send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.tipBaiss = 130"},"children":[]}]}]}]}},"components/schemas/AmountObjectCommerceEngineSale":{"id":"components/schemas/AmountObjectCommerceEngineSale","kind":"json-schema","title":"AmountObjectCommerceEngineSale","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with a $20 tip and $8 tax would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"128.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount  fields can specify up to three decimal places. However, the number of decimal  places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total","tax"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"taxIndicator":{"$ref":"#/components/schemas/AmountTaxIndicator"},"cashback":{"$ref":"#/components/schemas/AmountCashback"},"iiasAmounts":{"$ref":"#/components/schemas/IIASAmountsArray"},"tip":{"$ref":"#/components/schemas/AmountTip"},"tipBasis":{"$ref":"#/components/schemas/AmountTipBasis"},"checkTotal":{"$ref":"#/components/schemas/AmountCheckTotal"}}}},"components/schemas/transactions_sale_comengdevice":{"id":"components/schemas/transactions_sale_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectCommerceEngineSale"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_sale_comengcloud":{"id":"components/schemas/transactions_sale_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectCommerceEngineSale"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_sale_utgdevice":{"id":"components/schemas/transactions_sale_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"terminalId":"1742"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/LighthouseDataRequest":{"id":"components/schemas/LighthouseDataRequest","kind":"json-schema","title":"LighthouseDataRequest","data":{"type":"string","example":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ==","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send only when processing SkyTab transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded JSON formatted data that will be passed through to Lighthouse for SkyTab transactions. This data will contain variable information."},"children":[]}]}]}]}},"components/schemas/LighthouseRequest":{"id":"components/schemas/LighthouseRequest","kind":"json-schema","title":"LighthouseRequest","data":{"type":"object","writeOnly":true,"properties":{"data":{"$ref":"#/components/schemas/LighthouseDataRequest"}}}},"components/schemas/transactions_sale_token_gtv":{"id":"components/schemas/transactions_sale_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_token_legacy":{"id":"components/schemas/transactions_sale_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_p2pe_idtech":{"id":"components/schemas/transactions_sale_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","apiOptions":["ALLOWPARTIALAUTH"],"amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"present":"Y"},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_p2pe_tdesdukpt_emv":{"id":"components/schemas/transactions_sale_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMV"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_p2pe_tdesdukpt_msr":{"id":"components/schemas/transactions_sale_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_p2pe_onguardsde_emv":{"id":"components/schemas/transactions_sale_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_p2pe_onguardsde_msr":{"id":"components/schemas/transactions_sale_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_unencryptedcard":{"id":"components/schemas/transactions_sale_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","clerk","transaction","card","customer"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"},"exemptionAction":{"$ref":"#/components/schemas/TransactionExemptionAction"},"exemptionReason":{"$ref":"#/components/schemas/TransactionExemptionReason"}}},"card":{"type":"object","required":["entryMode","number","expirationDate","securityCode"],"properties":{"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"type":"object","required":["postalCode"],"properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"lighthouse":{"$ref":"#/components/schemas/LighthouseRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N","securityCode":{"indicator":"1","value":"333"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"lighthouse":{"data":"eyJsaWdodGhvdXNlIjp7ImVtcGxveWVlaWQiOjEyMzQsImRldmljZWlkIjoiMTIzU0FCViJ9fQ=="},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_3dsecurei4Go":{"id":"components/schemas/transactions_sale_3dsecurei4Go","kind":"json-schema","title":"Wallet/3D Secure Using i4Go","data":{"title":"Wallet/3D Secure Using i4Go","type":"object","required":["dateTime","amount","clerk","transaction","card","extendedCardData"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"extendedCardData":{"$ref":"#/components/schemas/ExtendedCardData"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"extendedCardData":"eyJjYXJkQnJhbmRUb2tlbiI6eyJyZXF1ZXN0b3JJZCI6IjA0MDAxMDAzMDI3MyJ9LCJ0aHJlZURTZWN1cmUiOnsicHJvZ3JhbVByb3RvY29sIjoxLCJlY29tbUluZGljYXRvciI6NywieGlkIjoiRkU4OTRBN0NDNzI3NDVCRTIyRThBRkMzNjE2OUM2NUI5QkIwMjIxM0NGMTFBNDAzMTI0MjBDNUQ0MDU0RDY5QyIsImNyeXB0b2dyYW0iOiJCRC91UWZVQU9mMythTVVDbHV0eE1BQUNBQUE9Iiwic2VjdXJpdHlMZXZlbEluZGljYXRvciI6MjQxLCJhdXRoZW50aWNhdGlvblNvdXJjZSI6MSwid2FsbGV0SUQiOjEwM319","transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_3dsecurecardnumber":{"id":"components/schemas/transactions_sale_3dsecurecardnumber","kind":"json-schema","title":"3D Secure Using Card Number","data":{"title":"3D Secure Using Card Number","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_3dsecuretoken_gtv":{"id":"components/schemas/transactions_sale_3dsecuretoken_gtv","kind":"json-schema","title":"3D Secure Using GTV Token","data":{"title":"3D Secure Using GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_3dsecuretoken_legacy":{"id":"components/schemas/transactions_sale_3dsecuretoken_legacy","kind":"json-schema","title":"3D Secure Using Legacy TrueToken","data":{"title":"3D Secure Using Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecure"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","authenticationSource":"2","cavvResult":"2","authenticationValue":"Y2FyZGluYWxjb21tZXJjZWF1dGg=","tavvResult":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","walletID":"327"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_applepay":{"id":"components/schemas/transactions_sale_applepay","kind":"json-schema","title":"Apple Pay","data":{"title":"Apple Pay","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure","cardBrandToken"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecureWallet"},"cardBrandToken":{"type":"object","properties":{"requestorId":{"$ref":"#/components/schemas/CardBrandTokenRequestorID"}}},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"authenticationSource":"1","cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","walletID":"103"},"cardBrandToken":{"requestorId":"012345678901"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_sale_googlepay":{"id":"components/schemas/transactions_sale_googlepay","kind":"json-schema","title":"Google Pay","data":{"title":"Google Pay","type":"object","required":["dateTime","amount","clerk","transaction","card","threeDSecure"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"threeDSecure":{"$ref":"#/components/schemas/ThreeDSecureWallet"},"customer":{"$ref":"#/components/schemas/Customer"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"clerk":{"numericId":1576},"transaction":{"invoice":"192029","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"threeDSecure":{"authenticationSource":"1","cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","ecommIndicator":"5","securityLevelIndicator":"241","xid":"hq0BA9EAAAGXIJcAGAAAABKU0+s=","programProtocol":"2","walletID":"216"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/TaxFree":{"id":"components/schemas/TaxFree","kind":"json-schema","title":"TaxFree","data":{"type":"object","description":"Returned when the merchant is configured for tax-free processing. Contains card and transaction details for use with Global Blue's tax-free shopping APIs.\n","properties":{"maskedPAN":{"type":"string","example":"476173******0043","description":"The masked pan containing the first 6 and last 4 digits.\n"},"cardCountry":{"type":"string","example":"124","description":"Card issuing country in ISO 3166-1 (3 numeric digits) format\n"},"cardBrand":{"type":"string","enum":["VISA","MASTER","DINERS","JCB","AMEX","CUP"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card brand"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decription"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VISA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Credit/Debit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MASTER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard Credit/Debit and Maestro"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DINERS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover/Diners"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AMEX"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"American Express"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unionpay Credit/Debit"},"children":[]}]}]}]}]}]}]},"cardType":{"type":"string","enum":["CreditCard","DebitCard","Prepaid"],"description":"Card type\n"},"expiryMonth":{"type":"string","example":"12","description":"Expiration month\n"},"expiryYear":{"type":"string","example":"31","description":"Expiration year\n"},"cardholderName":{"type":"string","example":"TaxFree Shopper","description":"Cardholder name\n"},"pspReferenceNumber":{"type":"string","example":"112215bf-93a3-4856-b1ca-23d175dd2fa9","description":"Shift4 transaction reference number shared with Global Blue.\n"}}}},"components/schemas/AmountRefund":{"id":"components/schemas/AmountRefund","kind":"json-schema","title":"AmountRefund","data":{"type":"object","required":["tax","total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"}}}},"components/schemas/TransactionOriginalInvoice":{"id":"components/schemas/TransactionOriginalInvoice","kind":"json-schema","title":"TransactionOriginalInvoice","data":{"type":"string","maxLength":10,"example":"192029","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice number from the original sale. Used to link the refund to the original sale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For US and Canadian processing: Although the invoice number is sent as a JSON string it is a numeric value. No alpha characters are allowed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For processing outside of the US and Canada alpha characters are allowed."},"children":[]}]}]}]}]}},"components/schemas/AirlineCreditReasonIndicator":{"id":"components/schemas/AirlineCreditReasonIndicator","kind":"json-schema","title":"AirlineCreditReasonIndicator","data":{"type":"string","maxLength":1,"enum":["A","B","C","O","P"],"example":"P","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the reason for a credit to the cardholder. This field should contain spaces or one of the below codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passenger transport ancillary purchase cancellation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Airline ticket and passenger transport ancillary purchase cancellation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Airline ticket cancellation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial refund of airline ticket"},"children":[]}]}]}]}]}]}]}},"components/schemas/AirlineRequestRefund":{"id":"components/schemas/AirlineRequestRefund","kind":"json-schema","title":"AirlineRequestRefund","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Airline transactions"},"children":[]}]}]}]}],"required":["carrierCode","carrierName","creditReasonIndicator","conjunctionTicketIndicator","documentType","electronicTicketIndicator","internetIndicator","issueDate","numberOfCities","numberOfCarriers","numberOfPassengers","passengerArrivalDate","passengerDepartureDate","passengerNameRecord","restrictedTicketIndicator","ticketChangeIndicator","ticketTranType","tickets","flightLegs","typeIndicator"],"properties":{"carrierCode":{"$ref":"#/components/schemas/AirlineCarrierCode"},"carrierName":{"$ref":"#/components/schemas/AirlineCarrierName"},"conjunctionTicketIndicator":{"$ref":"#/components/schemas/AirlineConjunctionTicketIndicator"},"creditReasonIndicator":{"$ref":"#/components/schemas/AirlineCreditReasonIndicator"},"documentType":{"$ref":"#/components/schemas/AirlineDocumentType"},"electronicTicketIndicator":{"$ref":"#/components/schemas/AirlineElectronicTicketIndicator"},"internetIndicator":{"$ref":"#/components/schemas/AirlineInternetIndicator"},"issueDate":{"$ref":"#/components/schemas/AirlineIssueDate"},"numberOfCities":{"$ref":"#/components/schemas/AirlineNumberOfCities"},"numberOfCarriers":{"$ref":"#/components/schemas/AirlineNumberOfCarriers"},"numberOfPassengers":{"$ref":"#/components/schemas/AirlineNumberOfPassengers"},"passengerArrivalDate":{"$ref":"#/components/schemas/AirlinePassengerArrivalDate"},"passengerDepartureDate":{"$ref":"#/components/schemas/AirlinePassengerDepartureDate"},"passengerNameRecord":{"$ref":"#/components/schemas/AirlinePassengerNameRecord"},"restrictedTicketIndicator":{"$ref":"#/components/schemas/AirlineRestrictedTicketIndicator"},"ticketChangeIndicator":{"$ref":"#/components/schemas/AirlineTicketChangeIndicator"},"ticketTranType":{"$ref":"#/components/schemas/AirlineTicketTranType"},"typeIndicator":{"$ref":"#/components/schemas/AirlineTypeIndicator"},"tickets":{"$ref":"#/components/schemas/AirlineTicketsArray"},"flightLegs":{"$ref":"#/components/schemas/AirlineFlightLegsArray"},"ancillaryServices":{"$ref":"#/components/schemas/AirlineAncillaryServicesArray"},"travelAgencyCode":{"$ref":"#/components/schemas/AirlineTravelAgencyCode"},"travelAgencyName":{"$ref":"#/components/schemas/AirlineTravelAgencyName"},"exchangeTicketNumber":{"$ref":"#/components/schemas/AirlineExchangeTicketNumber"}}}},"components/schemas/HotelCheckOutRefund":{"id":"components/schemas/HotelCheckOutRefund","kind":"json-schema","title":"HotelCheckOutRefund","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Hotel transactions"},"children":[]}]}]}]}],"properties":{"arrivalDateTime":{"$ref":"#/components/schemas/HotelArrivalDateTime"},"departureDateTime":{"$ref":"#/components/schemas/HotelDepartureDateTime"}}}},"components/schemas/PurchaseCardRefund":{"id":"components/schemas/PurchaseCardRefund","kind":"json-schema","title":"PurchaseCardRefund","data":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"},"destinationPostalCode":{"$ref":"#/components/schemas/PurchaseCardDestinationPostalCode"},"productDescriptors":{"$ref":"#/components/schemas/PurchaseCardProductDescriptors"}}}},"components/schemas/CardPresentRefund":{"id":"components/schemas/CardPresentRefund","kind":"json-schema","title":"CardPresentRefund","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a card was present (‘Y’) or not (‘N’) at the time the refund transaction took place."},"children":[]}]}]}]}},"components/schemas/transactions_refund_comengdevice":{"id":"components/schemas/transactions_refund_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"present":"Y"},"clerk":{"numericId":1576},"transaction":{"invoice":"192050","originalInvoice":"182177","notes":"Transaction notes are added here"}}}},"components/schemas/transactions_refund_comengcloud":{"id":"components/schemas/transactions_refund_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","clerk","transaction","card","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192050","originalInvoice":"182177","notes":"Transaction notes are added here"}}}},"components/schemas/transactions_refund_utgdevice":{"id":"components/schemas/transactions_refund_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","clerk","transaction","card","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"terminalId":"1742"},"transaction":{"invoice":"192050","originalInvoice":"182177","notes":"Transaction notes are added here"}}}},"components/schemas/transactions_refund_token_gtv":{"id":"components/schemas/transactions_refund_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192050","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_token_legacy":{"id":"components/schemas/transactions_refund_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"invoice":"192050","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_p2pe_idtech":{"id":"components/schemas/transactions_refund_p2pe_idtech","kind":"json-schema","title":"P2PE - IDTECH - EMV/MSR/Manual","data":{"title":"P2PE - IDTECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","card","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"present":"Y"},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_p2pe_tdesdukpt_emv":{"id":"components/schemas/transactions_refund_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","clerk","transaction","card","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMV"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_p2pe_tdesdukpt_msr":{"id":"components/schemas/transactions_refund_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_p2pe_onguardsde_emv":{"id":"components/schemas/transactions_refund_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","clerk","transaction","card","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_p2pe_onguardsde_msr":{"id":"components/schemas/transactions_refund_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["present"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"type":{"$ref":"#/components/schemas/CardType"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMVFallbackOnly"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_refund_unencryptedcard":{"id":"components/schemas/transactions_refund_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountRefund"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequestRefund"},"hotel":{"$ref":"#/components/schemas/HotelCheckOutRefund"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardRefund"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"source":{"$ref":"#/components/schemas/TransactionSource"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}},"card":{"type":"object","required":["number","expirationDate","present"],"properties":{"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: The Card Entry Mode should be sent in an initial request; in subsequent requests, it should be left blank or not sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"present":{"$ref":"#/components/schemas/CardPresentRefund"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"}}},"customer":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":10.05,"total":121.83},"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N","type":"VS"},"clerk":{"numericId":1576},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"},"transaction":{"invoice":"192029","originalInvoice":"182177","notes":"Transaction notes are added here"},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/CardResponse":{"id":"components/schemas/CardResponse","kind":"json-schema","title":"CardResponse","data":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"levelResult":{"$ref":"#/components/schemas/CardLevelResult"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeResponse"},"token":{"$ref":"#/components/schemas/CardTokenResponse"},"debitType":{"$ref":"#/components/schemas/CardDebitType"}}}},"components/schemas/CardResponseVoid":{"id":"components/schemas/CardResponseVoid","kind":"json-schema","title":"CardResponseVoid","data":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}}},"components/schemas/TransactionManualTranId":{"id":"components/schemas/TransactionManualTranId","kind":"json-schema","title":"TransactionManualTranId","data":{"type":"string","maxLength":15,"example":"123456789012345","description":"This is typically used in a Referral. If a ManualTranID is returned by the issuer with the Auth code, it should be sent to the processor in the ManualTranid field.\n"}},"components/schemas/transactions_manualauthorization_comengdevice":{"id":"components/schemas/transactions_manualauthorization_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualauthorization_comengcloud":{"id":"components/schemas/transactions_manualauthorization_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualauthorization_utgdevice":{"id":"components/schemas/transactions_manualauthorization_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"terminalId":"1742"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualauthorization_token_gtv":{"id":"components/schemas/transactions_manualauthorization_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_token_legacy":{"id":"components/schemas/transactions_manualauthorization_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_p2pe_idtech":{"id":"components/schemas/transactions_manualauthorization_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","apiOptions":["ALLOWPARTIALAUTH"],"amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"present":"Y"},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_emv":{"id":"components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMV"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_msr":{"id":"components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_p2pe_onguardsde_emv":{"id":"components/schemas/transactions_manualauthorization_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_p2pe_onguardsde_msr":{"id":"components/schemas/transactions_manualauthorization_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"estimatedDays":5},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualauthorization_unencryptedcard":{"id":"components/schemas/transactions_manualauthorization_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","clerk","transaction","card","customer"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckIn"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckIn"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["number","expirationDate","securityCode"],"properties":{"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: The Card Entry Mode should be sent in an initial request; in subsequent requests, it should be left blank or not sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"type":"object","required":["postalCode"],"properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N","securityCode":{"indicator":"1","value":"333"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"},"transaction":{"hotel":{"estimatedDays":5},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_comengdevice":{"id":"components/schemas/transactions_manualsale_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","clerk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualsale_comengcloud":{"id":"components/schemas/transactions_manualsale_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualsale_utgdevice":{"id":"components/schemas/transactions_manualsale_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","clerk","transaction","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"present":"Y"},"clerk":{"numericId":1576},"device":{"terminalId":"1742"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}}}}},"components/schemas/transactions_manualsale_token_gtv":{"id":"components/schemas/transactions_manualsale_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"8048471746471119"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_token_legacy":{"id":"components/schemas/transactions_manualsale_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","clerk","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"expirationDate":1225,"present":"N","token":{"value":"11191pn83hbkkety","serialNumber":"123456"}},"clerk":{"numericId":1576},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Cookie","Fries","Hamburger","Soda"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_p2pe_idtech":{"id":"components/schemas/transactions_manualsale_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","apiOptions":["ALLOWPARTIALAUTH"],"amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"present":"Y"},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_p2pe_tdesdukpt_emv":{"id":"components/schemas/transactions_manualsale_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMV"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_p2pe_tdesdukpt_msr":{"id":"components/schemas/transactions_manualsale_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_p2pe_onguardsde_emv":{"id":"components/schemas/transactions_manualsale_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","clerk","transaction","device","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"E","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_p2pe_onguardsde_msr":{"id":"components/schemas/transactions_manualsale_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","clerk","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"pin":{"$ref":"#/components/schemas/TransactionPin"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardType"}}},"customer":{"$ref":"#/components/schemas/Customer"},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"1","present":"Y"},"clerk":{"numericId":1576},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/transactions_manualsale_unencryptedcard":{"id":"components/schemas/transactions_manualsale_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","clerk","transaction","card","customer"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountObjectNoSurcharge"},"clerk":{"$ref":"#/components/schemas/Clerk"},"transaction":{"type":"object","required":["invoice","purchaseCard","authorizationCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"manualTranId":{"$ref":"#/components/schemas/TransactionManualTranId"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"auto":{"$ref":"#/components/schemas/AutoCheckOut"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCard"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["number","expirationDate","securityCode"],"properties":{"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: The Card Entry Mode should be sent in an initial request; in subsequent requests, it should be left blank or not sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"customer":{"type":"object","required":["postalCode"],"properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"}}},"receiptColumns":{"$ref":"#/components/schemas/ReceiptColumns"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"statementSuffix":{"$ref":"#/components/schemas/StatementSuffix"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"apiOptions":["ALLOWPARTIALAUTH"],"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N","securityCode":{"indicator":"1","value":"333"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"},"transaction":{"hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"invoice":"192029","authorizationCode":"189746","notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}]}}}},"components/schemas/tokens_add_comengdevice":{"id":"components/schemas/tokens_add_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime"],"properties":{"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2024-05-27T09:18:23.283-07:00"}}},"components/schemas/tokens_add_comengcloud":{"id":"components/schemas/tokens_add_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceCommerceEngineCloud"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2024-05-27T09:18:23.283-07:00","device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"}}}},"components/schemas/tokens_add_utgdevice":{"id":"components/schemas/tokens_add_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device"],"properties":{"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"terminalId":"1742"}}}},"components/schemas/tokens_add_p2pe_idtech":{"id":"components/schemas/tokens_add_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","p2pe":{"data":"027101801F2D1E00939B%*432100******1119^VS/DUAL TRACK^2212******?*;432100******1119=2212******?*CECE3FCE7781142BEC8D0E267AE89F5D3C7E235BF1A70E637951E8D93003E5A2586C336CA4A3B31F6639B04005BB12A716D8BC4D3AB125C27AB11A9DDC02816569D42A20B036EE5E2C71CB70565FB43B000000000000000000000000000000000000000000000000000000000000000000000000000000003434345434363138343962994950010038200415953903","format":"01"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/tokens_add_p2pe_tdesdukpt_emv":{"id":"components/schemas/tokens_add_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"$ref":"#/components/schemas/EMV"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/tokens_add_p2pe_tdesdukpt_msr":{"id":"components/schemas/tokens_add_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/tokens_add_p2pe_onguardsde_emv":{"id":"components/schemas/tokens_add_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"$ref":"#/components/schemas/EMVOnguardSDE"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/tokens_add_p2pe_onguardsde_msr":{"id":"components/schemas/tokens_add_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/CardEntryModeManual":{"id":"components/schemas/CardEntryModeManual","kind":"json-schema","title":"CardEntryModeManual","data":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PEDataAESMCE":{"id":"components/schemas/P2PEDataAESMCE","kind":"json-schema","title":"P2PEDataAESMCE","data":{"type":"string","maxLength":2048,"example":"86B43D77B12EA757544520C7678A05DD8B7E4770FE05F3320E9D856A7401ADEF","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual card entry information encrypted with AES 128. The decrypted information must be in the following format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pan=<PAN>|exp=<MMYY>|cvv=<CVV>"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pan"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit card number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date in MMYY format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cvv"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card security code (optional)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unencrypted data must be padded with \\x00 to be a muliple of 16 before encrypting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pan=4761730000000011|exp=1226\\x00\\x00\\x00"},"children":[]}]}]}]}},"components/schemas/P2PEFormatAES":{"id":"components/schemas/P2PEFormatAES","kind":"json-schema","title":"P2PEFormatAES","data":{"type":"string","minLength":2,"maxLength":2,"enum":["07"],"example":"07","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES-128 or AES-256"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PEKIDAES":{"id":"components/schemas/P2PEKIDAES","kind":"json-schema","title":"P2PEKIDAES","data":{"type":"string","example":"AESKEY1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key identifier for the key that was used to encrypt the P2PE data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The encryption key will be exchanged manually per customer."},"children":[]}]}]}]}]}},"components/schemas/P2PEType07AESMCE":{"id":"components/schemas/P2PEType07AESMCE","kind":"json-schema","title":"P2PEType07AESMCE","data":{"type":"object","required":["data","format","kid"],"properties":{"data":{"$ref":"#/components/schemas/P2PEDataAESMCE"},"format":{"$ref":"#/components/schemas/P2PEFormatAES"},"kid":{"$ref":"#/components/schemas/P2PEKIDAES"}}}},"components/schemas/tokens_add_p2pe_aes_mce":{"id":"components/schemas/tokens_add_p2pe_aes_mce","kind":"json-schema","title":"P2PE - AES - Manual","data":{"title":"P2PE - AES - Manual","type":"object","required":["dateTime","p2pe","card"],"properties":{"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryModeManual"}}},"dateTime":{"$ref":"#/components/schemas/DateTime"},"p2pe":{"$ref":"#/components/schemas/P2PEType07AESMCE"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"card":{"entryMode":"M"},"dateTime":"2024-01-31T09:18:23.283-07:00","p2pe":{"data":"86B43D77B12EA757544520C7678A05DD8B7E4770FE05F3320E9D856A7401ADEF","format":"07","kid":"AESKEY1"},"apiOptions":["RETURNEXPDATE"]}}},"components/schemas/tokens_add_unencryptedcard":{"id":"components/schemas/tokens_add_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"type":"object","properties":{"indicator":{"$ref":"#/components/schemas/CardSecurityCodeIndicator"},"value":{"$ref":"#/components/schemas/CardSecurityCodeValue"}}}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"customer":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"number":"4321000000001119","expirationDate":1230,"securityCode":{"indicator":"1","value":"333"}},"apiOptions":["RETURNEXPDATE"],"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"}}}},"components/schemas/ACHAccountNumber":{"id":"components/schemas/ACHAccountNumber","kind":"json-schema","title":"ACHAccountNumber","data":{"type":"string","maxLength":17,"example":"1234567890","description":"Bank Account Number. Do not include any dashes, spaces, or additional zeros.\n"}},"components/schemas/ACHRoutingNumber":{"id":"components/schemas/ACHRoutingNumber","kind":"json-schema","title":"ACHRoutingNumber","data":{"type":"string","maxLength":9,"minLength":9,"example":"121000248","description":"The routing number identifying the bank.\n"}},"components/schemas/ACHAccountType":{"id":"components/schemas/ACHAccountType","kind":"json-schema","title":"ACHAccountType","data":{"type":"string","example":"PC","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account type"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Checking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Savings"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corporate Checking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corporate Savings"},"children":[]}]}]}]}]}]}]}},"components/schemas/ACHAccountHolderName":{"id":"components/schemas/ACHAccountHolderName","kind":"json-schema","title":"ACHAccountHolderName","data":{"type":"string","maxLength":22,"example":"John Smith","description":"ACH account holder's name\n"}},"components/schemas/ACHAccountVerified":{"id":"components/schemas/ACHAccountVerified","kind":"json-schema","title":"ACHAccountVerified","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the ACH account was verified through a 3rd party."},"children":[]}]}]}]}},"components/schemas/ACHVerificationType":{"id":"components/schemas/ACHVerificationType","kind":"json-schema","title":"ACHVerificationType","data":{"type":"string","example":"P","enum":["P","M","B"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of verification used to validate the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prenotification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Micro Deposits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Login"},"children":[]}]}]}]}]}]}]}},"components/schemas/tokens_add_ach":{"id":"components/schemas/tokens_add_ach","kind":"json-schema","title":"ACH","data":{"title":"ACH","type":"object","required":["dateTime","ach"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"ach":{"type":"object","required":["accountNumber","routingNumber","accountType","accountHolderName","accountVerified","verificationType"],"properties":{"accountNumber":{"$ref":"#/components/schemas/ACHAccountNumber"},"routingNumber":{"$ref":"#/components/schemas/ACHRoutingNumber"},"accountType":{"$ref":"#/components/schemas/ACHAccountType"},"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"},"accountVerified":{"$ref":"#/components/schemas/ACHAccountVerified"},"verificationType":{"$ref":"#/components/schemas/ACHVerificationType"}}}},"example":{"dateTime":"2023-02-10T09:18:23.283-07:00","ach":{"accountNumber":"1234567890","routingNumber":"121000248","accountType":"PC","accountHolderName":"John Smith","accountVerified":true,"verificationType":"M"}}}},"components/schemas/tokens_add_response_card":{"id":"components/schemas/tokens_add_response_card","kind":"json-schema","title":"Card Data","data":{"title":"Card Data","type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}},"customer":{"$ref":"#/components/schemas/Customer"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}},"example":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"2","number":"XXXXXXXXXXX2221","token":{"value":"8038471748812221"},"type":"AX"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"U2API01CE"}}]}}},"components/schemas/TokenValueACH":{"id":"components/schemas/TokenValueACH","kind":"json-schema","title":"TokenValueACH","data":{"type":"string","maxLength":16,"example":"9829283019231234","description":"The token representing the customer's bank account credentials.\n"}},"components/schemas/TokenTypeACH":{"id":"components/schemas/TokenTypeACH","kind":"json-schema","title":"TokenTypeACH","data":{"type":"string","example":"ACH","readOnly":true,"enum":["ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of token. Value = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]}},"components/schemas/TokenACH":{"id":"components/schemas/TokenACH","kind":"json-schema","title":"TokenACH","data":{"type":"object","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/TokenValueACH"},"type":{"$ref":"#/components/schemas/TokenTypeACH"}}}},"components/schemas/tokens_add_response_ach":{"id":"components/schemas/tokens_add_response_ach","kind":"json-schema","title":"ACH","data":{"title":"ACH","type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"token":{"$ref":"#/components/schemas/TokenACH"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"server":{"name":"TM01CE"}}]}}},"components/schemas/CardFourWords":{"id":"components/schemas/CardFourWords","kind":"json-schema","title":"CardFourWords","data":{"type":"string","maxLength":28,"example":"cat blue washington enter","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Four words that reference cardholder data (CHD). The four words can be entered into Shift4’ 4Word® web app separated by spaces to temporarily reveal CHD. In addition, the four words can be entered during an Online Entry or Offline Entry transaction in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ltm.shift4test.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lighthouse Transaction Manager"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to securely charge the corresponding card number."},"children":[]}]}]}]}},"components/schemas/CardMaskedNumberGC":{"id":"components/schemas/CardMaskedNumberGC","kind":"json-schema","title":"CardMaskedNumberGC","data":{"type":"string","maxLength":32,"example":"XXXXXXXXXXXX8774","description":"The card number field will always be masked when returned in a response.\n"}},"components/schemas/CardResponseFourWords":{"id":"components/schemas/CardResponseFourWords","kind":"json-schema","title":"CardResponseFourWords","data":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"fourWords":{"$ref":"#/components/schemas/CardFourWords"},"number":{"$ref":"#/components/schemas/CardMaskedNumberGC"}}}},"components/schemas/MerchantAddressLine1":{"id":"components/schemas/MerchantAddressLine1","kind":"json-schema","title":"MerchantAddressLine1","data":{"type":"string","maxLength":38,"example":"456 Fake St","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First line in the merchant’s business address as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantAddressLine2":{"id":"components/schemas/MerchantAddressLine2","kind":"json-schema","title":"MerchantAddressLine2","data":{"type":"string","maxLength":38,"example":"Suite 100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second line in the merchant’s business address as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantCity":{"id":"components/schemas/MerchantCity","kind":"json-schema","title":"MerchantCity","data":{"type":"string","maxLength":13,"example":"Las Vegas","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City of the merchant’s business address as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantDayEndingTime":{"id":"components/schemas/MerchantDayEndingTime","kind":"json-schema","title":"MerchantDayEndingTime","data":{"type":"string","maxLength":6,"example":"010000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time the merchant’s business day ends as configured with Shift4."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This is only applicable for merchants based in the USA. If the merchant is not based in the USA, this field will not be returned."},"children":[]}]}]}]}]}},"components/schemas/MerchantDefaultCurrency":{"id":"components/schemas/MerchantDefaultCurrency","kind":"json-schema","title":"MerchantDefaultCurrency","data":{"type":"string","format":"ISO 4217 3 Character Alphabetic Code","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant's default currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}]}},"components/schemas/MerchantSupportedCurrencies":{"id":"components/schemas/MerchantSupportedCurrencies","kind":"json-schema","title":"MerchantSupportedCurrencies","data":{"type":"string","format":"ISO 4217 3 Character Alphabetic Code","example":"USD,EUR,GBP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of currnecies the merchant supports. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}]}},"components/schemas/MerchantIndustry":{"id":"components/schemas/MerchantIndustry","kind":"json-schema","title":"MerchantIndustry","data":{"type":"string","minLength":1,"maxLength":1,"enum":["A","F","H","M","R","P"],"example":"F","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the merchant type for a merchant’s account with Shift4."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto Rental"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Food & Beferage (F&B)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"H"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail order/Telephone Order (MOTO) or E-Commerce"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retail"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passenger Transport"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantRegion":{"id":"components/schemas/MerchantRegion","kind":"json-schema","title":"MerchantRegion","data":{"type":"string","maxLength":3,"example":"NV","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region (State) of the merchant’s business address as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantPhone":{"id":"components/schemas/MerchantPhone","kind":"json-schema","title":"MerchantPhone","data":{"type":"string","maxLength":15,"example":"702-123-4567","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant’s business telephone number as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantPostalCode":{"id":"components/schemas/MerchantPostalCode","kind":"json-schema","title":"MerchantPostalCode","data":{"type":"string","maxLength":9,"example":"78402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP/Postal Code of the merchant’s business address as configured with Shift4."},"children":[]}]}]}]}},"components/schemas/MerchantSerialNumber":{"id":"components/schemas/MerchantSerialNumber","kind":"json-schema","title":"MerchantSerialNumber","data":{"type":"string","maxLength":11,"example":"00000044444","description":"The serial number of the merchant's account with Shift4.\n"}},"components/schemas/MerchantCardTypesAccountNumber":{"id":"components/schemas/MerchantCardTypesAccountNumber","kind":"json-schema","title":"MerchantCardTypesAccountNumber","data":{"type":"string","maxLength":20,"example":"192019202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant’s account number as configured with Shift4. This field is returned in response to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/merchants/merchantsmerchant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant Information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request because the clerk is required to provide it when attempting to obtain a voice authorization code. This information must be displayed to the clerk."},"children":[]}]}]}]}},"components/schemas/MerchantCardTypesPhoneNumber":{"id":"components/schemas/MerchantCardTypesPhoneNumber","kind":"json-schema","title":"MerchantCardTypesPhoneNumber","data":{"type":"string","maxLength":20,"example":"1-800-444-5566","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number a clerk must call to obtain a voice authorization code. This field is returned in response to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/merchants/merchantsmerchant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant Information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request. This information must be displayed to the clerk."},"children":[]}]}]}]}},"components/schemas/VoiceCenter":{"id":"components/schemas/VoiceCenter","kind":"json-schema","title":"VoiceCenter","data":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/MerchantCardTypesAccountNumber"},"phoneNumber":{"$ref":"#/components/schemas/MerchantCardTypesPhoneNumber"}}}},"components/schemas/MerchantCardTypes":{"id":"components/schemas/MerchantCardTypes","kind":"json-schema","title":"MerchantCardTypes","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CardTypeResp"},"voiceCenter":{"$ref":"#/components/schemas/VoiceCenter"}}}},"components/schemas/MerchantCardTypesArray":{"id":"components/schemas/MerchantCardTypesArray","kind":"json-schema","title":"MerchantCardTypesArray","data":{"type":"array","items":{"$ref":"#/components/schemas/MerchantCardTypes"},"example":[{"type":"VS","voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}},{"type":"MC","voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}},{"type":"AX","voiceCenter":{"accountNumber":"65168416","phoneNumber":"1-800-123-1126"}},{"type":"NS","voiceCenter":{"accountNumber":"68406848684","phoneNumber":"1-888-320-1640"}},{"type":"YC","voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}}],"description":"Array of Merchant Card Types\n"}},"components/schemas/MerchantDCCEnabled":{"id":"components/schemas/MerchantDCCEnabled","kind":"json-schema","title":"MerchantDCCEnabled","data":{"type":"string","example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the merchant has dynamic currency conversion enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DCC is enabled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DCC is not enabled"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantDCCSecondaryLookupDisclaimer":{"id":"components/schemas/MerchantDCCSecondaryLookupDisclaimer","kind":"json-schema","title":"MerchantDCCSecondaryLookupDisclaimer","data":{"type":"string","example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the merchant must perform a secondary rate lookup before capture and if a secondary disclaimer is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes - Secondary rate-lookup on capture, accept/decline screen, and larger disclaimer on printed receipt required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No - Secondary rate-lookup, accept/decline screen, and larger disclaimer NOT required"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantCardTypeProcessor":{"id":"components/schemas/MerchantCardTypeProcessor","kind":"json-schema","title":"MerchantCardTypeProcessor","data":{"type":"string","readOnly":true,"example":"TSYSVLLA","description":"The processor configured for the card type.\n"}},"components/schemas/MerchantDCCCardTypesArray":{"id":"components/schemas/MerchantDCCCardTypesArray","kind":"json-schema","title":"MerchantDCCCardTypesArray","data":{"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CardTypeResp"},"processor":{"$ref":"#/components/schemas/MerchantCardTypeProcessor"}}},"example":[{"type":"VS","processor":"TSYSVLLA"},{"type":"MC","processor":"TSYSVLLA"},{"type":"AX","processor":"TSYSVLLA"},{"type":"NS","processor":"TSYSVLLA"}],"description":"Array of DCC supported card types\n"}},"components/schemas/MerchantDCCObject":{"id":"components/schemas/MerchantDCCObject","kind":"json-schema","title":"MerchantDCCObject","data":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/MerchantDCCEnabled"},"secondaryLookupDisclaimer":{"$ref":"#/components/schemas/MerchantDCCSecondaryLookupDisclaimer"},"cardTypes":{"$ref":"#/components/schemas/MerchantDCCCardTypesArray"}},"example":{"enabled":"Y","secondaryLookupDisclaimer":"N","cardTypes":[{"type":"VS","processor":"TSYSVLLA"},{"type":"MC","processor":"TSYSVLLA"},{"type":"AX","processor":"TSYSVLLA"},{"type":"NS","processor":"TSYSVLLA"}]}}},"components/schemas/MerchantGTVEnabled":{"id":"components/schemas/MerchantGTVEnabled","kind":"json-schema","title":"MerchantGTVEnabled","data":{"type":"string","example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether merchant is configured to support Tokenization using Shift4’s Global Token Vault (GTV) solution."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GTV is enabled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GTV is not enabled"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantGTVObject":{"id":"components/schemas/MerchantGTVObject","kind":"json-schema","title":"MerchantGTVObject","data":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/MerchantGTVEnabled"}}}},"components/schemas/MerchantSurchargeEnabled":{"id":"components/schemas/MerchantSurchargeEnabled","kind":"json-schema","title":"MerchantSurchargeEnabled","data":{"type":"string","example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether merchant is configured to support Surcharging."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharging is enabled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharging is not enabled"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantSurchargeObject":{"id":"components/schemas/MerchantSurchargeObject","kind":"json-schema","title":"MerchantSurchargeObject","data":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/MerchantSurchargeEnabled"}}}},"components/schemas/MerchantAutoCloseEnabled":{"id":"components/schemas/MerchantAutoCloseEnabled","kind":"json-schema","title":"MerchantAutoCloseEnabled","data":{"type":"string","example":"Y","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether merchant has Auto Close enabled for transaction batches."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto Close is enabled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto Close is not enabled"},"children":[]}]}]}]}]}]}]}},"components/schemas/MerchantAutoCloseObject":{"id":"components/schemas/MerchantAutoCloseObject","kind":"json-schema","title":"MerchantAutoCloseObject","data":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/MerchantAutoCloseEnabled"}}}},"components/schemas/MerchantCardTypeRangesLower":{"id":"components/schemas/MerchantCardTypeRangesLower","kind":"json-schema","title":"MerchantCardTypeRangesLower","data":{"type":"string","example":"40000000","description":"Lower limit for the card range\n"}},"components/schemas/MerchantCardTypeRangesUpper":{"id":"components/schemas/MerchantCardTypeRangesUpper","kind":"json-schema","title":"MerchantCardTypeRangesUpper","data":{"type":"string","example":"49999999","description":"Upper limit for the card range\n"}},"components/schemas/MerchantCardTypeRangesLengths":{"id":"components/schemas/MerchantCardTypeRangesLengths","kind":"json-schema","title":"MerchantCardTypeRangesLengths","data":{"type":"string","example":"13,16,17,18,19","description":"Comma separated list of possible lengths for the card range.\n"}},"components/schemas/MerchantCardTypeRangesLuhnCheck":{"id":"components/schemas/MerchantCardTypeRangesLuhnCheck","kind":"json-schema","title":"MerchantCardTypeRangesLuhnCheck","data":{"type":"boolean","example":true,"description":"Specifies whether or not the card range will pass the luhn check.\n"}},"components/schemas/MerchantCardTypesRangesObject":{"id":"components/schemas/MerchantCardTypesRangesObject","kind":"json-schema","title":"MerchantCardTypesRangesObject","data":{"type":"object","properties":{"lower":{"$ref":"#/components/schemas/MerchantCardTypeRangesLower"},"upper":{"$ref":"#/components/schemas/MerchantCardTypeRangesUpper"},"lengths":{"$ref":"#/components/schemas/MerchantCardTypeRangesLengths"},"lunhCheck":{"$ref":"#/components/schemas/MerchantCardTypeRangesLuhnCheck"}}}},"components/schemas/MerchantCardTypesRangesArray":{"id":"components/schemas/MerchantCardTypesRangesArray","kind":"json-schema","title":"MerchantCardTypesRangesArray","data":{"type":"array","items":{"$ref":"#/components/schemas/MerchantCardTypesRangesObject"},"description":"Array of card ranges\n"}},"components/schemas/MerchantCardTypesReturnProcessors":{"id":"components/schemas/MerchantCardTypesReturnProcessors","kind":"json-schema","title":"MerchantCardTypesReturnProcessors","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CardTypeResp"},"processor":{"$ref":"#/components/schemas/MerchantCardTypeProcessor"},"ranges":{"$ref":"#/components/schemas/MerchantCardTypesRangesArray"},"voiceCenter":{"$ref":"#/components/schemas/VoiceCenter"}}}},"components/schemas/MerchantCardTypesReturnProcessorsArray":{"id":"components/schemas/MerchantCardTypesReturnProcessorsArray","kind":"json-schema","title":"MerchantCardTypesReturnProcessorsArray","data":{"type":"array","items":{"$ref":"#/components/schemas/MerchantCardTypesReturnProcessors"},"example":[{"type":"VS","processor":"TSYSVLLA","ranges":[{"lower":"40000000","upper":"49999999","lengths":"13,16,17,18,19","luhnCheck":true}],"voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}},{"type":"MC","processor":"TSYSVLLA","ranges":[{"lower":"51000000","upper":"55999999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"22210000","upper":"27209999","lengths":"16,17,18,19","luhnCheck":true}],"voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}},{"type":"AX","processor":"TSYSVLLA","ranges":[{"lower":"34000000","upper":"34999999","lengths":"15","luhnCheck":true},{"lower":"37000000","upper":"37999999","lengths":"15","luhnCheck":true}],"voiceCenter":{"accountNumber":"65168416","phoneNumber":"1-800-123-1126"}},{"type":"NS","processor":"TSYSVLLA","ranges":[{"lower":"60110000","upper":"60110999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"60112000","upper":"60114999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"60117400","upper":"60117499","lengths":"16,17,18,19","luhnCheck":true},{"lower":"60117700","upper":"60117999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"60118600","upper":"60119999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"62400000","upper":"62699999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"62820000","upper":"62889999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"65000000","upper":"65999999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"62212600","upper":"62292599","lengths":"16,17,18,19","luhnCheck":true},{"lower":"62292600","upper":"62379699","lengths":"16,17,18,19","luhnCheck":true},{"lower":"64400000","upper":"64999999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"62109400","upper":"62109499","lengths":"13,16,17,18,19","luhnCheck":true},{"lower":"81000000","upper":"81719999","lengths":"16,17,18,19","luhnCheck":true},{"lower":"36000000","upper":"36999999","lengths":"14,15,16,17,18,19","luhnCheck":true},{"lower":"38000000","upper":"38999999","lengths":"14,15,16,17,18,19","luhnCheck":true},{"lower":"39000000","upper":"39999999","lengths":"14,15,16,17,18,19","luhnCheck":true},{"lower":"30000000","upper":"30999999","lengths":"14,15,16,17,18,19","luhnCheck":true},{"lower":"20140000","upper":"20149999","lengths":"15","luhnCheck":true},{"lower":"21490000","upper":"21499999","lengths":"15","luhnCheck":true}],"voiceCenter":{"accountNumber":"68406848684","phoneNumber":"1-888-320-1640"}},{"type":"YC","processor":"IYC","ranges":[{"lower":"00000001","upper":"09999999","lengths":"16","luhnCheck":true}],"voiceCenter":{"accountNumber":"2919201","phoneNumber":"1-800-444-5566"}}],"description":"Array of Merchant Card Types\n"}},"components/schemas/AmountTotalGC":{"id":"components/schemas/AmountTotalGC","kind":"json-schema","title":"AmountTotalGC","data":{"type":"number","maxLength":14,"example":20,"description":"The amount which should be added to the card's balance.  Amount cannot be zero.\n"}},"components/schemas/AmountGC":{"id":"components/schemas/AmountGC","kind":"json-schema","title":"AmountGC","data":{"type":"object","description":"Object containing information regarding the amount being added onto the card or removed from the card.\n","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotalGC"},"checkTotal":{"$ref":"#/components/schemas/AmountCheckTotal"}}}},"components/schemas/giftcards_activate_comengdevice":{"id":"components/schemas/giftcards_activate_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/DeviceComEngCloud":{"id":"components/schemas/DeviceComEngCloud","kind":"json-schema","title":"DeviceComEngCloud","data":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"}}}},"components/schemas/giftcards_activate_comengcloud":{"id":"components/schemas/giftcards_activate_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","card","device","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_activate_utgdevice":{"id":"components/schemas/giftcards_activate_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/CardExpirationDateGC":{"id":"components/schemas/CardExpirationDateGC","kind":"json-schema","title":"CardExpirationDateGC","data":{"type":"integer","minLength":3,"maxLength":4,"format":"MMYY","example":1230,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send in the request for manually entered or token transactions if the card has an expiration date. This field should not be specified when using an encrypted device."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card expiration date in MMYY format."},"children":[]}]}]}]}},"components/schemas/giftcards_activate_token_gtv":{"id":"components/schemas/giftcards_activate_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"expirationDate":1225,"present":"Y","token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_activate_token_legacy":{"id":"components/schemas/giftcards_activate_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"expirationDate":1225,"present":"Y","token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_activate_p2pe_idtech":{"id":"components/schemas/giftcards_activate_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_activate_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_activate_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_activate_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_activate_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/CardNumberGC":{"id":"components/schemas/CardNumberGC","kind":"json-schema","title":"CardNumberGC","data":{"type":"string","maxLength":32,"example":2664654648774,"description":"The payment card number. This field will always be masked when returned in a response.\n"}},"components/schemas/CardSecurityCodeValueGC":{"id":"components/schemas/CardSecurityCodeValueGC","kind":"json-schema","title":"CardSecurityCodeValueGC","data":{"type":"string","maxLength":4,"writeOnly":true,"example":"333","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: May be required for gift card transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three- or four-digit Card Security Code associated with gift card. This value may be required for requests depending on a card's settings. It should not be stored by the interface."},"children":[]}]}]}]}},"components/schemas/CardSecurityCodeGC":{"id":"components/schemas/CardSecurityCodeGC","kind":"json-schema","title":"CardSecurityCodeGC","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/CardSecurityCodeValueGC"}}}},"components/schemas/giftcards_activate_unencryptedcard":{"id":"components/schemas/giftcards_activate_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","number"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y","number":"2664654648774","expirationDate":1230},"transaction":{"invoice":"192029"}}}},"components/schemas/AmountTotalGCResponse":{"id":"components/schemas/AmountTotalGCResponse","kind":"json-schema","title":"AmountTotalGCResponse","data":{"type":"number","maxLength":14,"example":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/activate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/allocate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/reload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests, this is the amount which was added to the card's balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/cashout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests, this is the amount of cash that should be provided to the customer."},"children":[]}]}]}]}},"components/schemas/AmountGCResponse":{"id":"components/schemas/AmountGCResponse","kind":"json-schema","title":"AmountGCResponse","data":{"type":"object","description":"Object containing information regarding the amount being added onto the card or removed from the card.\n","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCResponse"}}}},"components/schemas/CardTypeGCResp":{"id":"components/schemas/CardTypeGCResp","kind":"json-schema","title":"CardTypeGCResp","data":{"type":"string","enum":["GC","YC"],"example":"YC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An abbreviation used to specify the type of card that was used when processing a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IT’S YOUR CARD"},"children":[]}]}]}]}]}]}]}},"components/schemas/CardTokenValueGC":{"id":"components/schemas/CardTokenValueGC","kind":"json-schema","title":"CardTokenValueGC","data":{"description":"This field is used to specify a card token. Whenever CHD is sent in a request, a card token will be returned in this field. Your interface should be designed to store this card token for future use. The latest card token received should be used in any subsequent request that references the same card data.\n","type":"string","maxLength":16,"example":"87743q5p3ffhv67y"}},"components/schemas/CardTokenGCResponse":{"id":"components/schemas/CardTokenGCResponse","kind":"json-schema","title":"CardTokenGCResponse","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/CardTokenValueGC"}}}},"components/schemas/CardResponseGC":{"id":"components/schemas/CardResponseGC","kind":"json-schema","title":"CardResponseGC","data":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/CardMaskedNumberGC"},"type":{"$ref":"#/components/schemas/CardTypeGCResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"token":{"$ref":"#/components/schemas/CardTokenGCResponse"}}}},"components/schemas/ProgramId":{"id":"components/schemas/ProgramId","kind":"json-schema","title":"ProgramId","data":{"type":"string","maxLength":16,"example":"123529291","description":"The ID value for the program you are allocating a gift card under.\n"}},"components/schemas/CardDeactivationReason":{"id":"components/schemas/CardDeactivationReason","kind":"json-schema","title":"CardDeactivationReason","data":{"type":"string","maxLength":32,"example":"Lost or Stolen","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a Gift Card "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/deactivate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/gift-cards/cashout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, specifies the reason for deactivation. In a Gift Card redemption or inquiry response, specifies the reason for denial sent by the processor."},"children":[]}]}]}]}},"components/schemas/giftcards_deactivate_comengdevice":{"id":"components/schemas/giftcards_deactivate_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_comengcloud":{"id":"components/schemas/giftcards_deactivate_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_utgdevice":{"id":"components/schemas/giftcards_deactivate_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_token_gtv":{"id":"components/schemas/giftcards_deactivate_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present","token"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1225,"present":"N","token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_token_legacy":{"id":"components/schemas/giftcards_deactivate_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present","token"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1225,"present":"N","token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_p2pe_idtech":{"id":"components/schemas/giftcards_deactivate_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_deactivate_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_deactivate_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_deactivate_unencryptedcard":{"id":"components/schemas/giftcards_deactivate_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present","number"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1230,"number":"2664654648774","present":"N"},"transaction":{"invoice":"192029"}}}},"components/schemas/CardResponseDeact":{"id":"components/schemas/CardResponseDeact","kind":"json-schema","title":"CardResponseDeact","data":{"type":"object","properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumberGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeGCResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"token":{"$ref":"#/components/schemas/CardTokenGCResponse"}}}},"components/schemas/AmountTotalGCCashback":{"id":"components/schemas/AmountTotalGCCashback","kind":"json-schema","title":"AmountTotalGCCashback","data":{"type":"number","maxLength":14,"example":20,"description":"The amount you want to get back from the gift card. If this field is not sent then the full balance of the card will be returned as cash.\n"}},"components/schemas/giftcards_cashout_comengdevice":{"id":"components/schemas/giftcards_cashout_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_comengcloud":{"id":"components/schemas/giftcards_cashout_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_utgdevice":{"id":"components/schemas/giftcards_cashout_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_token_gtv":{"id":"components/schemas/giftcards_cashout_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present","token"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1225,"present":"N","token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_token_legacy":{"id":"components/schemas/giftcards_cashout_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present","token"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1225,"present":"N","token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_p2pe_idtech":{"id":"components/schemas/giftcards_cashout_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"N"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_cashout_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_cashout_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cashout_unencryptedcard":{"id":"components/schemas/giftcards_cashout_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["deactivationReason","number","present"],"properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotalGCCashback"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"deactivationReason":"Stolen","expirationDate":1230,"number":"2664654648774","present":"N"},"transaction":{"invoice":"192029"}}}},"components/schemas/CardResponseCashout":{"id":"components/schemas/CardResponseCashout","kind":"json-schema","title":"CardResponseCashout","data":{"type":"object","properties":{"deactivationReason":{"$ref":"#/components/schemas/CardDeactivationReason"},"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumberGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeGCResp"},"token":{"$ref":"#/components/schemas/CardTokenGCResponse"}}}},"components/schemas/giftcards_reactivate_comengdevice":{"id":"components/schemas/giftcards_reactivate_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_comengcloud":{"id":"components/schemas/giftcards_reactivate_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_utgdevice":{"id":"components/schemas/giftcards_reactivate_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_token_gtv":{"id":"components/schemas/giftcards_reactivate_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y","expirationDate":1225,"token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_token_legacy":{"id":"components/schemas/giftcards_reactivate_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y","expirationDate":1225,"token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_p2pe_idtech":{"id":"components/schemas/giftcards_reactivate_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_reactivate_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_reactivate_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reactivate_unencryptedcard":{"id":"components/schemas/giftcards_reactivate_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","number"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"expirationDate":1230,"number":"2664654648774","present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_comengdevice":{"id":"components/schemas/giftcards_reload_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_comengcloud":{"id":"components/schemas/giftcards_reload_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_utgdevice":{"id":"components/schemas/giftcards_reload_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","amount","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_token_gtv":{"id":"components/schemas/giftcards_reload_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y","expirationDate":1225,"token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_token_legacy":{"id":"components/schemas/giftcards_reload_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y","expirationDate":1225,"token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_p2pe_idtech":{"id":"components/schemas/giftcards_reload_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_reload_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_reload_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_reload_unencryptedcard":{"id":"components/schemas/giftcards_reload_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"card":{"type":"object","required":["present","number"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"card":{"present":"Y","number":"2664654648774","expirationDate":1230},"transaction":{"invoice":"192029"}}}},"components/schemas/ApiOptionsGCBalance":{"id":"components/schemas/ApiOptionsGCBalance","kind":"json-schema","title":"ApiOptionsGCBalance","data":{"type":"array","items":{"type":"string"},"example":["RETURNHIST"],"writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options modify the request being made."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNHIST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the gift card usage history in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]}]}]}]}},"components/schemas/giftcards_balance_comengdevice":{"id":"components/schemas/giftcards_balance_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_comengcloud":{"id":"components/schemas/giftcards_balance_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_utgdevice":{"id":"components/schemas/giftcards_balance_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"terminalId":"1742"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_token_gtv":{"id":"components/schemas/giftcards_balance_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y","expirationDate":1225,"token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_token_legacy":{"id":"components/schemas/giftcards_balance_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y","expirationDate":1225,"token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_p2pe_idtech":{"id":"components/schemas/giftcards_balance_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - MSR/Manual","data":{"title":"P2PE - ID TECH - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"p2pe":{"data":"02B600C0170018009292;000442******0006=3012?*61A0453AB7145F1FA7685D2F27A745E129525EDAEA5BB7DBBAF49A5F876E3EE5000000000000000000000000000000000000000034343454343631383439629949500100382003E6FF4D03","format":"01"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_p2pe_tdesdukpt_msr":{"id":"components/schemas/giftcards_balance_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"present":"Y"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"Y","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_p2pe_onguardsde_msr":{"id":"components/schemas/giftcards_balance_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","card","transaction","p2pe","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"present":"Y"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_balance_unencryptedcard":{"id":"components/schemas/giftcards_balance_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["present","number"],"properties":{"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumberGC"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateGC"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeGC"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"apiOptions":{"$ref":"#/components/schemas/ApiOptionsGCBalance"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"expirationDate":1230,"number":"2664654648774","present":"Y"},"transaction":{"invoice":"192029"}}}},"components/schemas/AmountTotalOnly":{"id":"components/schemas/AmountTotalOnly","kind":"json-schema","title":"AmountTotalOnly","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount fields can specify up to three decimal places. However, the number of decimal places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}}},"components/schemas/giftcards_cancel_token_gtv":{"id":"components/schemas/giftcards_cancel_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"8900004710343233"}},"transaction":{"invoice":"192029"}}}},"components/schemas/giftcards_cancel_token_legacy":{"id":"components/schemas/giftcards_cancel_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"87743q5p3ffhv67y","serialNumber":"123456"}},"transaction":{"invoice":"192029"}}}},"components/schemas/cards_verify_comengdevice":{"id":"components/schemas/cards_verify_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"type":"object","title":"Commerce Engine For On Premise","required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2025-11-06T09:18:23.283-07:00"}}},"components/schemas/cards_verify_comengcloud":{"id":"components/schemas/cards_verify_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"type":"object","title":"Commerce Engine For Cloud","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressFinalResult":{"$ref":"#/components/schemas/UISuppressFinalResult"}}}},"example":{"dateTime":"2025-11-06T09:18:23.283-07:00","device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"}}}},"components/schemas/cards_verify_utgdevice":{"id":"components/schemas/cards_verify_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"type":"object","title":"UTG Controlled Device","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"terminalId":"1742"}}}},"components/schemas/cards_verify_token_gtv":{"id":"components/schemas/cards_verify_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"8048471746471119"},"expirationDate":1225}}}},"components/schemas/cards_verify_token_legacy":{"id":"components/schemas/cards_verify_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"11191pn83hbkkety","serialNumber":"123456"},"expirationDate":1225}}}},"components/schemas/cards_verify_p2pe_idtech":{"id":"components/schemas/cards_verify_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"type":"object","title":"P2PE - ID TECH - EMV/MSR/Manual","required":["dateTime","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","p2pe":{"data":"027101801F2D1E00939B%*432100******1119^VS/DUAL TRACK^2212******?*;432100******1119=2212******?*CECE3FCE7781142BEC8D0E267AE89F5D3C7E235BF1A70E637951E8D93003E5A2586C336CA4A3B31F6639B04005BB12A716D8BC4D3AB125C27AB11A9DDC02816569D42A20B036EE5E2C71CB70565FB43B000000000000000000000000000000000000000000000000000000000000000000000000000000003434345434363138343962994950010038200415953903","format":"01"}}}},"components/schemas/cards_verify_p2pe_tdesdukpt_emv":{"id":"components/schemas/cards_verify_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"type":"object","title":"P2PE - TDES DUKPT - EMV","required":["dateTime","card","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"type":"object","required":["tlvData"],"properties":{"tlvData":{"$ref":"#/components/schemas/EMVTlvData"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"E"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"4F07A0000000041010500A4D61737465724361726457203CCEB572BE7DD0A38E62E6BD70E3DAACE9B46BD3BF65E188E7D8D68D2178DE1A5A10B1794BAC083B08F0A1444F189A5493255F201A546573742F4361726420303920202020202020202020202020205F24032512315F25031511015F2D02656E5F3401018407A0000000041010950508200000009B02C8009F02060000000004449F03060000000000009F34031E03009F3704C5BF918D9F390105"},"p2pe":{"format":"05","ksn":"6299495001100E200041"}}}},"components/schemas/cards_verify_p2pe_tdesdukpt_msr":{"id":"components/schemas/cards_verify_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"type":"object","title":"P2PE - TDES DUKPT - MSR/Manual","required":["dateTime","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"2"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"}}}},"components/schemas/cards_verify_p2pe_onguardsde_emv":{"id":"components/schemas/cards_verify_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"type":"object","title":"P2PE - On-Guard SDE - EMV","required":["dateTime","card","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"type":"object","required":["tlvData"],"properties":{"tlvData":{"$ref":"#/components/schemas/EMVTlvDataOnguardSDE"}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2023-124-13T09:18:23.283-07:00","card":{"entryMode":"E"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"}}}},"components/schemas/cards_verify_p2pe_onguardsde_msr":{"id":"components/schemas/cards_verify_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"type":"object","title":"P2PE - On-Guard SDE - MSR/Manual","required":["dateTime","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"entryMode":"2"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"}}}},"components/schemas/cards_verify_unencryptedcard":{"id":"components/schemas/cards_verify_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"type":"object","title":"Card Number Unencrypted","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"type":"object","properties":{"indicator":{"$ref":"#/components/schemas/CardSecurityCodeIndicator"},"value":{"$ref":"#/components/schemas/CardSecurityCodeValue"}}}}},"transaction":{"type":"object","properties":{"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"number":"4321000000001119","expirationDate":1230,"securityCode":{"indicator":"1","value":"333"}},"customer":{"addressLine1":"65 Easy St","firstName":"John","lastName":"Smith","postalCode":"65144"}}}},"components/schemas/TransactionResponseCodeCardsVerify":{"id":"components/schemas/TransactionResponseCodeCardsVerify","kind":"json-schema","title":"TransactionResponseCodeCardsVerify","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D","e","f"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card was successfully verified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card failed verification."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an error condition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"f"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/response-handling/understanding-avs-and-csc-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AVS or CSC failure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An AVS or CSC failure has occurred (credit card only). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This value will only be returned if the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options#poshandleavsfail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POSHANDLEAVSFAIL Api Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was sent in the request."},"children":[]}]}]}]}]}]}]}]}},"components/schemas/ANIResponseCode":{"id":"components/schemas/ANIResponseCode","kind":"json-schema","title":"ANIResponseCode","data":{"type":"string","enum":["E","A","B","C","D","F","G","H","I","J","N","U"],"example":"E","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Name Inquiry Response Code. Returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USEANI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API Option and customer name information is sent in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANI Response Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name: match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: partial match, Last name: match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: no match, Last name: match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: match, Last name: partial match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: match, Last name: no match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: partial match, Last name: partial match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"G"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: no match, Last name: partial match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"H"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: partial match, Last name: no match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"I"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name: match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"J"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name: partial match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name: no match, Last name: no match"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name: no match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name match not performed"},"children":[]}]}]}]}]}]}]}},"components/schemas/AccountNameInquiryResponse":{"id":"components/schemas/AccountNameInquiryResponse","kind":"json-schema","title":"AccountNameInquiryResponse","data":{"type":"object","properties":{"aniResponseCode":{"$ref":"#/components/schemas/ANIResponseCode"}}}},"components/schemas/cards_identify_utgdevice":{"id":"components/schemas/cards_identify_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"type":"object","title":"UTG Controlled Device","allOf":[{"type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptPostalCode":{"$ref":"#/components/schemas/DevicePromptPostalCode"},"promptCardSecurityCode":{"$ref":"#/components/schemas/DevicePromptCardSecurityCode"},"promptStreetNumber":{"$ref":"#/components/schemas/DevicePromptStreetNumber"}}}}}],"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"terminalId":"1742"}}}},"components/schemas/cards_identify_token_gtv":{"id":"components/schemas/cards_identify_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","allOf":[{"type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}}}}],"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"8048471746471119"},"expirationDate":1225}}}},"components/schemas/cards_identify_token_legacy":{"id":"components/schemas/cards_identify_token_legacy","kind":"json-schema","title":"Legacy TrueToken","data":{"title":"Legacy TrueToken","type":"object","allOf":[{"type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}}}}],"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"11191pn83hbkkety","serialNumber":"123456"},"expirationDate":1225}}}},"components/schemas/cards_identify_p2pe_idtech":{"id":"components/schemas/cards_identify_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"type":"object","title":"P2PE - ID TECH - EMV/MSR/Manual","required":["dateTime","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","p2pe":{"data":"027101801F2D1E00939B%*432100******1119^VS/DUAL TRACK^2212******?*;432100******1119=2212******?*CECE3FCE7781142BEC8D0E267AE89F5D3C7E235BF1A70E637951E8D93003E5A2586C336CA4A3B31F6639B04005BB12A716D8BC4D3AB125C27AB11A9DDC02816569D42A20B036EE5E2C71CB70565FB43B000000000000000000000000000000000000000000000000000000000000000000000000000000003434345434363138343962994950010038200415953903","format":"01"}}}},"components/schemas/cards_identify_p2pe_tdesdukpt_emv":{"id":"components/schemas/cards_identify_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","card","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"emv":{"type":"object","required":["tlvData"],"properties":{"tlvData":{"$ref":"#/components/schemas/EMVTlvData"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"E"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"emv":{"tlvData":"4F07A0000000041010500A4D61737465724361726457203CCEB572BE7DD0A38E62E6BD70E3DAACE9B46BD3BF65E188E7D8D68D2178DE1A5A10B1794BAC083B08F0A1444F189A5493255F201A546573742F4361726420303920202020202020202020202020205F24032512315F25031511015F2D02656E5F3401018407A0000000041010950508200000009B02C8009F02060000000004449F03060000000000009F34031E03009F3704C5BF918D9F390105"},"p2pe":{"format":"05","ksn":"6299495001100E200041"}}}},"components/schemas/cards_identify_p2pe_tdesdukpt_msr":{"id":"components/schemas/cards_identify_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","allOf":[{"type":"object","required":["dateTime","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}}}],"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"2"},"device":{"manufacturer":"PAX","model":"A930","serialNumber":"1170301234","capability":{"contactlessEMV":"N","contactlessMSR":"Y","EMV":"Y","magstripe":"Y","manualEntry":"Y","quickChip":"Y"}},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"}}}},"components/schemas/cards_identify_p2pe_onguardsde_emv":{"id":"components/schemas/cards_identify_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","allOf":[{"type":"object","required":["dateTime","card","device","emv","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"emv":{"type":"object","required":["tlvData"],"properties":{"tlvData":{"$ref":"#/components/schemas/EMVTlvDataOnguardSDE"}}}}}],"example":{"dateTime":"2023-12-13T09:18:23.283-07:00","card":{"entryMode":"E"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401018407A00000000310109F100706010A03A0A0009F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"}}}},"components/schemas/cards_identify_p2pe_onguardsde_msr":{"id":"components/schemas/cards_identify_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","allOf":[{"type":"object","required":["dateTime","card","device","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"device":{"type":"object","required":["manufacturer","model","serialNumber","capability"],"properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}}}],"example":{"dateTime":"2023-124-13T09:18:23.283-07:00","card":{"entryMode":"2"},"device":{"manufacturer":"Ingenico","model":"Axium DX8000","serialNumber":"20ACCD801843","capability":{"contactlessEMV":"Y","contactlessMSR":"N","EMV":"Y","manualEntry":"Y","magstripe":"Y","PIN":"Y","quickChip":"Y","signature":"Y"}},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"}}}},"components/schemas/cards_identify_unencryptedcard":{"id":"components/schemas/cards_identify_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"type":"object","title":"Card Number Unencrypted","allOf":[{"type":"object","required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["number","expirationDate","entryMode"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"entryMode":{"type":"string","minLength":1,"maxLength":1,"enum":["M"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: The Card Entry Mode should be sent in an initial request; in subsequent requests, it should be left blank or not sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Entry"},"children":[]}]}]}]}]}]}]},"securityCode":{"type":"object","properties":{"indicator":{"$ref":"#/components/schemas/CardSecurityCodeIndicator"},"value":{"$ref":"#/components/schemas/CardSecurityCodeValue"}}}}}}}],"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"number":"4321000000001119","expirationDate":1230,"securityCode":{"indicator":"1","value":"333"}}}}},"components/schemas/CardBin":{"id":"components/schemas/CardBin","kind":"json-schema","title":"CardBin","data":{"type":"string","readOnly":true,"maxLength":8,"example":"541333","description":"The first 6 or 8 digits of the card.\n"}},"components/schemas/CardDccCapable":{"id":"components/schemas/CardDccCapable","kind":"json-schema","title":"CardDccCapable","data":{"type":"string","enum":["Y","N"],"example":"Y","description":"In BIN management, specifies whether or not the card is dynamic currency conversion (DCC) capable.\n"}},"components/schemas/CardDebitCapable":{"id":"components/schemas/CardDebitCapable","kind":"json-schema","title":"CardDebitCapable","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In BIN management, specifies whether a card can be processed as debit (‘Y’) or not (‘N’)."},"children":[]}]}]}]}},"components/schemas/CardLevelResultIdentify":{"id":"components/schemas/CardLevelResultIdentify","kind":"json-schema","title":"CardLevelResultIdentify","data":{"type":"string","example":"1P","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In BIN management, specifies the detailed card type. For a complete list of potential values, see the [Card Level Results]/guides/appendices/card-level-results) section in this document's appendix."},"children":[]}]}]}]}},"components/schemas/CardResponseIdentify":{"id":"components/schemas/CardResponseIdentify","kind":"json-schema","title":"CardResponseIdentify","data":{"type":"object","properties":{"bin":{"$ref":"#/components/schemas/CardBin"},"dccCapable":{"$ref":"#/components/schemas/CardDccCapable"},"debitCapable":{"$ref":"#/components/schemas/CardDebitCapable"},"levelResult":{"$ref":"#/components/schemas/CardLevelResultIdentify"},"type":{"$ref":"#/components/schemas/CardTypeResp"}}}},"components/schemas/DeviceDisplayText":{"id":"components/schemas/DeviceDisplayText","kind":"json-schema","title":"DeviceDisplayText","data":{"type":"string","maxLength":72,"example":"Please Sign","description":"Optional field that specifies the text to display on the device.\n"}},"components/schemas/DeviceNextStepType":{"id":"components/schemas/DeviceNextStepType","kind":"json-schema","title":"DeviceNextStepType","data":{"type":"string","enum":["idle","none","displayWait","displayText"],"example":"displayText","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the device behavior after processing the request. If no additional request is received after 120 seconds the device will return to idle as a failsafe."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"idle"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return back to the idle screen"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stay on the same screen. A subsequent message must be immediately sent or else the device will appear frozen to the user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"displayWait"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays a please wait screen"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"displayText"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays custom text. The request must include at least one of the following fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device.nextStep.header.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device.nextStep.subHeader.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device.nextStep.text.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}},"components/schemas/DeviceFormHeader":{"id":"components/schemas/DeviceFormHeader","kind":"json-schema","title":"DeviceFormHeader","data":{"type":"object","properties":{"value":{"type":"string","maxLength":100,"example":"Header text goes here","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header text. Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\r\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a new line."},"children":[]}]}]}]}}}},"components/schemas/DeviceFormSubHeader":{"id":"components/schemas/DeviceFormSubHeader","kind":"json-schema","title":"DeviceFormSubHeader","data":{"type":"object","properties":{"value":{"type":"string","maxLength":100,"example":"Sub Header text goes here","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub Header text. Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\r\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a new line."},"children":[]}]}]}]}}}},"components/schemas/DeviceFormText":{"id":"components/schemas/DeviceFormText","kind":"json-schema","title":"DeviceFormText","data":{"type":"object","properties":{"value":{"type":"string","maxLength":4096,"example":"Body text goes here","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body text. Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\r\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a new line."},"children":[]}]}]}]}}}},"components/schemas/DeviceNextStep":{"id":"components/schemas/DeviceNextStep","kind":"json-schema","title":"DeviceNextStep","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional object used to control the device behavior after processing the request. If included in the request, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sub-field is required"},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/DeviceNextStepType"},"header":{"$ref":"#/components/schemas/DeviceFormHeader"},"subHeader":{"$ref":"#/components/schemas/DeviceFormSubHeader"},"text":{"$ref":"#/components/schemas/DeviceFormText"}}}},"components/schemas/UIRequest":{"id":"components/schemas/UIRequest","kind":"json-schema","title":"UIRequest","data":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"}}}},"components/schemas/devices_promptsignature_comengdevice":{"id":"components/schemas/devices_promptsignature_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"displayText":{"$ref":"#/components/schemas/DeviceDisplayText"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00"}}},"components/schemas/devices_promptsignature_comengcloud":{"id":"components/schemas/devices_promptsignature_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"displayText":{"$ref":"#/components/schemas/DeviceDisplayText"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00","device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"}}}},"components/schemas/DeviceOnlyTID":{"id":"components/schemas/DeviceOnlyTID","kind":"json-schema","title":"DeviceOnlyTID","data":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}}},"components/schemas/devices_promptsignature_utgdevice":{"id":"components/schemas/devices_promptsignature_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceOnlyTID"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"terminalId":"1742"}}}},"components/schemas/DevicePromptConfirmationQuestion":{"id":"components/schemas/DevicePromptConfirmationQuestion","kind":"json-schema","title":"DevicePromptConfirmationQuestion","data":{"type":"string","maxLength":64,"writeOnly":true,"example":"Rewards Program","description":"This field displays an inquiry prompting a consumer's confirmation.\n"}},"components/schemas/DevicePromptConfirmationResult":{"id":"components/schemas/DevicePromptConfirmationResult","kind":"json-schema","title":"DevicePromptConfirmationResult","data":{"type":"string","maxLength":1,"readOnly":true,"enum":["Y","N"],"example":"N","description":"In the response to a Prompt Confirmation request, this field specifies whether the consumer has opted to confirm ('Y') or deny ('N') the requested value.\n"}},"components/schemas/DevicePromptConfirmationValue":{"id":"components/schemas/DevicePromptConfirmationValue","kind":"json-schema","title":"DevicePromptConfirmationValue","data":{"type":"string","maxLength":4096,"writeOnly":true,"example":"Would you like to join our rewards program?","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field displays text, such as an email address or legal text, for a consumer’s confirmation."},"children":[]}]}]}]}},"components/schemas/DevicePromptConfirmation":{"id":"components/schemas/DevicePromptConfirmation","kind":"json-schema","title":"DevicePromptConfirmation","data":{"type":"object","properties":{"question":{"$ref":"#/components/schemas/DevicePromptConfirmationQuestion"},"result":{"$ref":"#/components/schemas/DevicePromptConfirmationResult"},"value":{"$ref":"#/components/schemas/DevicePromptConfirmationValue"}}}},"components/schemas/DevicePromptTermsAndConditionsAckCheckBox":{"id":"components/schemas/DevicePromptTermsAndConditionsAckCheckBox","kind":"json-schema","title":"DevicePromptTermsAndConditionsAckCheckBox","data":{"type":"boolean","writeOnly":true,"example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the acknowledgement check box or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable it. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not sent."},"children":[]}]}]}]}},"components/schemas/DevicePromptTermsAndConditionsAckText":{"id":"components/schemas/DevicePromptTermsAndConditionsAckText","kind":"json-schema","title":"DevicePromptTermsAndConditionsAckText","data":{"type":"string","maxLength":100,"writeOnly":true,"example":"I agree to the End User Agreement","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the text to display in the acknowledgement check box. If not sent, the acknowledgement check box will display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I agree to the terms and conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/DevicePromptTermsAndConditionsHeader":{"id":"components/schemas/DevicePromptTermsAndConditionsHeader","kind":"json-schema","title":"DevicePromptTermsAndConditionsHeader","data":{"type":"string","maxLength":100,"writeOnly":true,"example":"End User License Agreement","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the text to display in the header. If not sent, the header will display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terms and Conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/DevicePromptTermsAndConditionsValue":{"id":"components/schemas/DevicePromptTermsAndConditionsValue","kind":"json-schema","title":"DevicePromptTermsAndConditionsValue","data":{"type":"string","maxLength":4096,"writeOnly":true,"example":"Terms and Conditions","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the Terms and Conditions text for the UTG or Commerce Engine controlled PIN pad to display to a consumer. Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\r\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a new line."},"children":[]}]}]}]}},"components/schemas/DevicePromptTermsAndConditionsComEng":{"id":"components/schemas/DevicePromptTermsAndConditionsComEng","kind":"json-schema","title":"DevicePromptTermsAndConditionsComEng","data":{"type":"object","required":["value"],"properties":{"ackCheckBox":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsAckCheckBox"},"ackText":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsAckText"},"header":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsHeader"},"value":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsValue"}}}},"components/schemas/devices_termsandconditions_comengdevice":{"id":"components/schemas/devices_termsandconditions_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["promptTermsAndConditions"],"properties":{"promptTermsAndConditions":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsComEng"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/devices_termsandconditions_comengcloud":{"id":"components/schemas/devices_termsandconditions_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber","promptTermsAndConditions"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"promptTermsAndConditions":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsComEng"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/DevicePromptTermsAndConditionsResult":{"id":"components/schemas/DevicePromptTermsAndConditionsResult","kind":"json-schema","title":"DevicePromptTermsAndConditionsResult","data":{"type":"string","maxLength":1,"readOnly":true,"enum":["A","D"],"example":"A","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the result of the Terms and Conditions screen on the PIN pad (based on the consumer’s input)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]}]}]}]}]}},"components/schemas/DevicePromptTermsAndConditions":{"id":"components/schemas/DevicePromptTermsAndConditions","kind":"json-schema","title":"DevicePromptTermsAndConditions","data":{"type":"object","required":["value"],"properties":{"result":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsResult"},"value":{"$ref":"#/components/schemas/DevicePromptTermsAndConditionsValue"}}}},"components/schemas/devices_termsandconditions_utgdevice":{"id":"components/schemas/devices_termsandconditions_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId","promptTermsAndConditions"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"},"promptTermsAndConditions":{"$ref":"#/components/schemas/DevicePromptTermsAndConditions"}}}}}},"components/schemas/DeviceLineItemsArray":{"id":"components/schemas/DeviceLineItemsArray","kind":"json-schema","title":"DeviceLineItemsArray","data":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"},"example":["Hamburger","Fries","Soda","Cookie"],"description":"An array of line items to display on the UTG-controlled device.\n"}},"components/schemas/DeviceTerminalIdDevicesInfo":{"id":"components/schemas/DeviceTerminalIdDevicesInfo","kind":"json-schema","title":"DeviceTerminalIdDevicesInfo","data":{"type":"string","example":"GBAIOQAN11","description":"Terminal ID configured for the device.\n"}},"components/schemas/DeviceModelDevicesInfo":{"id":"components/schemas/DeviceModelDevicesInfo","kind":"json-schema","title":"DeviceModelDevicesInfo","data":{"type":"string","maxLength":50,"example":"A800","description":"Specifies the model of the device.\n"}},"components/schemas/HardwareCPU":{"id":"components/schemas/HardwareCPU","kind":"json-schema","title":"HardwareCPU","data":{"type":"string","example":"cortex-a53 (8 cores @ 1.8 GHz)","description":"The CPU model information.\n"}},"components/schemas/HardwareRamMb":{"id":"components/schemas/HardwareRamMb","kind":"json-schema","title":"HardwareRamMb","data":{"type":"string","example":"1854","description":"The total amount of RAM in megabytes.\n"}},"components/schemas/HardwareStorageMbTotal":{"id":"components/schemas/HardwareStorageMbTotal","kind":"json-schema","title":"HardwareStorageMbTotal","data":{"type":"string","example":"12297","description":"The amount of total storage space in megabytes.\n"}},"components/schemas/HardwareStorageMbFree":{"id":"components/schemas/HardwareStorageMbFree","kind":"json-schema","title":"HardwareStorageMbFree","data":{"type":"string","example":"9869","description":"The amout of free storage space in megabytes.\n"}},"components/schemas/HardwareStorageMbUsed":{"id":"components/schemas/HardwareStorageMbUsed","kind":"json-schema","title":"HardwareStorageMbUsed","data":{"type":"string","example":"2428","description":"The amout of used storage space in megabytes.\n"}},"components/schemas/HardwareBatteryLevel":{"id":"components/schemas/HardwareBatteryLevel","kind":"json-schema","title":"HardwareBatteryLevel","data":{"type":"string","example":"83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current battery level on the device. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the device does not have a battery"},"children":[]}]}]}]}},"components/schemas/FirmwareFirmwareVersion":{"id":"components/schemas/FirmwareFirmwareVersion","kind":"json-schema","title":"FirmwareFirmwareVersion","data":{"type":"string","example":"PayDroid_10.0.0_Eucalyptus_V20.1.28_20250915/4.11.00_20250120","description":"The firmware version.\n"}},"components/schemas/FirmwareAndroidVersion":{"id":"components/schemas/FirmwareAndroidVersion","kind":"json-schema","title":"FirmwareAndroidVersion","data":{"type":"string","example":"10","description":"The Android OS version.\n"}},"components/schemas/FirmwareEMVKernelVersion":{"id":"components/schemas/FirmwareEMVKernelVersion","kind":"json-schema","title":"FirmwareEMVKernelVersion","data":{"type":"string","example":"v659 2025.02.26","description":"The EMV kernel version.\n"}},"components/schemas/FirmwareCTLSKernelVersion":{"id":"components/schemas/FirmwareCTLSKernelVersion","kind":"json-schema","title":"FirmwareCTLSKernelVersion","data":{"type":"string","example":"v558 2025.04.10;v359_02 2025.02.20;v557_01 2024.01.15;v252_01 2023.02.09;v155 2024.12.19;v353 2025.01.22;v153_02 2024.12.05;v253 2025.01.10;v153 2025.09.09","description":"The card brand contactless kernel versions.\n"}},"components/schemas/SecurityP2PEVersion":{"id":"components/schemas/SecurityP2PEVersion","kind":"json-schema","title":"SecurityP2PEVersion","data":{"type":"string","example":"2.0.6.211.3.0","description":"The P2PE application version\n"}},"components/schemas/SecurityPCIHardwareVersion":{"id":"components/schemas/SecurityPCIHardwareVersion","kind":"json-schema","title":"SecurityPCIHardwareVersion","data":{"type":"string","example":"A800-0AW-RE6-10AA","description":"The PCI hardware version\n"}},"components/schemas/SecurityPCIFirmwareVersion":{"id":"components/schemas/SecurityPCIFirmwareVersion","kind":"json-schema","title":"SecurityPCIFirmwareVersion","data":{"type":"string","example":"secver_26.01.0128;firmver_26.01.0128","description":"The PCI firmware version\n"}},"components/schemas/ApplicationsArray":{"id":"components/schemas/ApplicationsArray","kind":"json-schema","title":"ApplicationsArray","data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Commerce Engine","description":"Application name\n"},"packageName":{"type":"string","example":"com.priv.shift4.commerceengine","description":"Application package name\n"},"versionName":{"type":"string","example":"2.14.0","description":"Application version name\n"},"versionCode":{"type":"number","example":2140000,"description":"Application version code\n"}}},"example":[{"name":"Commerce Engine","packageName":"com.priv.shift4.commerceengine","versionName":"2.14.0","versionCode":2140000},{"name":"Shift4 SOLO","packageName":"com.shift4.bonepony","versionName":"2.149.0","versionCode":2149000}]}},"components/schemas/ConnectivityActiveInterface":{"id":"components/schemas/ConnectivityActiveInterface","kind":"json-schema","title":"ConnectivityActiveInterface","data":{"type":"string","example":"wifi","description":"The network interface that is active on the device\n"}},"components/schemas/ConnectivityIP":{"id":"components/schemas/ConnectivityIP","kind":"json-schema","title":"ConnectivityIP","data":{"type":"string","example":"192.168.4.200","description":"The device IP address\n"}},"components/schemas/ConnectivityGateway":{"id":"components/schemas/ConnectivityGateway","kind":"json-schema","title":"ConnectivityGateway","data":{"type":"string","example":"192.168.4.1","description":"Default gateway\n"}},"components/schemas/ConnectivitySubnetMask":{"id":"components/schemas/ConnectivitySubnetMask","kind":"json-schema","title":"ConnectivitySubnetMask","data":{"type":"string","example":"255.255.255.0","description":"Subnet mask\n"}},"components/schemas/ConnectivityDNS1":{"id":"components/schemas/ConnectivityDNS1","kind":"json-schema","title":"ConnectivityDNS1","data":{"type":"string","example":"8.8.8.8","description":"Primary DNS server address\n"}},"components/schemas/ConnectivityDNS2":{"id":"components/schemas/ConnectivityDNS2","kind":"json-schema","title":"ConnectivityDNS2","data":{"type":"string","example":"8.8.4.4","description":"Secondary DNS server address\n"}},"components/schemas/ConnectivityInterfaces":{"id":"components/schemas/ConnectivityInterfaces","kind":"json-schema","title":"ConnectivityInterfaces","data":{"type":"object","properties":{"ethernet":{"type":"object","properties":{"mac":{"type":"string","example":"F4:02:23:43:69:FD","description":"Ethernet MAC address\n"},"isUp":{"type":"string","enum":["Y","N"],"example":"N","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 'Y' if the interface is up and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interface is down."},"children":[]}]}]}]}}},"wifi":{"type":"object","properties":{"mac":{"type":"string","example":"F4:02:23:7F:57:C6","description":"Wi-Fi MAC address\n"},"ssid":{"type":"string","example":"MerchantWiFi","description":"Wi-Fi SSID\n"},"isUp":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 'Y' if the interface is up and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interface is down."},"children":[]}]}]}]},"signalStrength":{"type":"string","example":"-46 dBm","description":"The Wi-Fi signal strength\n"}}},"cellular":{"type":"object","properties":{"imei":{"type":"string","example":"354970460015528","description":"Cellular International Mobile Equipment Identity (IMEI) value\n"},"iccid":{"type":"string","example":"8901240204204081862","description":"Cellular Integrated Circuit Card Identifier (ICCID)\n"},"carrier":{"type":"string","example":"T-Mobile","description":"Cellular mobile network carrier\n"},"isUp":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 'Y' if the interface is up and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the interface is down."},"children":[]}]}]}]},"signalStrength":{"type":"string","example":"-50 dBm","description":"The Cellular signal strength\n"}}}},"example":{"wifi":{"mac":"F4:02:23:7F:57:C6","ssid":"MerchantWiFi","isUp":"Y","signalStrength":"-46 dBm"},"cellular":{"imei":"354970460015528","iccid":"8901240204204081862","carrier":"T-Mobile","isUp":"Y","signalStrength":"-50 dBm"}}}},"components/schemas/UILanguageResponse":{"id":"components/schemas/UILanguageResponse","kind":"json-schema","title":"UILanguageResponse","data":{"type":"string","example":"en","description":"ISO 639-1 2-letter language code specifying the UI display language (e.g. \"en\", \"fr\", \"de\").\n"}},"components/schemas/UISupportedLanguages":{"id":"components/schemas/UISupportedLanguages","kind":"json-schema","title":"UISupportedLanguages","data":{"type":"array","items":{"type":"string"},"example":["en","fr","es","de","it","nl","pt","lt","no","sv","da","ro","cs","fi","pl"],"description":"Array of ISO 639-1 2-letter language codes supported by the device (e.g. \"en\", \"fr\", \"de\").\n"}},"components/schemas/devices_info_comeng":{"id":"components/schemas/devices_info_comeng","kind":"json-schema","title":"Commerce Engine","data":{"title":"Commerce Engine","type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdDevicesInfo"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModelDevicesInfo"}}},"hardware":{"type":"object","properties":{"cpu":{"$ref":"#/components/schemas/HardwareCPU"},"ramMb":{"$ref":"#/components/schemas/HardwareRamMb"},"storageMbTotal":{"$ref":"#/components/schemas/HardwareStorageMbTotal"},"storageMbFree":{"$ref":"#/components/schemas/HardwareStorageMbFree"},"storageMbUsed":{"$ref":"#/components/schemas/HardwareStorageMbUsed"},"batteryLevel":{"$ref":"#/components/schemas/HardwareBatteryLevel"}}},"firmware":{"type":"object","properties":{"firmwareVersion":{"$ref":"#/components/schemas/FirmwareFirmwareVersion"},"androidVersion":{"$ref":"#/components/schemas/FirmwareAndroidVersion"},"emvKernelVersion":{"$ref":"#/components/schemas/FirmwareEMVKernelVersion"},"ctlsKernelVersion":{"$ref":"#/components/schemas/FirmwareCTLSKernelVersion"}}},"security":{"type":"object","properties":{"p2peVersion":{"$ref":"#/components/schemas/SecurityP2PEVersion"},"pciHardwareVersion":{"$ref":"#/components/schemas/SecurityPCIHardwareVersion"},"pciFirmwareVersion":{"$ref":"#/components/schemas/SecurityPCIFirmwareVersion"}}},"applications":{"$ref":"#/components/schemas/ApplicationsArray"},"connectivity":{"type":"object","properties":{"activeInterface":{"$ref":"#/components/schemas/ConnectivityActiveInterface"},"ip":{"$ref":"#/components/schemas/ConnectivityIP"},"gateway":{"$ref":"#/components/schemas/ConnectivityGateway"},"subnetMask":{"$ref":"#/components/schemas/ConnectivitySubnetMask"},"dns1":{"$ref":"#/components/schemas/ConnectivityDNS1"},"dns2":{"$ref":"#/components/schemas/ConnectivityDNS2"},"interfaces":{"$ref":"#/components/schemas/ConnectivityInterfaces"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageResponse"},"supportedLanguages":{"$ref":"#/components/schemas/UISupportedLanguages"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}}},"components/schemas/DeviceInfoArray":{"id":"components/schemas/DeviceInfoArray","kind":"json-schema","title":"DeviceInfoArray","data":{"type":"array","items":{"type":"string"},"description":"An array of details regarding a UTG-controlled device.\n","example":["NUMBER_MSR_SWIPES=1634","NUMBER_BAD_TRACK1_READS=85","NUMBER_BAD_TRACK2_READS=395","NUMBER_BAD_TRACK3_READS=337","NUMBER_SIGNATURE_TOTALS=0000","NUMBER_REBOOTS=0760","TERMINAL_NAME=iPP350","UNIT_SERIAL_NUMBER=2013016PT012622","OS_VERSION=5220","APPLICATION_VERSION=2156","SECURITY_LIBRARY_VERSION=0415","TDA_VERSION=1603","EFTL_VERSION=0000","EFTP_VERSION=0000","RAM_SIZE=8628","FLASH_SIZE=111064","MANUFACTURE_DATE=2013-01-16","CPEM_TYPE=1","PEN_STATUS=UNSUPPORTED_DEVICE","APPLICATION_NAME=Retail Base","MANUFACTURE_ID=INGNAR","DIGITIZER_VERSION=0000","MANUFACTURER_SERIAL_NUMBER=71429877","DUKPT0=F876543210016F8000F7","DUKPT4=FFFF49003614954000B9"]}},"components/schemas/devices_info_utgingenico":{"id":"components/schemas/devices_info_utgingenico","kind":"json-schema","title":"UTG Ingenico","data":{"title":"UTG Ingenico","type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"info":{"$ref":"#/components/schemas/DeviceInfoArray"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"info":["NUMBER_MSR_SWIPES=1634","NUMBER_BAD_TRACK1_READS=85","NUMBER_BAD_TRACK2_READS=395","NUMBER_BAD_TRACK3_READS=337","NUMBER_SIGNATURE_TOTALS=0000","NUMBER_REBOOTS=0760","TERMINAL_NAME=iPP350","UNIT_SERIAL_NUMBER=2013016PT012622","OS_VERSION=5220","APPLICATION_VERSION=2156","SECURITY_LIBRARY_VERSION=0415","TDA_VERSION=1603","EFTL_VERSION=0000","EFTP_VERSION=0000","RAM_SIZE=8628","FLASH_SIZE=111064","MANUFACTURE_DATE=2013-01-16","CPEM_TYPE=1","PEN_STATUS=UNSUPPORTED_DEVICE","APPLICATION_NAME=Retail Base","MANUFACTURE_ID=INGNAR","DIGITIZER_VERSION=0000","MANUFACTURER_SERIAL_NUMBER=71429877","DUKPT0=F876543210016F8000F7","DUKPT4=FFFF49003614954000B9"],"terminalId":"1742"},"server":{"name":"U2API01CE"}}]}}},"components/schemas/devices_info_utgverifone":{"id":"components/schemas/devices_info_utgverifone","kind":"json-schema","title":"UTG Verifone","data":{"title":"UTG Verifone","type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"info":{"$ref":"#/components/schemas/DeviceInfoArray"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"info":["APPLICATION_VERSION=4.9.2-20170530","XPI_VERSION=0052.00v-20170530","XPI_KERNEL_VERSION=000270000","OS_VERSION=MX200001/RFS30250600/","PACKAGES_INSTALLED=alsa-lib:1.0.0; busybox:1.2.6.2","GUI_MANAGER_VERSION=3.25","UNIT_ID=288-728-276/12000000","UNIT_MODEL=MX915","RFIDFW_VERSION=VOS-CTLS-4.02.04A","DEVICE_TIME=20210416180022","SECURE_PACKETS=aes","DUKPT0=FFFF5B0999000220024F","ADE0=FFFF4950720008800875"],"terminalId":"1742"},"server":{"name":"U2API01CE"}}]}}},"components/schemas/devices_reset_comengdevice":{"id":"components/schemas/devices_reset_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00"}}},"components/schemas/devices_reset_utgdevice":{"id":"components/schemas/devices_reset_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}}}}},"components/schemas/UISuppressAll":{"id":"components/schemas/UISuppressAll","kind":"json-schema","title":"UISuppressAll","data":{"type":"boolean","example":"true","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the terminal suppresses all UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example use case: capturing employee/badge swipe data without displaying Commerce Engine UI."},"children":[]}]}]}]}},"components/schemas/VolumeSuppressBeeper":{"id":"components/schemas/VolumeSuppressBeeper","kind":"json-schema","title":"VolumeSuppressBeeper","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the terminal suppresses all audible beeper output during the card-read window only — Contactless tap confirmation, MSR swipe, error/decline tones."},"children":[]}]}]}]}},"components/schemas/Volume":{"id":"components/schemas/Volume","kind":"json-schema","title":"Volume","data":{"type":"object","properties":{"suppressBeeper":{"$ref":"#/components/schemas/VolumeSuppressBeeper"}}}},"components/schemas/Timeout":{"id":"components/schemas/Timeout","kind":"json-schema","title":"Timeout","data":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field that will set the timeout value in seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will set an indefinite timeout that can only be cancelled by sending a /devices/reset request. Commerce Engine will use its default value if not sent."},"children":[]}]}]}]}},"components/schemas/devices_promptcardread_comengdevice":{"id":"components/schemas/devices_promptcardread_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","required":["dateTime"],"properties":{"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"},"displayText":{"$ref":"#/components/schemas/DeviceDisplayText"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressAll":{"$ref":"#/components/schemas/UISuppressAll"}}},"volume":{"$ref":"#/components/schemas/Volume"},"timeout":{"$ref":"#/components/schemas/Timeout"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00"}}},"components/schemas/devices_promptcardread_comengcloud":{"id":"components/schemas/devices_promptcardread_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","required":["dateTime","device"],"properties":{"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"},"displayText":{"$ref":"#/components/schemas/DeviceDisplayText"}}},"ui":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/UILanguageRequest"},"mode":{"$ref":"#/components/schemas/UIMode"},"suppressAll":{"$ref":"#/components/schemas/UISuppressAll"}}},"volume":{"$ref":"#/components/schemas/Volume"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00","device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"}}}},"components/schemas/devices_promptcardread_utgdevice":{"id":"components/schemas/devices_promptcardread_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}}}}},"components/schemas/CardEntryModeResponseTrackOnly":{"id":"components/schemas/CardEntryModeResponseTrackOnly","kind":"json-schema","title":"CardEntryModeResponseTrackOnly","data":{"type":"string","minLength":1,"maxLength":1,"enum":["1","2"],"example":"2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to capture a payment card in an authorization/sale request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track 1 Only or Dual Track (Track 1 & 2)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track 2 Only"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PEFormat":{"id":"components/schemas/P2PEFormat","kind":"json-schema","title":"P2PEFormat","data":{"type":"string","minLength":2,"maxLength":2,"enum":["01","02","03","04","05"],"example":"01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classifies the type of payment device being used for P2PE."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDTech Enhanced Encryption format USB HID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ingenico format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VeriFone format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift4 TDES DUKPT format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES 128 or 256"},"children":[]}]}]}]}]}]}]}},"components/schemas/P2PE":{"id":"components/schemas/P2PE","kind":"json-schema","title":"P2PE","data":{"type":"object","required":["data","format"],"properties":{"data":{"$ref":"#/components/schemas/P2PEData"},"format":{"$ref":"#/components/schemas/P2PEFormat"},"ksn":{"$ref":"#/components/schemas/P2PEKSN"}}}},"components/schemas/DevicePromptInputIndex":{"id":"components/schemas/DevicePromptInputIndex","kind":"json-schema","title":"DevicePromptInputIndex","data":{"type":"string","maxLength":3,"example":"005","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies a value to be collected from a consumer using a UTG-controlled PIN pad."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return Format"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"001"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Security Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"002"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"003"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"004"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Social Security Number (SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric, no formatting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"005"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last 4 of SSN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"006"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of Birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MM/DD/YYYY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"007"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual Income"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric, no formatting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"008"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Home Phone Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric, no formatting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"009"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Phone Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric, no formatting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"010"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Address (Requires Touchscreen)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"011"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Driver's ID (Requires Touchscreen)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"012"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric"},"children":[]}]}]}]}]}]}]}},"components/schemas/DevicePromptInputResult":{"id":"components/schemas/DevicePromptInputResult","kind":"json-schema","title":"DevicePromptInputResult","data":{"type":"string","maxLength":4096,"readOnly":true,"example":"981280913","description":"This field contains the value collected from a consumer using a UTG-controlled PIN pad.\n"}},"components/schemas/DevicePromptInput":{"id":"components/schemas/DevicePromptInput","kind":"json-schema","title":"DevicePromptInput","data":{"type":"object","required":["index"],"properties":{"index":{"$ref":"#/components/schemas/DevicePromptInputIndex"},"result":{"$ref":"#/components/schemas/DevicePromptInputResult"}}}},"components/schemas/devices_promptinput_comengdevice":{"id":"components/schemas/devices_promptinput_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["promptInput"],"properties":{"promptInput":{"$ref":"#/components/schemas/DevicePromptInput"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/devices_promptinput_comengcloud":{"id":"components/schemas/devices_promptinput_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber","promptInput"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"promptInput":{"$ref":"#/components/schemas/DevicePromptInput"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/devices_promptinput_utgdevice":{"id":"components/schemas/devices_promptinput_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId","promptInput"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"},"promptInput":{"$ref":"#/components/schemas/DevicePromptInput"}}}}}},"components/schemas/DeviceFormButtonArray":{"id":"components/schemas/DeviceFormButtonArray","kind":"json-schema","title":"DeviceFormButtonArray","data":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["id","text"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID value used to identify which button is pressed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the button the user selected is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result.form.buttonSelected.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response field."},"children":[]}]}]}]},"text":{"type":"string","maxLength":114,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text to display on the button."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text of the button the user selected is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result.form.buttonSelected.text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response field."},"children":[]}]}]}]}}},"example":[{"id":"1","text":"Accept"},{"id":"2","text":"Decline"}],"description":"Array of 1 - 4 buttons to be displayed on the device.\n"}},"components/schemas/DeviceFormTimeout":{"id":"components/schemas/DeviceFormTimeout","kind":"json-schema","title":"DeviceFormTimeout","data":{"type":"number","minimum":1,"maximum":600,"example":120,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the custom form will timeout. Defaults to 120 seconds if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not sent in the request."},"children":[]}]}]}]}},"components/schemas/DeviceProcessFormTypeMultiButtonScrollingText":{"id":"components/schemas/DeviceProcessFormTypeMultiButtonScrollingText","kind":"json-schema","title":"Multi Button Scrolling Text","data":{"title":"Multi Button Scrolling Text","required":["type","buttons"],"properties":{"type":{"type":"string","enum":["multiButtonScrollingText"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays a form with header text, subheader text, scrolling body text and up to 4 buttons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using this custom form type at least one of the following fields must also be included in the request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.header"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.subHeader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.text"},"children":[]}]}]}]}]},"header":{"$ref":"#/components/schemas/DeviceFormHeader"},"subHeader":{"$ref":"#/components/schemas/DeviceFormSubHeader"},"text":{"$ref":"#/components/schemas/DeviceFormText"},"buttons":{"$ref":"#/components/schemas/DeviceFormButtonArray"},"timeout":{"$ref":"#/components/schemas/DeviceFormTimeout"}}}},"components/schemas/DeviceProcessFormTypeMessage":{"id":"components/schemas/DeviceProcessFormTypeMessage","kind":"json-schema","title":"Message","data":{"title":"Message","type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["message"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays a message based form with header text, subheader text, and body text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using this custom form type at least one of the following fields must also be included in the request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.header"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.subHeader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.text"},"children":[]}]}]}]}]},"header":{"$ref":"#/components/schemas/DeviceFormHeader"},"subHeader":{"$ref":"#/components/schemas/DeviceFormSubHeader"},"text":{"$ref":"#/components/schemas/DeviceFormText"},"timeout":{"$ref":"#/components/schemas/DeviceFormTimeout"}}}},"components/schemas/DeviceFormQRCode":{"id":"components/schemas/DeviceFormQRCode","kind":"json-schema","title":"DeviceFormQRCode","data":{"type":"object","properties":{"value":{"type":"string","minLength":1,"maxLength":1024,"example":"www.shift4.com","description":"Contains the QR Code URL string. This value will be converted to a QR code and displayed on the device.\n"}}}},"components/schemas/DeviceFormFooter":{"id":"components/schemas/DeviceFormFooter","kind":"json-schema","title":"DeviceFormFooter","data":{"type":"object","properties":{"value":{"type":"string","maxLength":100,"example":"Footer text goes here","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Footer text. Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\r\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a new line."},"children":[]}]}]}]}}}},"components/schemas/DeviceProcessFormTypeQRDisplay":{"id":"components/schemas/DeviceProcessFormTypeQRDisplay","kind":"json-schema","title":"QR Display","data":{"title":"QR Display","type":"object","required":["type","qrCode"],"properties":{"type":{"type":"string","enum":["qrDisplay"],"description":"Displays a QR code based form with header text, a QR code image and footer text. \n"},"qrCode":{"$ref":"#/components/schemas/DeviceFormQRCode"},"header":{"$ref":"#/components/schemas/DeviceFormHeader"},"footer":{"$ref":"#/components/schemas/DeviceFormFooter"},"timeout":{"$ref":"#/components/schemas/DeviceFormTimeout"}}}},"components/schemas/devices_processform_comengdevice":{"id":"components/schemas/devices_processform_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","required":["dateTime","form"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"form":{"oneOf":[{"$ref":"#/components/schemas/DeviceProcessFormTypeMultiButtonScrollingText"},{"$ref":"#/components/schemas/DeviceProcessFormTypeMessage"},{"$ref":"#/components/schemas/DeviceProcessFormTypeQRDisplay"}]},"device":{"type":"object","properties":{"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/devices_processform_comengcloud":{"id":"components/schemas/devices_processform_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","required":["dateTime","device","form"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["cloud","manufacturer","serialNumber"],"properties":{"cloud":{"$ref":"#/components/schemas/DeviceCloud"},"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"nextStep":{"$ref":"#/components/schemas/DeviceNextStep"}}},"form":{"oneOf":[{"$ref":"#/components/schemas/DeviceProcessFormTypeMultiButtonScrollingText"},{"$ref":"#/components/schemas/DeviceProcessFormTypeMessage"},{"$ref":"#/components/schemas/DeviceProcessFormTypeQRDisplay"}]},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/DeviceFormName":{"id":"components/schemas/DeviceFormName","kind":"json-schema","title":"DeviceFormName","data":{"type":"string","maxLength":12,"example":"PF2","description":"Specifies a 12-character, alphanumeric string containing the form name to display on a UTG-controlled PIN pad. The file extension should not be included in the value.\n"}},"components/schemas/DeviceFormItems":{"id":"components/schemas/DeviceFormItems","kind":"json-schema","title":"DeviceFormItems","data":{"type":"object","writeOnly":true,"properties":{"key":{"type":"string","writeOnly":true,"maxLength":5,"example":"1","description":"A five-character, alphanumeric string containing the ID of the field which you want to display a custom value on.\n"},"value":{"type":"string","writeOnly":true,"maxLength":200,"example":"John Smith","description":"The value that should be displayed in the field specified by the key.\n"}}}},"components/schemas/DeviceFormItemsArray":{"id":"components/schemas/DeviceFormItemsArray","kind":"json-schema","title":"DeviceFormItemsArray","data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceFormItems"},"example":[{"key":1,"value":"John Smith"},{"key":2,"value":"123 Open St"}],"description":"An array of key/value pairs used to populate fields on the custom form\n"}},"components/schemas/DeviceFormUTG":{"id":"components/schemas/DeviceFormUTG","kind":"json-schema","title":"DeviceFormUTG","data":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/DeviceFormName"},"items":{"$ref":"#/components/schemas/DeviceFormItemsArray"}}}},"components/schemas/devices_processform_utgdevice":{"id":"components/schemas/devices_processform_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId","form"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"},"form":{"$ref":"#/components/schemas/DeviceFormUTG"}}}}}},"components/schemas/DeviceFormResult":{"id":"components/schemas/DeviceFormResult","kind":"json-schema","title":"DeviceFormResult","data":{"type":"string","maxLength":5,"readOnly":true,"example":"87","description":"A five-character, alphanumeric string containing the ID of the button pressed by the consumer on a UTG-controlled PIN pad.\n"}},"components/schemas/DeviceFormResponse":{"id":"components/schemas/DeviceFormResponse","kind":"json-schema","title":"DeviceFormResponse","data":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/DeviceFormName"},"result":{"$ref":"#/components/schemas/DeviceFormResult"}}}},"components/schemas/devices_processform_response_utg":{"id":"components/schemas/devices_processform_response_utg","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"form":{"$ref":"#/components/schemas/DeviceFormResponse"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}}},"components/schemas/devices_processform_response_comeng_message":{"id":"components/schemas/devices_processform_response_comeng_message","kind":"json-schema","title":"Commerce Engine Form Type message","data":{"title":"Commerce Engine Form Type message","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"server":{"$ref":"#/components/schemas/Server"}}}}}}},"components/schemas/devices_processform_response_comeng_multiButtonScrollingText":{"id":"components/schemas/devices_processform_response_comeng_multiButtonScrollingText","kind":"json-schema","title":"Commerce Engine Form Type multiButtonScrollingText","data":{"title":"Commerce Engine Form Type multiButtonScrollingText","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"server":{"$ref":"#/components/schemas/Server"},"form":{"type":"object","properties":{"buttonSelected":{"type":"object","properties":{"id":{"type":"string","example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID value identifying which button was selected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matches the value recieved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.buttons.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field."},"children":[]}]}]}]},"text":{"type":"string","maxLength":114,"example":"Accepted","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Button text value of the button that was selected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matches the value recieved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form.buttons.text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field."},"children":[]}]}]}]}}}}}}}}}}},"components/schemas/PrintFormat":{"id":"components/schemas/PrintFormat","kind":"json-schema","title":"PrintFormat","data":{"type":"string","enum":["structured"],"example":"structured","description":"Specifies the receipt printing format being used.\n"}},"components/schemas/PrintFormatVersion":{"id":"components/schemas/PrintFormatVersion","kind":"json-schema","title":"PrintFormatVersion","data":{"type":"string","enum":["1.0"],"example":"1.0","description":"Specifies the receipt printing format version being used.\n"}},"components/schemas/PrintDataAlignment":{"id":"components/schemas/PrintDataAlignment","kind":"json-schema","title":"PrintDataAlignment","data":{"type":"string","enum":["center","left","right"],"example":"center","description":"Specifies where the print element should be aligned\n"}},"components/schemas/PrintDataBMP":{"id":"components/schemas/PrintDataBMP","kind":"json-schema","title":"BMP Image","data":{"title":"BMP Image","type":"object","description":"Used to print images, such as a company logo in BPM format. Can also be used to print the full receipt if the entire receipt data is formatted into a BMP image.\n","required":["type","alignment","value"],"properties":{"type":{"type":"string","enum":["bmp"]},"alignment":{"$ref":"#/components/schemas/PrintDataAlignment"},"value":{"type":"string","description":"Base64 encoded BMP image data\n"}}}},"components/schemas/PrintDataArray":{"id":"components/schemas/PrintDataArray","kind":"json-schema","title":"PrintDataArray","data":{"type":"array","items":{"$ref":"#/components/schemas/PrintDataBMP"},"description":"Array containing the value to print.\n","example":[{"type":"bmp","alignment":"center","value":"Qk1+BgAAAAAAAD4AAAAoAAAAZAAAAGQAAAABAAEAAAAAAEAGAAAjLgAAIy4AAAAAAAAAAAAAAAAAAP///wD////////////////wAAAA////////D///////8AAAAP/////3AAAP//////AAAAD/////8AAAAN/////wAAAA/////4AAAAAf////8AAAAP////4AAAAAB/////AAAAD////wAAAAAAD////wAAAA////wAAAAAAAf///8AAAAP///4AAAAAAAB////AAAAD///4AAAAAAAAH///wAAAA///8AAAAAAAAA///8AAAAP//8AAAAAAAAAD///AAAAD//+AAAAAAAAAAf//wAAAA///AAAAAAAAAAD//8AAAAP//gAAAAAAAAAAf//AAAAD//wAAAAAAAAAAD//wAAAA//4AAAAAAAAAAAf/8AAAAP/8AAAAAAAAAAAD//AAAAD/+AAAAAAAAAAAAf/wAAAA//AAAAAAAAAAAAD/8AAAAP/gAAAAAAAAAAAAf/AAAAD/4AAAAAAD/AAAAH/wAAAA/8AAAAAAA/wAAAA/8AAAAP+AAAAAAAP8AAAAH/AAAAD/gAAAAAAD/AAAAB/wAAAA/wAAAAAAA/wAAAAP8AAAAP4AAAAAAAP8AAAAD/AAAAD+AAAAAAAD/AAAAAfwAAAA/AAAAAAAA/wAAAAD8AAAAPwAAAAAAAP8AAAAA/AAAAD8AAAAAAAD/AAAAAPwAAAA+AAAAAAAA/wAAAAB8AAAAPgAAAAAAAP8AAAAAfAAAADwAAAAAAAD/AAAAADwAAAA8AAAAAAAA/wAAAAA8AAAAPAAAAAAAAP8AAAAAPAAAADgAAAAAAAD/AAAAABwAAAA4AAAD/////wAAAAAcAAAAOAAAA/////8AAAAAHAAAADgAAAf/////AAAAABwAAAAgAAAH/////wAAAAAMAAAAMAAAB/////8AAAAADAAAADAAAAf/////AAAAAAwAAAAwAAAD/////wAAAAAMAAAAMAAAAf9///8AAAAADAAAADAAAAD/AAD/AAAAAAwAAAAwAAAA/4AA/wAAAAAMAAAAIAAAAH/AAP8AAAAADAAAAAAAAAA/wAD/AAAAAAQAAAAAAAAAH+AA/wAAAAAEAAAAAAAAAB/wAP8AAAAABAAAACAAAAAP+AD/AAAAAAQAAAAgAAAAB/wA/wAAAAAMAAAAMAAAAAP8AP8AAAAADAAAADAAAAAB/gD/AAAAAAwAAAAwAAAAAf8A/wAAAAAMAAAAMAAAAAD/gP8AAAAADAAAADAAAAAAf4D/AAAAAAwAAAAwAAAAAD/A/wAAAAAMAAAAIAAAAAA/4P8AAAAADAAAADgAAAAAH/D/AAAAABwAAAA4AAAAAA/4/wAAAAAcAAAAOAAAAAAH+P8AAAAAHAAAADgAAAAAA/z/AAAAABwAAAA8AAAAAAP+/wAAAAA8AAAAPAAAAAAB//8AAAAAPAAAADwAAAAAAP//AAAAADwAAAA+AAAAAAB//wAAAAB8AAAAPgAAAAAAf/8AAAAAfAAAAD4AAAAAAD//AAAAAPwAAAA/AAAAAAAf/wAAAAD8AAAAPwAAAAAAD/8AAAAA/AAAAD+AAAAAAAf/AAAAAfwAAAA/gAAAAAAH/wAAAAH8AAAAP8AAAAAAA/8AAAAD/AAAAD/gAAAAAAH/AAAAB/wAAAA/4AAAAAAA/wAAAAf8AAAAP/AAAAAAAP8AAAAP/AAAAD/4AAAAAAB/AAAAH/wAAAA/+AAAAAAAFAAAAB/8AAAAP/wAAAAAAAAAAAA//AAAAD/+AAAAAAAAAAAAf/wAAAA//wAAAAAAAAAAAP/8AAAAP/+AAAAAAAAAAAH//AAAAD//wAAAAAAAAAAD//wAAAA//+AAAAAAAAAAB//8AAAAP//wAAAAAAAAAA///AAAAD//+AAAAAAAAAAf//wAAAA///wAAAAAAAAAP//8AAAAP///AAAAAAAAAP///AAAAD///4AAAAAAAAH///wAAAA////gAAAAAAAH///8AAAAP///8AAAAAAAD////AAAAD////wAAAAAAD////wAAAA/////AAAAAAH////8AAAAP////+AAAAAH/////AAAAD/////8AAAAP/////wAAAA//////8AAA7/////8AAAAP///////gf///////AAAAD///////+f///////wAAAA"}]}},"components/schemas/Print":{"id":"components/schemas/Print","kind":"json-schema","title":"Print","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object contain elements for printing. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/printing-receipts#supporting-built-in-receipt-printing-capability-on-devices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supporting Built-In Receipt Printing Capability on Devices"},"children":[]}]}]}]}],"required":["format","version","data"],"properties":{"format":{"$ref":"#/components/schemas/PrintFormat"},"version":{"$ref":"#/components/schemas/PrintFormatVersion"},"data":{"$ref":"#/components/schemas/PrintDataArray"}}}},"components/schemas/devices_print_comengdevice_structured":{"id":"components/schemas/devices_print_comengdevice_structured","kind":"json-schema","title":"Commerce Engine For On Premise - Structured","data":{"title":"Commerce Engine For On Premise - Structured","type":"object","required":["dateTime","print"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"print":{"$ref":"#/components/schemas/Print"}}}},"components/schemas/devices_print_comengcloud_structured":{"id":"components/schemas/devices_print_comengcloud_structured","kind":"json-schema","title":"Commerce Engine For Cloud - Structured","data":{"title":"Commerce Engine For Cloud - Structured","type":"object","required":["dateTime","device","print"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"print":{"$ref":"#/components/schemas/Print"}}}},"components/schemas/ReceiptDevicesPrint":{"id":"components/schemas/ReceiptDevicesPrint","kind":"json-schema","title":"ReceiptDevicesPrint","data":{"type":"object","required":["key","printValue"],"properties":{"key":{"type":"string","maxLength":100,"example":"print","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be sent as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"print"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"printValue":{"type":"string","example":"Text to print goes here","description":"The text that you want to print on the receipt.\n"}}}},"components/schemas/ReceiptArrayDevicesPrint":{"id":"components/schemas/ReceiptArrayDevicesPrint","kind":"json-schema","title":"ReceiptArrayDevicesPrint","data":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptDevicesPrint"},"example":[{"key":"print","printValue":"Text to print goes here"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing the receipt text data to print. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/core-concepts/printing-receipts#supporting-built-in-receipt-printing-capability-on-devices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supporting Built-In Receipt Printing Capability on Devices"},"children":[]}]}]}]}]}},"components/schemas/devices_print_comengdevice_legacy":{"id":"components/schemas/devices_print_comengdevice_legacy","kind":"json-schema","title":"Commerce Engine On Premise - Legacy","data":{"title":"Commerce Engine On Premise - Legacy","type":"object","required":["dateTime","receipt"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"receipt":{"$ref":"#/components/schemas/ReceiptArrayDevicesPrint"}}}},"components/schemas/devices_print_comengcloud_legacy":{"id":"components/schemas/devices_print_comengcloud_legacy","kind":"json-schema","title":"Commerce Engine Cloud - Legacy","data":{"title":"Commerce Engine Cloud - Legacy","type":"object","required":["dateTime","device","receipt"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"receipt":{"$ref":"#/components/schemas/ReceiptArrayDevicesPrint"}}}},"components/schemas/devices_print_utgdevice":{"id":"components/schemas/devices_print_utgdevice","kind":"json-schema","title":"UTG Controlled Device","data":{"title":"UTG Controlled Device","type":"object","required":["dateTime","device","receipt"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceOnlyTID"},"receipt":{"$ref":"#/components/schemas/ReceiptArrayDevicesPrint"}}}},"components/schemas/devices_getstatus_comengdevice":{"id":"components/schemas/devices_getstatus_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00"}}},"components/schemas/devices_getstatus_comengcloud":{"id":"components/schemas/devices_getstatus_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"}},"example":{"dateTime":"2024-05-21T09:18:23.283-07:00","device":{"cloud":true,"manufacturer":"PAX","serialNumber":"1170301234"}}}},"components/schemas/CloudRegistered":{"id":"components/schemas/CloudRegistered","kind":"json-schema","title":"CloudRegistered","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the device is registerd with the cloud service."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is successfully registered with the cloud service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is not registered with the cloud service"},"children":[]}]}]}]}]}]}]}},"components/schemas/CloudConnected":{"id":"components/schemas/CloudConnected","kind":"json-schema","title":"CloudConnected","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the device is successfully connected to the cloud service."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is successfully connected to the cloud service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is unable to connect to the cloud service"},"children":[]}]}]}]}]}]}]}},"components/schemas/OfflineMode":{"id":"components/schemas/OfflineMode","kind":"json-schema","title":"OfflineMode","data":{"type":"string","enum":["Y","N","U"],"example":"N","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the device is in offline mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is offline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device is online"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline status is unknown. For example, when sending the Get Device Status command via Commerce Engine For Cloud and the device is not connected."},"children":[]}]}]}]}]}]}]}},"components/schemas/AmountPromptTip":{"id":"components/schemas/AmountPromptTip","kind":"json-schema","title":"AmountPromptTip","data":{"type":"object","required":["total"],"properties":{"total":{"type":"number","maxLength":14,"example":100,"description":"The total transaction amount. Used as the seed for calculating the tip amount when using preset percentages.\n"},"tipBasis":{"$ref":"#/components/schemas/AmountTipBasis"}}}},"components/schemas/devices_prompttip_comengdevice":{"id":"components/schemas/devices_prompttip_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime","amount","tip"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountPromptTip"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/devices_prompttip_comengcloud":{"id":"components/schemas/devices_prompttip_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","amount","tip"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountPromptTip"},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"tip":{"$ref":"#/components/schemas/TipObject"},"ui":{"$ref":"#/components/schemas/UIRequest"}}}},"components/schemas/AmountTipResponse":{"id":"components/schemas/AmountTipResponse","kind":"json-schema","title":"AmountTipResponse","data":{"type":"number","maxLength":14,"example":20,"description":"The tip amount of the transaction.\n"}},"components/schemas/TipSelectedOption":{"id":"components/schemas/TipSelectedOption","kind":"json-schema","title":"TipSelectedOption","data":{"type":"string","enum":["preset1","preset2","preset3","other","notip"],"example":"preset2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tip option selected by the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preset1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder selected the preset 1 button"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preset2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder selected the preset 2 button"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preset3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder selected the preset 3 button"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder selected the other button"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder selected the cash/no tip button"},"children":[]}]}]}]}]}]}]}},"components/schemas/ServerNameComEng":{"id":"components/schemas/ServerNameComEng","kind":"json-schema","title":"ServerNameComEng","data":{"type":"string","maxLength":50,"example":"Commerce Engine K","description":"The name of the server that processed the request.\n"}},"components/schemas/ServerComEng":{"id":"components/schemas/ServerComEng","kind":"json-schema","title":"ServerComEng","data":{"type":"object","readOnly":true,"properties":{"name":{"$ref":"#/components/schemas/ServerNameComEng"}}}},"components/schemas/BatchInclusiveResponse":{"id":"components/schemas/BatchInclusiveResponse","kind":"json-schema","title":"BatchInclusiveResponse","data":{"type":"string","minLength":1,"maxLength":1,"example":"N","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not the batch includes transactions for every day leading up to the business date."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch includes transactions for every day leading up to the specified business date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch includes transactions for only the specified business date"},"children":[]}]}]}]}]}]}]}},"components/schemas/BatchNetAmountResponse":{"id":"components/schemas/BatchNetAmountResponse","kind":"json-schema","title":"BatchNetAmountResponse","data":{"type":"number","maxLength":14,"example":5601.78,"description":"The net amount in the batch (saleAmount MINUS refundAmount)\n"}},"components/schemas/BatchNetCountResponse":{"id":"components/schemas/BatchNetCountResponse","kind":"json-schema","title":"BatchNetCountResponse","data":{"type":"integer","example":187,"description":"The net transaction count in the batch (saleCount PLUS refundCount)\n"}},"components/schemas/BatchRefundAmount":{"id":"components/schemas/BatchRefundAmount","kind":"json-schema","title":"BatchRefundAmount","data":{"type":"number","maxLength":14,"readOnly":true,"example":100,"description":"The total amount of all refunds in the batch\n"}},"components/schemas/BatchRefundCount":{"id":"components/schemas/BatchRefundCount","kind":"json-schema","title":"BatchRefundCount","data":{"type":"integer","readOnly":true,"example":1,"description":"The count of all refunds in the batch\n"}},"components/schemas/BatchSaleAmount":{"id":"components/schemas/BatchSaleAmount","kind":"json-schema","title":"BatchSaleAmount","data":{"type":"number","maxLength":14,"readOnly":true,"example":5701.78,"description":"The total amount of all sales in the batch\n"}},"components/schemas/BatchSaleCount":{"id":"components/schemas/BatchSaleCount","kind":"json-schema","title":"BatchSaleCount","data":{"type":"integer","readOnly":true,"example":186,"description":"The count of all sales in the batch\n"}},"components/schemas/BatchResponseNoProcessors":{"id":"components/schemas/BatchResponseNoProcessors","kind":"json-schema","title":"BatchResponseNoProcessors","data":{"type":"object","properties":{"inclusive":{"$ref":"#/components/schemas/BatchInclusiveResponse"},"netAmount":{"$ref":"#/components/schemas/BatchNetAmountResponse"},"netCount":{"$ref":"#/components/schemas/BatchNetCountResponse"},"refundAmount":{"$ref":"#/components/schemas/BatchRefundAmount"},"refundCount":{"$ref":"#/components/schemas/BatchRefundCount"},"saleAmount":{"$ref":"#/components/schemas/BatchSaleAmount"},"saleCount":{"$ref":"#/components/schemas/BatchSaleCount"}}}},"components/schemas/SubmitBatchBusinessDate":{"id":"components/schemas/SubmitBatchBusinessDate","kind":"json-schema","title":"SubmitBatchBusinessDate","data":{"type":"string","format":"ISO 8601","minLength":10,"example":"2021-04-15T00:00:00.000-07:00","description":"The business date you want to close a batch for.\n"}},"components/schemas/BatchInclusive":{"id":"components/schemas/BatchInclusive","kind":"json-schema","title":"BatchInclusive","data":{"type":"string","minLength":1,"maxLength":1,"example":"N","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not you want the batch to include transactions for every day leading up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.businessDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch will contain transactions for every day leading up to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch will contain transactions for only the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessDate"},"children":[]}]}]}]}]}]}]}},"components/schemas/BatchNetAmount":{"id":"components/schemas/BatchNetAmount","kind":"json-schema","title":"BatchNetAmount","data":{"type":"number","maxLength":14,"example":5601.78,"description":"The net amount that is expected to be in the batch (sales MINUS refunds).  If this field is sent and the amount does not match, an error will be returned, and the batch will not be closed.\n"}},"components/schemas/BatchNetCount":{"id":"components/schemas/BatchNetCount","kind":"json-schema","title":"BatchNetCount","data":{"type":"integer","example":187,"description":"The net transaction count in the batch (sales PLUS refunds).  If this field is sent and the count does not match, an error will be returned, and the batch will not be closed.\n"}},"components/schemas/Batch":{"id":"components/schemas/Batch","kind":"json-schema","title":"Batch","data":{"type":"object","required":["inclusive"],"properties":{"inclusive":{"$ref":"#/components/schemas/BatchInclusive"},"netAmount":{"$ref":"#/components/schemas/BatchNetAmount"},"netCount":{"$ref":"#/components/schemas/BatchNetCount"}}}},"components/schemas/BatchProcessorsArchivesId":{"id":"components/schemas/BatchProcessorsArchivesId","kind":"json-schema","title":"BatchProcessorsArchivesId","data":{"type":"integer","maxLength":10,"example":"41","description":"The ID that was assigned to the closed batch.  \n"}},"components/schemas/BatchProcessorsProcessor":{"id":"components/schemas/BatchProcessorsProcessor","kind":"json-schema","title":"BatchProcessorsProcessor","data":{"type":"string","readOnly":true,"example":"TSYS","description":"The processor which handled this batch of transactions.\n"}},"components/schemas/BatchProcessorsCurrencyCode":{"id":"components/schemas/BatchProcessorsCurrencyCode","kind":"json-schema","title":"BatchProcessorsCurrencyCode","data":{"type":"string","readOnly":true,"example":"840","description":"The type of currency used for this batch of transactions.\n"}},"components/schemas/BatchProcessors":{"id":"components/schemas/BatchProcessors","kind":"json-schema","title":"BatchProcessors","data":{"type":"object","properties":{"archivesID":{"$ref":"#/components/schemas/BatchProcessorsArchivesId"},"processor":{"$ref":"#/components/schemas/BatchProcessorsProcessor"},"currencyCode":{"$ref":"#/components/schemas/BatchProcessorsCurrencyCode"},"refundAmount":{"$ref":"#/components/schemas/BatchRefundAmount"},"refundCount":{"$ref":"#/components/schemas/BatchRefundCount"},"saleAmount":{"$ref":"#/components/schemas/BatchSaleAmount"},"saleCount":{"$ref":"#/components/schemas/BatchSaleCount"}}}},"components/schemas/BatchProcessorsArray":{"id":"components/schemas/BatchProcessorsArray","kind":"json-schema","title":"BatchProcessorsArray","data":{"type":"array","items":{"$ref":"#/components/schemas/BatchProcessors"}}},"components/schemas/BatchResponse":{"id":"components/schemas/BatchResponse","kind":"json-schema","title":"BatchResponse","data":{"type":"object","properties":{"inclusive":{"$ref":"#/components/schemas/BatchInclusiveResponse"},"netAmount":{"$ref":"#/components/schemas/BatchNetAmountResponse"},"netCount":{"$ref":"#/components/schemas/BatchNetCountResponse"},"refundAmount":{"$ref":"#/components/schemas/BatchRefundAmount"},"refundCount":{"$ref":"#/components/schemas/BatchRefundCount"},"saleAmount":{"$ref":"#/components/schemas/BatchSaleAmount"},"saleCount":{"$ref":"#/components/schemas/BatchSaleCount"},"processors":{"$ref":"#/components/schemas/BatchProcessorsArray"}}}},"components/schemas/TransactionSaleFlagQR":{"id":"components/schemas/TransactionSaleFlagQR","kind":"json-schema","title":"TransactionSaleFlagQR","data":{"type":"string","maxLength":1,"example":"S","enum":["A","S"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a transaction is a sale (‘S’) or authorization (‘A’).  Value sent in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/qr-payments/getqrcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get QR Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/qr-payments/getqrdetails"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get QR Details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}]}},"components/schemas/QRCodeResponseValue":{"id":"components/schemas/QRCodeResponseValue","kind":"json-schema","title":"QRCodeResponseValue","data":{"type":"string","example":"https://pay.skytab.com/A3KD42J","maxLength":1024,"description":"Contains the QR Code URL string. This string can be converted to a QR code for printing on receipts or displaying on devices.\n"}},"components/schemas/QRCodeResponse":{"id":"components/schemas/QRCodeResponse","kind":"json-schema","title":"QRCodeResponse","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/QRCodeResponseValue"}}}},"components/schemas/QRCodeRequestValue":{"id":"components/schemas/QRCodeRequestValue","kind":"json-schema","title":"QRCodeRequestValue","data":{"type":"string","example":"https://pay.skytab.com/A3KD42J","maxLength":1024,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the QR Code URL string. This must match the value received in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/qr-payments/getqrcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get QR Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}]}},"components/schemas/QRCodeRequest":{"id":"components/schemas/QRCodeRequest","kind":"json-schema","title":"QRCodeRequest","data":{"type":"object","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/QRCodeRequestValue"}}}},"components/schemas/QRPayConfigSplitEnabled":{"id":"components/schemas/QRPayConfigSplitEnabled","kind":"json-schema","title":"QRPayConfigSplitEnabled","data":{"type":"string","minLength":1,"maxLength":1,"enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether split check processing is enabled or disabled for QR Code Payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split check proessing is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split check proessing is disabled."},"children":[]}]}]}]}]}]}]}},"components/schemas/QRPayConfigTipEnabled":{"id":"components/schemas/QRPayConfigTipEnabled","kind":"json-schema","title":"QRPayConfigTipEnabled","data":{"type":"string","minLength":1,"maxLength":1,"enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether tip prompting is enabled or disabled for the merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip prompting is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip prompting is disabled."},"children":[]}]}]}]}]}]}]}},"components/schemas/QRPayConfigTipPresetsArray":{"id":"components/schemas/QRPayConfigTipPresetsArray","kind":"json-schema","title":"QRPayConfigTipPresetsArray","data":{"type":"array","items":{"type":"string"},"example":["15","18","20"],"readOnly":true,"description":"Tip preset percentages configured by the merchant.\n"}},"components/schemas/QRPayConfig":{"id":"components/schemas/QRPayConfig","kind":"json-schema","title":"QRPayConfig","data":{"type":"object","readOnly":true,"properties":{"splitEnabled":{"$ref":"#/components/schemas/QRPayConfigSplitEnabled"},"tipEnabled":{"$ref":"#/components/schemas/QRPayConfigTipEnabled"},"tipPresets":{"$ref":"#/components/schemas/QRPayConfigTipPresetsArray"}}}},"components/schemas/TransactionResponseCodeQRPaymentStatus":{"id":"components/schemas/TransactionResponseCodeQRPaymentStatus","kind":"json-schema","title":"TransactionResponseCodeQRPaymentStatus","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"V","enum":["A","C","T"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating that the status of the QR code payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The QR Payment was processed and approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The QR Payment was cancelled. The QR code had not been used for payment or the payment was not successful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The QR Payment was cancelled. The QR code had already been used for payment and was approved. The approval was reversed."},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionResponseCodeQRCancel":{"id":"components/schemas/TransactionResponseCodeQRCancel","kind":"json-schema","title":"TransactionResponseCodeQRCancel","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"C","enum":["C","T"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating that the QR code was cancelled and if it was reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The QR Payment was cancelled. The QR code had not been used for payment or the payment was not successful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The QR Payment was cancelled. The QR code had already been used for payment and was approved. The approval was reversed."},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionAuthSourceMode":{"id":"components/schemas/TransactionAuthSourceMode","kind":"json-schema","title":"TransactionAuthSourceMode","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"O","enum":["E","O"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the UTG is online or offline."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionToShip":{"id":"components/schemas/TransactionToShip","kind":"json-schema","title":"TransactionToShip","data":{"type":"string","maxLength":1,"example":"Y","enum":["Y","N"],"description":"Merchants acknowledgement to ship/process the order.\n"}},"components/schemas/TransactionOrderId":{"id":"components/schemas/TransactionOrderId","kind":"json-schema","title":"TransactionOrderId","data":{"type":"string","example":"92282831","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant’s Order Number"},"children":[]}]}]}]}},"components/schemas/CardTypeRisk":{"id":"components/schemas/CardTypeRisk","kind":"json-schema","title":"CardTypeRisk","data":{"type":"string","enum":["AP","CC","PP","GC"],"example":"CC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Type submitted by merchant:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift Card"},"children":[]}]}]}]}]}]}]}},"components/schemas/AmountRisk":{"id":"components/schemas/AmountRisk","kind":"json-schema","title":"AmountRisk","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested. All other fields are for informational purposes and must also be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, a purchase of $100 with $8 tax would be “108.00” in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and \"8.00\" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For merchants that are configured to allow multiple currencies, the amount  fields can specify up to three decimal places. However, the number of decimal  places can not exceed the number allowed for the specified currency. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}],"required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"}}}},"components/schemas/RiskSessionId":{"id":"components/schemas/RiskSessionId","kind":"json-schema","title":"RiskSessionId","data":{"type":"string","maxLength":32,"example":"123420552ab34024b461455de4bcb482","description":"Unique Session ID. Must be unique over a 30-day span.\n"}},"components/schemas/SourceIP":{"id":"components/schemas/SourceIP","kind":"json-schema","title":"SourceIP","data":{"type":"string","example":"63.57.84.101","description":"Public source IP Address where the request originates, not the IP Address of the web server.\n"}},"components/schemas/BillingEmailAddress":{"id":"components/schemas/BillingEmailAddress","kind":"json-schema","title":"BillingEmailAddress","data":{"type":"string","example":"firstname.lastname@email.com","description":"This is the email address submitted by the customer.\n"}},"components/schemas/BillingFullName":{"id":"components/schemas/BillingFullName","kind":"json-schema","title":"BillingFullName","data":{"type":"string","example":"John Smith","description":"Name submitted with the order\n"}},"components/schemas/BillingAddressLine1":{"id":"components/schemas/BillingAddressLine1","kind":"json-schema","title":"BillingAddressLine1","data":{"type":"string","example":"65 Easy St","description":"Billing street address - Line 1\n"}},"components/schemas/BillingAddressLine2":{"id":"components/schemas/BillingAddressLine2","kind":"json-schema","title":"BillingAddressLine2","data":{"type":"string","example":"c/o John Doe","description":"Billing street address - Line 2\n"}},"components/schemas/BillingCity":{"id":"components/schemas/BillingCity","kind":"json-schema","title":"BillingCity","data":{"type":"string","example":"Las Vegas","description":"Billing address - City\n"}},"components/schemas/BillingRegion":{"id":"components/schemas/BillingRegion","kind":"json-schema","title":"BillingRegion","data":{"type":"string","maxLength":3,"example":"NV","description":"Billing address - State/Province\n"}},"components/schemas/BillingPostalCode":{"id":"components/schemas/BillingPostalCode","kind":"json-schema","title":"BillingPostalCode","data":{"type":"string","minLength":5,"maxLength":9,"example":"65144","description":"Billing address - Postal Code\n"}},"components/schemas/BillingCountry":{"id":"components/schemas/BillingCountry","kind":"json-schema","title":"BillingCountry","data":{"type":"string","example":"US","description":"Billing address - Country\n"}},"components/schemas/BillingPhoneNumber":{"id":"components/schemas/BillingPhoneNumber","kind":"json-schema","title":"BillingPhoneNumber","data":{"type":"string","example":"+13110001234","description":"Bill-to Phone Number\n"}},"components/schemas/ShippingAddressLine1":{"id":"components/schemas/ShippingAddressLine1","kind":"json-schema","title":"ShippingAddressLine1","data":{"type":"string","example":"65 Easy St","maxLength":30,"description":"Shipping street address - Line 1\n"}},"components/schemas/ShippingAddressLine2":{"id":"components/schemas/ShippingAddressLine2","kind":"json-schema","title":"ShippingAddressLine2","data":{"type":"string","example":"c/o John Doe","maxLength":30,"description":"Shipping street address - Line 2\n"}},"components/schemas/ShippingCity":{"id":"components/schemas/ShippingCity","kind":"json-schema","title":"ShippingCity","data":{"type":"string","example":"Las Vegas","maxLength":30,"description":"Shipping address - City\n"}},"components/schemas/ShippingCountry":{"id":"components/schemas/ShippingCountry","kind":"json-schema","title":"ShippingCountry","data":{"type":"string","example":"US","maxLength":2,"description":"Shipping address - 2 character ISO Country Code.\n"}},"components/schemas/ShippingEmailAddress":{"id":"components/schemas/ShippingEmailAddress","kind":"json-schema","title":"ShippingEmailAddress","data":{"type":"string","example":"firstname.lastname@email.com","description":"Shipping address - Email address of recipient\n"}},"components/schemas/ShippingFullName":{"id":"components/schemas/ShippingFullName","kind":"json-schema","title":"ShippingFullName","data":{"type":"string","example":"John 'Smith'","description":"Shipping address - Name of recipient\n"}},"components/schemas/ShippingPostalCode":{"id":"components/schemas/ShippingPostalCode","kind":"json-schema","title":"ShippingPostalCode","data":{"type":"string","minLength":5,"maxLength":9,"example":"65144","description":"Shipping address - Postal Code\n"}},"components/schemas/ShippingPhoneNumber":{"id":"components/schemas/ShippingPhoneNumber","kind":"json-schema","title":"ShippingPhoneNumber","data":{"type":"string","example":"+13110001234","description":"Ship-to Phone Number\n"}},"components/schemas/ShippingRegion":{"id":"components/schemas/ShippingRegion","kind":"json-schema","title":"ShippingRegion","data":{"type":"string","example":"NV","maxLength":3,"description":"Shipping address - A level 2 country subdivision code according to ISO-3166-2.\n"}},"components/schemas/ShippingType":{"id":"components/schemas/ShippingType","kind":"json-schema","title":"ShippingType","data":{"type":"string","maxLength":1,"example":"Y","enum":["SD","ND","2D","ST"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping type."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard"},"children":[]}]}]}]}]}]}]}},"components/schemas/ShoppingCartType":{"id":"components/schemas/ShoppingCartType","kind":"json-schema","title":"ShoppingCartType","data":{"type":"string","example":"Deodarant","description":"Shopping cart data array attribute high level or generalized description of the item added to the shopping cart; this value should be free from any markup or Unicode values. This value should be passed as plain text.\n"}},"components/schemas/ShoppingCartDescription":{"id":"components/schemas/ShoppingCartDescription","kind":"json-schema","title":"ShoppingCartDescription","data":{"type":"string","example":"New Spice Fiji","description":"Shopping cart data array attribute for a specific description of the item being purchased.\n"}},"components/schemas/ShoppingCartSKU":{"id":"components/schemas/ShoppingCartSKU","kind":"json-schema","title":"ShoppingCartSKU","data":{"type":"string","example":"579446588","description":"Shopping cart data array attribute typically the SKU for an item; this value should be free from any markup or Unicode values. This value should be passed as plain text.\n"}},"components/schemas/ShoppingCartQuantity":{"id":"components/schemas/ShoppingCartQuantity","kind":"json-schema","title":"ShoppingCartQuantity","data":{"type":"integer","example":4,"description":"Shopping cart data array attribute signifying the quantity of the item being purchased.\n"}},"components/schemas/ShoppingCartPrice":{"id":"components/schemas/ShoppingCartPrice","kind":"json-schema","title":"ShoppingCartPrice","data":{"type":"number","example":1000,"description":"Shopping cart data array attribute for the price of the single item. Must be a natural number including 0.\n"}},"components/schemas/ShoppingCartArray":{"id":"components/schemas/ShoppingCartArray","kind":"json-schema","title":"ShoppingCartArray","data":{"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ShoppingCartType"},"description":{"$ref":"#/components/schemas/ShoppingCartDescription"},"sku":{"$ref":"#/components/schemas/ShoppingCartSKU"},"quantity":{"$ref":"#/components/schemas/ShoppingCartQuantity"},"price":{"$ref":"#/components/schemas/ShoppingCartPrice"}}},"example":[{"type":"Deodarant","sku":"579446588","description":"New Spice Fiji","quantity":"5","price":4},{"type":"Toothbrush","sku":"135488945","description":"Electric Model","quantity":"1","price":104.99}],"description":"Array of objects detailing the individual items being purchased\n"}},"components/schemas/risk_assess_unencryptedcard":{"id":"components/schemas/risk_assess_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"type":"object","title":"Card Number Unencrypted","allOf":[{"type":"object","required":["dateTime","card","transaction","amount","currencyCode","risk","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","required":["invoice"],"properties":{"toShip":{"$ref":"#/components/schemas/TransactionToShip"},"orderId":{"$ref":"#/components/schemas/TransactionOrderId"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"card":{"type":"object","required":["number","type"],"properties":{"type":{"$ref":"#/components/schemas/CardTypeRisk"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"amount":{"$ref":"#/components/schemas/AmountRisk"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"risk":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"$ref":"#/components/schemas/RiskSessionId"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"},"customer":{"type":"object","properties":{"emailAddress":{"$ref":"#/components/schemas/BillingEmailAddress"},"fullName":{"$ref":"#/components/schemas/BillingFullName"},"addressLine1":{"$ref":"#/components/schemas/BillingAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/BillingAddressLine2"},"city":{"$ref":"#/components/schemas/BillingCity"},"region":{"$ref":"#/components/schemas/BillingRegion"},"postalCode":{"$ref":"#/components/schemas/BillingPostalCode"},"country":{"$ref":"#/components/schemas/BillingCountry"},"phoneNumber":{"$ref":"#/components/schemas/BillingPhoneNumber"},"shipping":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/ShippingAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/ShippingAddressLine2"},"city":{"$ref":"#/components/schemas/ShippingCity"},"country":{"$ref":"#/components/schemas/ShippingCountry"},"emailAddress":{"$ref":"#/components/schemas/ShippingEmailAddress"},"fullName":{"$ref":"#/components/schemas/ShippingFullName"},"postalCode":{"$ref":"#/components/schemas/ShippingPostalCode"},"phoneNumber":{"$ref":"#/components/schemas/ShippingPhoneNumber"},"region":{"$ref":"#/components/schemas/ShippingRegion"},"type":{"$ref":"#/components/schemas/ShippingType"}}}}},"shoppingCart":{"$ref":"#/components/schemas/ShoppingCartArray"}}}],"example":{"dateTime":"2022-02-07T12:36:42.948061-05:00","transaction":{"toShip":"Y","orderId":"orderId","invoice":"0207123502","vendorReference":"simulator1.0:0207123502"},"card":{"type":"CC","number":"342877777777705","expirationDate":"1123,","entryMode":"M","present":"N"},"amount":{"total":76001.99},"currencyCode":"USD","risk":{"sessionId":"123420552ab34024b461455de4bcb482"},"sourceIp":"10.249.11.239","customer":{"emailAddress":"firstname.lastname@email.com"},"shoppingCart'":[{"type":"Deodarant","description":"New Spice Fiji","sku":"579446588","quantity":"5","price":4},{"type":"Toothbrush","description":"Electric Model","sku":"135488945","quantity":"1","price":104.99}]}}},"components/schemas/CardTypeRiskToken":{"id":"components/schemas/CardTypeRiskToken","kind":"json-schema","title":"CardTypeRiskToken","data":{"type":"string","enum":["TK"],"example":"TK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Type submitted by merchant:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token"},"children":[]}]}]}]}]}]}]}},"components/schemas/risk_assess_token_gtv":{"id":"components/schemas/risk_assess_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","allOf":[{"type":"object","required":["dateTime","card","transaction","amount","currencyCode","risk","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","required":["invoice"],"properties":{"toShip":{"$ref":"#/components/schemas/TransactionToShip"},"orderId":{"$ref":"#/components/schemas/TransactionOrderId"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"purchaseCard":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"}}}}},"card":{"type":"object","required":["token","type"],"properties":{"type":{"$ref":"#/components/schemas/CardTypeRiskToken"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"amount":{"$ref":"#/components/schemas/AmountRisk"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"risk":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"$ref":"#/components/schemas/RiskSessionId"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"},"customer":{"type":"object","properties":{"emailAddress":{"$ref":"#/components/schemas/BillingEmailAddress"},"fullName":{"$ref":"#/components/schemas/BillingFullName"},"addressLine1":{"$ref":"#/components/schemas/BillingAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/BillingAddressLine2"},"city":{"$ref":"#/components/schemas/BillingCity"},"region":{"$ref":"#/components/schemas/BillingRegion"},"postalCode":{"$ref":"#/components/schemas/BillingPostalCode"},"country":{"$ref":"#/components/schemas/BillingCountry"},"phoneNumber":{"$ref":"#/components/schemas/BillingPhoneNumber"},"shipping":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/ShippingAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/ShippingAddressLine2"},"city":{"$ref":"#/components/schemas/ShippingCity"},"country":{"$ref":"#/components/schemas/ShippingCountry"},"emailAddress":{"$ref":"#/components/schemas/ShippingEmailAddress"},"fullName":{"$ref":"#/components/schemas/ShippingFullName"},"postalCode":{"$ref":"#/components/schemas/ShippingPostalCode"},"phoneNumber":{"$ref":"#/components/schemas/ShippingPhoneNumber"},"region":{"$ref":"#/components/schemas/ShippingRegion"},"type":{"$ref":"#/components/schemas/ShippingType"}}}}},"shoppingCart":{"$ref":"#/components/schemas/ShoppingCartArray"}}}],"example":{"dateTime":"2022-02-07T12:36:42.948061-05:00","transaction":{"toShip":"Y","orderId":"orderId","invoice":"0207123502","vendorReference":"simulator1.0:0207123502"},"card":{"type":"TK","token":{"value":"8048471746471119"},"entryMode":"M","present":"N"},"amount":{"total":76001.99},"currencyCode":"USD","risk":{"sessionId":"123420552ab34024b461455de4bcb482"},"sourceIp":"10.249.11.239","customer":{"emailAddress":"firstname.lastname@email.com"},"shoppingCart'":[{"type":"Deodarant","description":"New Spice Fiji","sku":"579446588","quantity":"5","price":4},{"type":"Toothbrush","description":"Electric Model","sku":"135488945","quantity":"1","price":104.99}]}}},"components/schemas/RiskAssessment":{"id":"components/schemas/RiskAssessment","kind":"json-schema","title":"RiskAssessment","data":{"type":"string","enum":["A","D","R","E"],"example":"A","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the answer to the risk assessment. If the response is Escalate then transaction needs 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve. Continue with the payment transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deny. Try another payment method"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review. Continue with the payment transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escalate. The transaction needs 3DS authentication."},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionS4RiskId":{"id":"components/schemas/TransactionS4RiskId","kind":"json-schema","title":"TransactionS4RiskId","data":{"type":"string","example":"EC52377F-5A8E-4534-BE7A-CF779A35BE45","description":"Unique transaction identification number generated by Shift4 to identify a specific risk transaction and a field that can be searched in LTM.\n"}},"components/schemas/HostResponseReasonCodeRisk":{"id":"components/schemas/HostResponseReasonCodeRisk","kind":"json-schema","title":"HostResponseReasonCodeRisk","data":{"type":"string","maxLength":4,"example":"271","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a response code from the host."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"201"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing version of provider, this is built into SDK but must be supplied by merchant if not using the SDK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode type for post is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"203"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The six digit Merchant ID was not sent"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"204"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique session ID was not sent"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"205"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction ID number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"211"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency was missing in the RISK submission"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"212"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount was missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"221"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address was missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"222"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For MODE = P RISK inquiries the caller ID is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"223"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The website identifier that was created in the Agent Web Console (DEFAULT is the default website ID) is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"231"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment type is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"232"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit card information is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"233"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing Magnetic Ink Character Recognition string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"234"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The PayPal Payer ID is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"235"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment token is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"241"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP address is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"251"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant acknowledgement is missing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"261"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RISK query submitted to provider contained no data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"271"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"272"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"273"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"274"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"275"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"301"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of provider supplied by merchant does not fit the four integer parameter"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"302"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode type is invalid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"303"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The six digit Merchant ID is malformed or wrong"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"304"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique session ID is invalid. Refer to the Data Collector"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"305"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction ID number is malformed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"311"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency was wrong in the RISK submission"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"312"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount is wrong. TOTL is the whole number amount charged to customer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"321"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address does not meet required format or is greater than 64 characters in length"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"322"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For MODE = P RISK inquiries the caller ID is malformed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"323"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The website identifier that was created in the Agent Web Console (DEFAULT is the default w website ID) does not match what was created in the AWC."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"324"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified format is wrong. Format options are key value pairs, XML, JSON, YAML"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"331"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment type is wrong."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"332"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit card information is malformed or wrong, test cards do not work in the production environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"333"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Malformed or improper Magnetic Ink Character Recognition string."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"334"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The PayPal Payer ID is malformed or corrupt."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"335"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Malformed or improper Google Checkout Account ID string."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"336"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Malformed or improper Bill Me Later account number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"337"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The encryption method specified is wrong."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"338"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GreenDot payment token is not a valid payment token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"339"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When payment type equals CARD, PTYP = CARD and payment encryption type equals KHASH, `PENC = KHASH the value must be 20 characters in length."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"340"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or excessive characters in the PTOK field"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"341"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP address does not match specifications"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"342"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Gift Card payment token is invalid due to invalid characters, null, or exceeding character length"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"351"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant acknowledgement must be Y or N"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"362"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is a discrepancy in the shopping cart key count and the number of items actually being sent in the cart"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"371"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"372"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is corrupt or missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"373"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is corrupt or missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"374"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is corrupt or missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"375"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopping cart data array attribute is corrupt or missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"399"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UDF has been mistyped or does not exist in the Agent Web Console"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RISK keys submitted by merchant were not part of SDK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PTYP equals NONE and a PTOK is submitted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"413"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RISK Post to provider exceeded the 4K limit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"501"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error regarding certificate - Using test certificate in prod"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Merchant ID has been entered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"601"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unspecified system error - Contact Merchant Services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"602"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider will not process particular transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"701"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No header found with merchantId = [XXXXX], session_id = [htot2kk5khpamo45f777q455], trans=[122347] This error occurs when a RISK request goes to the database and there is no data available in the reply. The Update post had an invalid transaction ID#. Check all required fields for update post and confirm they are being passed correctly."},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseReasonDescriptionRisk":{"id":"components/schemas/HostResponseReasonDescriptionRisk","kind":"json-schema","title":"HostResponseReasonDescriptionRisk","data":{"type":"string","maxLength":73,"example":"The credit card information is missing","description":"Returns a description from the host.\n"}},"components/schemas/CustomerCity":{"id":"components/schemas/CustomerCity","kind":"json-schema","title":"CustomerCity","data":{"type":"string","example":"Las Vegas","maxLength":30,"description":"Customer address city.\n"}},"components/schemas/CustomerCountry":{"id":"components/schemas/CustomerCountry","kind":"json-schema","title":"CustomerCountry","data":{"type":"string","example":"US","maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 character ISO Country Code. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" website for details."},"children":[]}]}]}]}},"components/schemas/CustomerPhoneNumber":{"id":"components/schemas/CustomerPhoneNumber","kind":"json-schema","title":"CustomerPhoneNumber","data":{"type":"string","example":"3110001234","maxLength":32,"description":"Customer phone number\n"}},"components/schemas/CustomerPhoneCountry":{"id":"components/schemas/CustomerPhoneCountry","kind":"json-schema","title":"CustomerPhoneCountry","data":{"type":"string","example":"1","minLength":1,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country calling code of the phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.phoneNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CustomerRegion":{"id":"components/schemas/CustomerRegion","kind":"json-schema","title":"CustomerRegion","data":{"type":"string","maxLength":3,"example":"NV","description":"A level 2 country subdivision code according to ISO-3166-2.\n"}},"components/schemas/CustomerExternalId":{"id":"components/schemas/CustomerExternalId","kind":"json-schema","title":"CustomerExternalId","data":{"type":"string","example":"OD-123","description":"Your external identifier for the Customer\n"}},"components/schemas/CustomerEnrollDate":{"id":"components/schemas/CustomerEnrollDate","kind":"json-schema","title":"CustomerEnrollDate","data":{"type":"string","format":"ISO 8601","example":"2019-03-14T11:16:42.896-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of the user's first transaction in your system, regardless of payment  method used. The date and time must be passed in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)"},"children":[]}]}]}]}},"components/schemas/OTAChangeGuest":{"id":"components/schemas/OTAChangeGuest","kind":"json-schema","title":"OTAChangeGuest","data":{"type":"string","example":"Y","enum":["Y","N"],"description":"Whether the guest (the person being served) is able to be changed. Fraudsters tend to pay for services that can change the guest.\n"}},"components/schemas/OTAServiceEndDate":{"id":"components/schemas/OTAServiceEndDate","kind":"json-schema","title":"OTAServiceEndDate","data":{"type":"string","format":"YYYY-MM-DD","example":"2024-04-20","description":"OTA service end date  in YYYY-MM-DD format. A consumer booking a service such as a hotel for too many days elevates risk.\n"}},"components/schemas/OTAServiceStartDate":{"id":"components/schemas/OTAServiceStartDate","kind":"json-schema","title":"OTAServiceStartDate","data":{"type":"string","format":"YYYY-MM-DD","example":"2024-04-18","description":"OTA service start date in YYYY-MM-DD format. A service start date that is very close to the transaction date elevates risk.\n"}},"components/schemas/OTAStartCity":{"id":"components/schemas/OTAStartCity","kind":"json-schema","title":"OTAStartCity","data":{"type":"string","example":"Las Vegas","description":"OTA start city.\n"}},"components/schemas/OTAStartCountry":{"id":"components/schemas/OTAStartCountry","kind":"json-schema","title":"OTAStartCountry","data":{"type":"string","format":"ISO 3166 Alpha-2","example":"US","description":"OTA start country in ISO 3166 Alpha-2 format.; for example, country where bus ticket was purchased.\n"}},"components/schemas/OTAStartZipCode":{"id":"components/schemas/OTAStartZipCode","kind":"json-schema","title":"OTAStartZipCode","data":{"type":"string","example":"89134","description":"OTA start zip code.\n"}},"components/schemas/OTAType":{"id":"components/schemas/OTAType","kind":"json-schema","title":"OTAType","data":{"type":"array","items":{"type":"string","enum":["hotel","trainticket","ferry","bus","multimodal","airline","cruise","carrental"]},"example":["hotel","airline","trainticket"],"description":"OTA transaction type array.\n"}},"components/schemas/OTARequestPayPal":{"id":"components/schemas/OTARequestPayPal","kind":"json-schema","title":"OTARequestPayPal","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Online Travel Agency transactions"},"children":[]}]}]}]}],"required":["changeGuest","serviceEndDate","serviceStartDate","startCity","startCountry","startZipCode","type"],"properties":{"changeGuest":{"$ref":"#/components/schemas/OTAChangeGuest"},"serviceEndDate":{"$ref":"#/components/schemas/OTAServiceEndDate"},"serviceStartDate":{"$ref":"#/components/schemas/OTAServiceStartDate"},"startCity":{"$ref":"#/components/schemas/OTAStartCity"},"startCountry":{"$ref":"#/components/schemas/OTAStartCountry"},"startZipCode":{"$ref":"#/components/schemas/OTAStartZipCode"},"type":{"$ref":"#/components/schemas/OTAType"}}}},"components/schemas/PayPalClientMetaDataId":{"id":"components/schemas/PayPalClientMetaDataId","kind":"json-schema","title":"PayPalClientMetaDataId","data":{"type":"string","example":"6f52ab38539f7e1037e8aa8e7b95407b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for completing risk check. Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.ota"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent in the request."},"children":[]}]}]}]}},"components/schemas/PayPalClientToken":{"id":"components/schemas/PayPalClientToken","kind":"json-schema","title":"PayPalClientToken","data":{"type":"string","example":"eyJ2ZXJzaW9uIjoyLCJhdXRob3JpemF0aW9uRmluZ2VycHJpbnQiOiJleUowZVhBaU9pSktWMVFpTENKaGJHY2lPaUpGVXpJMU5pSXNJbXRwWkNJNklqSXdNVGd3TkRJMk1UWXRjMkZ1WkdKdmVDSXNJbWx6Y3lJNkltaDBkSEJ6T2k4dllYQnBMbk5oYm1SaWIzZ3VZbkpoYVc1MGNtVmxaMkYwWlhkaGVTNWpiMjBpZlEuZXlKbGVIQWlPakUzTVRNMk1qWXdNelVzSW1wMGFTSTZJbVl6WVRFek9EQm1MVFJpTURRdE5ERXpOQzA1WWpFMExUY3haalV5T0RKbVlXRTVOeUlzSW5OMVlpSTZJblkyY3pKemJXSTNObUptT1Rad2REUWlMQ0pwYzNNaU9pSm9kSFJ3Y3pvdkwyRndhUzV6WVc1a1ltOTRMbUp5WVdsdWRISmxaV2RoZEdWM1lYa3VZMjl0SWl3aWJXVnlZMmhoYm5RaU9uc2ljSFZpYkdsalgybGtJam9pZGpaek1uTnRZamMyWW1ZNU5uQjBOQ0lzSW5abGNtbG1lVjlqWVhKa1gySjVYMlJsWm1GMWJIUWlPbVpoYkhObGZTd2ljbWxuYUhSeklqcGJJbTFoYm1GblpWOTJZWFZzZENKZExDSnpZMjl3WlNJNld5SkNjbUZwYm5SeVpXVTZWbUYxYkhRaVhTd2liM0IwYVc5dWN5STZleUp0WlhKamFHRnVkRjloWTJOdmRXNTBYMmxrSWpvaVlYQnROSEZoSW4xOS5fNW9hUm9WSkxYWGZTWnM0ZUNxUVdTYkF5X3A3UFZuOUdfbjYteDE4Q0tPUUFuYmxRN2tHVExJOW5OOHM0OW52NW92Y1YwYXJnVHNNUkw5bjF6TXU3USIsImNvbmZpZ1VybCI6Imh0dHBzOi8vYXBpLnNhbmRib3guYnJhaW50cmVlZ2F0ZXdheS5jb206NDQzL21lcmNoYW50cy92NnMyc21iNzZiZjk2cHQ0L2NsaWVudF9hcGkvdjEvY29uZmlndXJhdGlvbiIsIm1lcmNoYW50QWNjb3VudElkIjoiYXBtNHFhIiwiZ3JhcGhRTCI6eyJ1cmwiOiJodHRwczovL3BheW1lbnRzLnNhbmRib3guYnJhaW50cmVlLWFwaS5jb20vZ3JhcGhxbCIsImRhdGUiOiIyMDE4LTA1LTA4IiwiZmVhdHVyZXMiOlsidG9rZW5pemVfY3JlZGl0X2NhcmRzIl19LCJjbGllbnRBcGlVcmwiOiJodHRwczovL2FwaS5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tOjQ0My9tZXJjaGFudHMvdjZzMnNtYjc2YmY5NnB0NC9jbGllbnRfYXBpIiwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwibWVyY2hhbnRJZCI6InY2czJzbWI3NmJmOTZwdDQiLCJhc3NldHNVcmwiOiJodHRwczovL2Fzc2V0cy5icmFpbnRyZWVnYXRld2F5LmNvbSIsImF1dGhVcmwiOiJodHRwczovL2F1dGgudmVubW8uc2FuZGJveC5icmFpbnRyZWVnYXRld2F5LmNvbSIsInZlbm1vIjoib2ZmIiwiY2hhbGxlbmdlcyI6W10sInRocmVlRFNlY3VyZUVuYWJsZWQiOnRydWUsImFuYWx5dGljcyI6eyJ1cmwiOiJodHRwczovL29yaWdpbi1hbmFseXRpY3Mtc2FuZC5zYW5kYm94LmJyYWludHJlZS1hcGkuY29tL3Y2czJzbWI3NmJmOTZwdDQifSwicGF5cGFsRW5hYmxlZCI6dHJ1ZSwicGF5cGFsIjp7ImJpbGxpbmdBZ3JlZW1lbnRzRW5hYmxlZCI6dHJ1ZSwiZW52aXJvbm1lbnROb05ldHdvcmsiOmZhbHNlLCJ1bnZldHRlZE1lcmNoYW50IjpmYWxzZSwiYWxsb3dIdHRwIjp0cnVlLCJkaXNwbGF5TmFtZSI6ImFwbTRxYSIsImNsaWVudElkIjoiQWVvaGtSQk93UUtCZXJfZ0x2ZnJqTWR4aDhra2tiSm1YZG84WEtORzBwSUFpYlFwWjNTWDdqTXRQTnhwSFlJTmNEVlFVeHlnaHJrVkJydTQiLCJiYXNlVXJsIjoiaHR0cHM6Ly9hc3NldHMuYnJhaW50cmVlZ2F0ZXdheS5jb20iLCJhc3NldHNVcmwiOiJodHRwczovL2NoZWNrb3V0LnBheXBhbC5jb20iLCJkaXJlY3RCYXNlVXJsIjpudWxsLCJlbnZpcm9ubWVudCI6Im9mZmxpbmUiLCJicmFpbnRyZWVDbGllbnRJZCI6Im1hc3RlcmNsaWVudDMiLCJtZXJjaGFudEFjY291bnRJZCI6ImFwbTRxYSIsImN1cnJlbmN5SXNvQ29kZSI6IlVTRCJ9fQ==","description":"A Base64 encoded string used to initialize client SDKs.\n"}},"components/schemas/PayPalPayerId":{"id":"components/schemas/PayPalPayerId","kind":"json-schema","title":"PayPalPayerId","data":{"type":"string","example":"6CB2GS6AQRS5S","description":"The ID belonging to the PayPal account.\n"}},"components/schemas/PayPalPaymentMethodNonce":{"id":"components/schemas/PayPalPaymentMethodNonce","kind":"json-schema","title":"PayPalPaymentMethodNonce","data":{"type":"string","example":"7fd66f90e-c8ec-0363-6b45-aeb930175e43","description":"A payment method nonce is a secure, one-time-use reference to payment information. It's the key element that allows your server to communicate sensitive payment information to Braintree without ever touching the raw data.\n"}},"components/schemas/PayPalPaymentMethodIdUsage":{"id":"components/schemas/PayPalPaymentMethodIdUsage","kind":"json-schema","title":"PayPalPaymentMethodIdUsage","data":{"type":"string","example":"S","enum":["S","M"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dictates whether paymentMethodId returned will be single or multi-use payment token"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Use"},"children":[]}]}]}]}]}]}]}},"components/schemas/PayPalDeviceData":{"id":"components/schemas/PayPalDeviceData","kind":"json-schema","title":"PayPalDeviceData","data":{"type":"string","example":"{\"correlation_id\":\"010e4 a744d78644f971fc5f9dc1c43aa\"}","description":"The customer's device information.\n"}},"components/schemas/AirlineTaxAmount":{"id":"components/schemas/AirlineTaxAmount","kind":"json-schema","title":"AirlineTaxAmount","data":{"type":"number","maxLength":14,"example":15,"description":"The tax amount\n"}},"components/schemas/AirlineFlightLegsPayPal":{"id":"components/schemas/AirlineFlightLegsPayPal","kind":"json-schema","title":"AirlineFlightLegsPayPal","data":{"type":"object","required":["destAirportCode","fareBasis","flightNumber","legDepartureDateTime","originAirportCode","serviceClass","stopOverCode"],"properties":{"carrierCode":{"$ref":"#/components/schemas/AirlineFlightLegsCarrierCode"},"conjunctionTicketIndicator":{"$ref":"#/components/schemas/AirlineConjunctionTicketIndicator"},"couponNumber":{"$ref":"#/components/schemas/AirlineFlightLegsCouponNumber"},"destAirportCode":{"$ref":"#/components/schemas/AirlineFlightLegsDestAirportCode"},"exchangeTicketNumber":{"$ref":"#/components/schemas/AirlineExchangeTicketNumber"},"fareBasis":{"$ref":"#/components/schemas/AirlineFlightLegsFareBasis"},"flightNumber":{"$ref":"#/components/schemas/AirlineFlightLegsFlightNumber"},"legArrivalDateTime":{"$ref":"#/components/schemas/AirlineFlightLegsLegArrivalDateTime"},"legDepartureDateTime":{"$ref":"#/components/schemas/AirlineFlightLegsLegDepartureDateTime"},"originAirportCode":{"$ref":"#/components/schemas/AirlineFlightLegsOriginAirportCode"},"restrictedTicketIndicator":{"$ref":"#/components/schemas/AirlineRestrictedTicketIndicator"},"serviceClass":{"$ref":"#/components/schemas/AirlineFlightLegsServiceClass"},"stopOverCode":{"$ref":"#/components/schemas/AirlineFlightLegsStopOverCode"},"taxAmount":{"$ref":"#/components/schemas/AirlineTaxAmount"}}}},"components/schemas/AirlineFlightLegsArrayPayPal":{"id":"components/schemas/AirlineFlightLegsArrayPayPal","kind":"json-schema","title":"AirlineFlightLegsArrayPayPal","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/AirlineFlightLegsPayPal"},"example":[{"destAirportCode":"YXX","fareBasis":"YE3MAU","flightNumber":"2490","legDepartureDateTime":"2021-04-12T15:39:01.594-07:00","originAirportCode":"AUH","serviceClass":"FC","stopOverCode":"X"},{"destAirportCode":"LAS","fareBasis":"YE3MAU","flightNumber":"8495","legDepartureDateTime":"2021-04-12T19:39:01.594-07:00","originAirportCode":"YXX","serviceClass":"FC","stopOverCode":"X"}],"description":"Array of flight trip leg info. Maximun 4 legs to a trip allowed. Note: At least one instance of flight trip leg info should be provided.\n"}},"components/schemas/AirlinePassengerBirthDate":{"id":"components/schemas/AirlinePassengerBirthDate","kind":"json-schema","title":"AirlinePassengerBirthDate","data":{"type":"string","format":"YYYY-MM-DD","example":"2001-04-14","description":"The passenger's date of birth in YYYY-MM-DD format\n"}},"components/schemas/AirlinePassengerCode":{"id":"components/schemas/AirlinePassengerCode","kind":"json-schema","title":"AirlinePassengerCode","data":{"type":"string","maxLength":17,"example":"12AD9S8","description":"The code supplied by the customer using a purchase card. Maximum 17 characters.\n"}},"components/schemas/AirlinePassengerCountryCode":{"id":"components/schemas/AirlinePassengerCountryCode","kind":"json-schema","title":"AirlinePassengerCountryCode","data":{"type":"string","format":"ISO 3166 Alpha-2","example":"US","description":"The passenger's nationality in ISO 3166 Alpha-2 format.\n"}},"components/schemas/AirlineTicketsPayPal":{"id":"components/schemas/AirlineTicketsPayPal","kind":"json-schema","title":"AirlineTicketsPayPal","data":{"type":"object","required":["passengerName","ticketNumber"],"properties":{"passengerName":{"$ref":"#/components/schemas/AirlineTicketsPassengerName"},"ticketNumber":{"$ref":"#/components/schemas/AirlineTicketsTicketNumber"},"ticketFare":{"$ref":"#/components/schemas/AirlineTicketsTicketFare"}}}},"components/schemas/AirlineTicketsArrayPayPal":{"id":"components/schemas/AirlineTicketsArrayPayPal","kind":"json-schema","title":"AirlineTicketsArrayPayPal","data":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/AirlineTicketsPayPal"},"example":[{"ticketNumber":412345678901234,"passengerName":"Jane Doe","ticketFare":350},{"ticketNumber":412345678901236,"passengerName":"John Smith","ticketFare":250}],"description":"Array of ticket number and passenger name. Note: At least one instance of ticket number and passenger name info should be provided.\n"}},"components/schemas/AirlineRequestPayPal":{"id":"components/schemas/AirlineRequestPayPal","kind":"json-schema","title":"AirlineRequestPayPal","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Utilize this object for Airline transactions"},"children":[]}]}]}]}],"required":["carrierCode","flightLegs","issueDate","tickets"],"properties":{"carrierCode":{"$ref":"#/components/schemas/AirlineCarrierCode"},"flightLegs":{"$ref":"#/components/schemas/AirlineFlightLegsArrayPayPal"},"issueDate":{"$ref":"#/components/schemas/AirlineIssueDate"},"passengerArrivalDate":{"$ref":"#/components/schemas/AirlinePassengerArrivalDate"},"passengerBirthDate":{"$ref":"#/components/schemas/AirlinePassengerBirthDate"},"passengerCode":{"$ref":"#/components/schemas/AirlinePassengerCode"},"passengerCountryCode":{"$ref":"#/components/schemas/AirlinePassengerCountryCode"},"restrictedTicketIndicator":{"$ref":"#/components/schemas/AirlineRestrictedTicketIndicator"},"taxAmount":{"$ref":"#/components/schemas/AirlineTaxAmount"},"tickets":{"$ref":"#/components/schemas/AirlineTicketsArrayPayPal"},"travelAgencyCode":{"$ref":"#/components/schemas/AirlineTravelAgencyCode"},"travelAgencyName":{"$ref":"#/components/schemas/AirlineTravelAgencyName"}}}},"components/schemas/CustomerBrowserType":{"id":"components/schemas/CustomerBrowserType","kind":"json-schema","title":"CustomerBrowserType","data":{"type":"string","example":"Mozilla\\\\/5.0 (Windows NT 10.0; Win64; x64; rv:98.0) Gecko\\\\/20100101  Firefox\\\\/98.0","description":"Internet browser or simply a browser.\n"}},"components/schemas/PayPalTransactionId":{"id":"components/schemas/PayPalTransactionId","kind":"json-schema","title":"PayPalTransactionId","data":{"type":"string","example":"dHJhbnNhY3Rpb25fazd6cDB5ZzA","description":"Unique identifier.\n"}},"components/schemas/PayPalLegacyId":{"id":"components/schemas/PayPalLegacyId","kind":"json-schema","title":"PayPalLegacyId","data":{"type":"string","example":"k7zp0yg0","description":"Legacy unique identifier.\n"}},"components/schemas/PayPalOrderId":{"id":"components/schemas/PayPalOrderId","kind":"json-schema","title":"PayPalOrderId","data":{"type":"string","example":"444106-8010720-0414151800-4371","description":"Additional information about the transaction.\n"}},"components/schemas/PayPalStatus":{"id":"components/schemas/PayPalStatus","kind":"json-schema","title":"PayPalStatus","data":{"type":"string","example":"AUTHORIZED","description":"The current status of this transaction.\n"}},"components/schemas/PayPalAuthorizationId":{"id":"components/schemas/PayPalAuthorizationId","kind":"json-schema","title":"PayPalAuthorizationId","data":{"type":"string","example":"6W6361048T1775802","description":"If the transaction was successfully authorized, the PayPal ID for the authorization.\n"}},"components/schemas/PayPalCaptureId":{"id":"components/schemas/PayPalCaptureId","kind":"json-schema","title":"PayPalCaptureId","data":{"type":"string","example":"3EK61497JE2934158","description":"If funds for the transaction have settled, the PayPal ID for the capture of funds.\n"}},"components/schemas/PayPalPaymentMethodId":{"id":"components/schemas/PayPalPaymentMethodId","kind":"json-schema","title":"PayPalPaymentMethodId","data":{"type":"string","example":"dda7z0fq","description":"Identifier for a single or multi-use payment token\n"}},"components/schemas/CustomerAddressLine1ThreeDSecure":{"id":"components/schemas/CustomerAddressLine1ThreeDSecure","kind":"json-schema","title":"CustomerAddressLine1ThreeDSecure","data":{"type":"string","maxLength":30,"example":"65 Easy St","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder’s street address exactly as it appears on their billing statement. This field is used in AVS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/CustomerAddressLine2":{"id":"components/schemas/CustomerAddressLine2","kind":"json-schema","title":"CustomerAddressLine2","data":{"type":"string","example":"Apt 124","maxLength":30,"description":"Customer address line 2.\n"}},"components/schemas/CustomerCityThreeDSecure":{"id":"components/schemas/CustomerCityThreeDSecure","kind":"json-schema","title":"CustomerCityThreeDSecure","data":{"type":"string","example":"Las Vegas","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer address city."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/CustomerRegionThreeDSecure":{"id":"components/schemas/CustomerRegionThreeDSecure","kind":"json-schema","title":"CustomerRegionThreeDSecure","data":{"type":"string","maxLength":3,"example":"NV","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A level 2 country subdivision code according to ISO-3166-2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/CustomerPostalCodeThreeDSecure":{"id":"components/schemas/CustomerPostalCodeThreeDSecure","kind":"json-schema","title":"CustomerPostalCodeThreeDSecure","data":{"type":"string","minLength":1,"maxLength":9,"example":"65144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder’s ZIP/postal code from their billing statement. This field is used in AVS. Do not include special characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field only allows alphanumeric characters (a-z, A-Z, 0-9). Special characters including - are not allowed. If you are sending in zip+4 you must not include the dash so 89134-1234 would be sent as 891341234"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/CustomerCountryThreeDSecure":{"id":"components/schemas/CustomerCountryThreeDSecure","kind":"json-schema","title":"CustomerCountryThreeDSecure","data":{"type":"string","example":"US","maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 character ISO Country Code. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" website for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/ShippingAddressLine1ThreeDSecure":{"id":"components/schemas/ShippingAddressLine1ThreeDSecure","kind":"json-schema","title":"ShippingAddressLine1ThreeDSecure","data":{"type":"string","example":"65 Easy St","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping street address - Line 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/ShippingCityThreeDSecure":{"id":"components/schemas/ShippingCityThreeDSecure","kind":"json-schema","title":"ShippingCityThreeDSecure","data":{"type":"string","example":"Las Vegas","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address - City"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/ShippingCountryThreeDSecure":{"id":"components/schemas/ShippingCountryThreeDSecure","kind":"json-schema","title":"ShippingCountryThreeDSecure","data":{"type":"string","example":"US","maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address - 2 character ISO Country Code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/ShippingPostalCodeThreeDSecure":{"id":"components/schemas/ShippingPostalCodeThreeDSecure","kind":"json-schema","title":"ShippingPostalCodeThreeDSecure","data":{"type":"string","minLength":5,"maxLength":9,"example":"65144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address - Postal Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/ShippingRegionThreeDSecure":{"id":"components/schemas/ShippingRegionThreeDSecure","kind":"json-schema","title":"ShippingRegionThreeDSecure","data":{"type":"string","example":"NV","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address - A level 2 country subdivision code according to ISO-3166-2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for increasing the possibility of frictionless flow"},"children":[]}]}]}]}]}},"components/schemas/CustomerShipping3DSecure":{"id":"components/schemas/CustomerShipping3DSecure","kind":"json-schema","title":"CustomerShipping3DSecure","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threeDSecure.addressMatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 'false'"},"children":[]}]}]}]}],"properties":{"addressLine1":{"$ref":"#/components/schemas/ShippingAddressLine1ThreeDSecure"},"addressLine2":{"$ref":"#/components/schemas/ShippingAddressLine2"},"city":{"$ref":"#/components/schemas/ShippingCityThreeDSecure"},"country":{"$ref":"#/components/schemas/ShippingCountryThreeDSecure"},"postalCode":{"$ref":"#/components/schemas/ShippingPostalCodeThreeDSecure"},"region":{"$ref":"#/components/schemas/ShippingRegionThreeDSecure"}}}},"components/schemas/ThreeDSecureInitiateStandalone":{"id":"components/schemas/ThreeDSecureInitiateStandalone","kind":"json-schema","title":"ThreeDSecureInitiateStandalone","data":{"type":"string","enum":["01","03"],"writeOnly":true,"example":"03","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to initiate the 3D Secure authentication process"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force 3D Secure authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate 3D Secure according to the 3D Secure Adviser result"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureBrowserAcceptHeader":{"id":"components/schemas/ThreeDSecureBrowserAcceptHeader","kind":"json-schema","title":"ThreeDSecureBrowserAcceptHeader","data":{"type":"string","example":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","minLength":0,"maxLength":2048,"description":"Exact content of the HTTP accept headers.\n"}},"components/schemas/ThreeDSecureBrowserJavaEnabled":{"id":"components/schemas/ThreeDSecureBrowserJavaEnabled","kind":"json-schema","title":"ThreeDSecureBrowserJavaEnabled","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the cardholder's browser has the ability to execute Java."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's browser does have the ability to execute Java."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's browser does not have the ability to execute Java."},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureBrowserJavascriptEnabled":{"id":"components/schemas/ThreeDSecureBrowserJavascriptEnabled","kind":"json-schema","title":"ThreeDSecureBrowserJavascriptEnabled","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the cardholder's browser has the ability to execute Javascript."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's browser does have the ability to execute Javascript."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder's browser does not have the ability to execute Javascript."},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureBrowserLanguage":{"id":"components/schemas/ThreeDSecureBrowserLanguage","kind":"json-schema","title":"ThreeDSecureBrowserLanguage","data":{"type":"string","example":"en-GB","minLength":2,"maxLength":16,"description":"Value representing the browser language as defined in IETF BCP47.\n"}},"components/schemas/ThreeDSecureBrowserColorDepth":{"id":"components/schemas/ThreeDSecureBrowserColorDepth","kind":"json-schema","title":"ThreeDSecureBrowserColorDepth","data":{"type":"string","enum":["1","4","8","15","16","24","32","48"],"example":"48","minLength":1,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Accepted values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 bit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"16 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"32"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"32 bits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"48"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"48 bits"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureBrowserScreenWidth":{"id":"components/schemas/ThreeDSecureBrowserScreenWidth","kind":"json-schema","title":"ThreeDSecureBrowserScreenWidth","data":{"type":"integer","example":1920,"minLength":1,"maxLength":6,"description":"Total height of the Cardholder's screen in pixels.\n"}},"components/schemas/ThreeDSecureBrowserScreenHeight":{"id":"components/schemas/ThreeDSecureBrowserScreenHeight","kind":"json-schema","title":"ThreeDSecureBrowserScreenHeight","data":{"type":"integer","example":1080,"minLength":1,"maxLength":6,"description":"Total height of the Cardholder's screen in pixels.\n"}},"components/schemas/ThreeDSecureBrowserTZ":{"id":"components/schemas/ThreeDSecureBrowserTZ","kind":"json-schema","title":"ThreeDSecureBrowserTZ","data":{"type":"integer","example":-480,"minLength":1,"maxLength":5,"description":"Time difference between UTC time and the Cardholder browser local time, in minutes.\n"}},"components/schemas/ThreeDSecureBrowser":{"id":"components/schemas/ThreeDSecureBrowser","kind":"json-schema","title":"ThreeDSecureBrowser","data":{"type":"object","required":["acceptHeader","javaEnabled","javascriptEnabled","language","colorDepth","screenWidth","screenHeight","tz"],"properties":{"acceptHeader":{"$ref":"#/components/schemas/ThreeDSecureBrowserAcceptHeader"},"javaEnabled":{"$ref":"#/components/schemas/ThreeDSecureBrowserJavaEnabled"},"javascriptEnabled":{"$ref":"#/components/schemas/ThreeDSecureBrowserJavascriptEnabled"},"language":{"$ref":"#/components/schemas/ThreeDSecureBrowserLanguage"},"colorDepth":{"$ref":"#/components/schemas/ThreeDSecureBrowserColorDepth"},"screenWidth":{"$ref":"#/components/schemas/ThreeDSecureBrowserScreenWidth"},"screenHeight":{"$ref":"#/components/schemas/ThreeDSecureBrowserScreenHeight"},"tz":{"$ref":"#/components/schemas/ThreeDSecureBrowserTZ"}}}},"components/schemas/ThreeDSecureHeaderContent":{"id":"components/schemas/ThreeDSecureHeaderContent","kind":"json-schema","title":"ThreeDSecureHeaderContent","data":{"type":"string","example":"userAgent header","maxLength":255,"description":"Exact content of the HTTP user-agent header.\n"}},"components/schemas/ThreeDSecureChallengeWindowSize":{"id":"components/schemas/ThreeDSecureChallengeWindowSize","kind":"json-schema","title":"ThreeDSecureChallengeWindowSize","data":{"type":"string","enum":["01","02","03","04","05"],"example":"05","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimensions of the challenge window that will be displayed to the cardholder. The issuer replies with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured window sizes are given in “width x height” in pixels."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"250 x 400"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"390 x 400"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 x 600"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"600 x 400"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full screen"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureTransType":{"id":"components/schemas/ThreeDSecureTransType","kind":"json-schema","title":"ThreeDSecureTransType","data":{"type":"string","enum":["01","03","10","11","28"],"example":"01","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of transaction being authenticated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values are derived from ISO 8583."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Goods / Service purchase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check Acceptance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Funding"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quasi-Cash Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"28"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid activation and Loan"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureChannel":{"id":"components/schemas/ThreeDSecureChannel","kind":"json-schema","title":"ThreeDSecureChannel","data":{"type":"string","enum":["01","02","03"],"example":"02","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of channel interface being used to initiate the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App-based (APP)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser (BRW)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS Requestor Initiated (3RI)"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureAddressMatch":{"id":"components/schemas/ThreeDSecureAddressMatch","kind":"json-schema","title":"ThreeDSecureAddressMatch","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are identical."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping Address matches Billing Address"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping Address does not match Billing Address"},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureReqChallengeInd":{"id":"components/schemas/ThreeDSecureReqChallengeInd","kind":"json-schema","title":"ThreeDSecureReqChallengeInd","data":{"type":"string","enum":["01","02","03","04","05","06","07","08","09"],"example":"02","minLength":2,"maxLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a challenge is requested for this transaction. For example: For payment authentication, a merchant may have concerns about the transaction, and request a challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No preference"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No challenge requested"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenge requested by merchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenge requested: Mandate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Challenge Requested, transactional risk analysis is already performed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Challenge Requested, Data share only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Challenge Requested, SCA is already performed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No challenge requested (utilise whitelist exemption if no challenge required)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"09"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenge requested (whitelist prompt requested if challenge required)\""},"children":[]}]}]}]}]}]}]}},"components/schemas/CompletionURL3DSRequest":{"id":"components/schemas/CompletionURL3DSRequest","kind":"json-schema","title":"CompletionURL3DSRequest","data":{"type":"string","example":"https://merchant.com/completion","description":"Contains the merchant URL to which the browser should be  redirected after the challenge session.\n"}},"components/schemas/3dsecure_standalone_cardnumber":{"id":"components/schemas/3dsecure_standalone_cardnumber","kind":"json-schema","title":"Card Number","data":{"title":"Card Number","type":"object","required":["dateTime","amount","transaction","card","customer","currencyCode","threeDSecure","completionUrl"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"type":"object","required":["firstName","lastName","emailAddress","ipAddress"],"properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"phoneCountry":{"$ref":"#/components/schemas/CustomerPhoneCountry"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1ThreeDSecure"},"addressLine2":{"$ref":"#/components/schemas/CustomerAddressLine2"},"city":{"$ref":"#/components/schemas/CustomerCityThreeDSecure"},"region":{"$ref":"#/components/schemas/CustomerRegionThreeDSecure"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCodeThreeDSecure"},"country":{"$ref":"#/components/schemas/CustomerCountryThreeDSecure"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"shipping":{"$ref":"#/components/schemas/CustomerShipping3DSecure"}}},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"},"securityCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Send when processing a 3D Secure transaction in the US. This object should be sent for initial card on file request but is not required for subsequent merchant initiated  charges."},"children":[]}]}]}]}],"required":["indicator","value"],"properties":{"indicator":{"$ref":"#/components/schemas/CardSecurityCodeIndicator"},"value":{"$ref":"#/components/schemas/CardSecurityCodeValue"}}}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"}}},"threeDSecure":{"type":"object","required":["initiate","browser","headerContent","challengeWindowSize","transType","channel"],"properties":{"initiate":{"$ref":"#/components/schemas/ThreeDSecureInitiateStandalone"},"browser":{"$ref":"#/components/schemas/ThreeDSecureBrowser"},"headerContent":{"$ref":"#/components/schemas/ThreeDSecureHeaderContent"},"challengeWindowSize":{"$ref":"#/components/schemas/ThreeDSecureChallengeWindowSize"},"transType":{"$ref":"#/components/schemas/ThreeDSecureTransType"},"channel":{"$ref":"#/components/schemas/ThreeDSecureChannel"},"addressMatch":{"$ref":"#/components/schemas/ThreeDSecureAddressMatch"},"reqChallengeInd":{"$ref":"#/components/schemas/ThreeDSecureReqChallengeInd"}}},"completionUrl":{"$ref":"#/components/schemas/CompletionURL3DSRequest"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2022-05-04T09:18:23.283-07:00","amount":{"total":160},"currencyCode":"EUR","customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"card":{"number":"4012000098765439","expirationDate":1225,"present":"N"},"transaction":{"invoice":"730518","notes":"Transaction notes are added here"},"threeDSecure":{"initiate":"03","browser":{"acceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","javaEnabled":true,"javascriptEnabled":true,"language":"en-GB","colorDepth":"48","screenWidth":1920,"screenHeight":1080,"tz":-480},"headerContent":"userAgent header","challengeWindowSize":"05","transType":"01","channel":"02"},"completionUrl":"https://merchant.com/completion","apiOptions":["ALLOWPARTIALAUTH"]}}},"components/schemas/3dsecure_standalone_token_gtv":{"id":"components/schemas/3dsecure_standalone_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","transaction","card","customer","currencyCode","threeDSecure","completionUrl"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"type":"object","required":["firstName","lastName","emailAddress","ipAddress"],"properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"phoneCountry":{"$ref":"#/components/schemas/CustomerPhoneCountry"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1ThreeDSecure"},"addressLine2":{"$ref":"#/components/schemas/CustomerAddressLine2"},"city":{"$ref":"#/components/schemas/CustomerCityThreeDSecure"},"region":{"$ref":"#/components/schemas/CustomerRegionThreeDSecure"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCodeThreeDSecure"},"country":{"$ref":"#/components/schemas/CustomerCountryThreeDSecure"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"shipping":{"$ref":"#/components/schemas/CustomerShipping3DSecure"}}},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"present":{"$ref":"#/components/schemas/CardPresent"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskIdRequest"}}},"threeDSecure":{"type":"object","required":["initiate","browser","headerContent","challengeWindowSize","transType","channel"],"properties":{"initiate":{"$ref":"#/components/schemas/ThreeDSecureInitiateStandalone"},"browser":{"$ref":"#/components/schemas/ThreeDSecureBrowser"},"headerContent":{"$ref":"#/components/schemas/ThreeDSecureHeaderContent"},"challengeWindowSize":{"$ref":"#/components/schemas/ThreeDSecureChallengeWindowSize"},"transType":{"$ref":"#/components/schemas/ThreeDSecureTransType"},"channel":{"$ref":"#/components/schemas/ThreeDSecureChannel"},"addressMatch":{"$ref":"#/components/schemas/ThreeDSecureAddressMatch"},"reqChallengeInd":{"$ref":"#/components/schemas/ThreeDSecureReqChallengeInd"}}},"completionUrl":{"$ref":"#/components/schemas/CompletionURL3DSRequest"},"risk":{"$ref":"#/components/schemas/RiskTransactionRequest"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"}},"example":{"dateTime":"2022-05-04T09:18:23.283-07:00","amount":{"total":160},"currencyCode":"EUR","customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"card":{"token":{"value":"8048471746471119"},"expirationDate":1225,"present":"N"},"transaction":{"invoice":"730518","notes":"Transaction notes are added here"},"threeDSecure":{"initiate":"03","browser":{"acceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","javaEnabled":true,"javascriptEnabled":true,"language":"en-GB","colorDepth":"48","screenWidth":1920,"screenHeight":1080,"tz":-480},"headerContent":"userAgent header","challengeWindowSize":"05","transType":"01","channel":"02"},"completionUrl":"https://merchant.com/completion","apiOptions":["ALLOWPARTIALAUTH"]}}},"components/schemas/TransactionResponseCode3DSStandalone":{"id":"components/schemas/TransactionResponseCode3DSStandalone","kind":"json-schema","title":"TransactionResponseCode3DSStandalone","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","C","D","e","f","P","R","S"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D Secure process was approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D Secure process was declined."},"children":[]}]}]}]}]}]}]}},"components/schemas/ThreeDSecureTrxId":{"id":"components/schemas/ThreeDSecureTrxId","kind":"json-schema","title":"ThreeDSecureTrxId","data":{"type":"string","example":"a7bbd49a-ffe6-49b2-8a92-541f0a3b053d","maxLength":36,"description":"The assigned 3D Secure transaction ID\n"}},"components/schemas/ThreeDSecureCardholderInfo":{"id":"components/schemas/ThreeDSecureCardholderInfo","kind":"json-schema","title":"ThreeDSecureCardholderInfo","data":{"type":"string","example":"We+were+unable+to+confirm+your+payment.Please+contact+us+on+0800+121+4251+quoting+the+reference+AL01","description":"Provides additional information to the customer in particular cases when 3D secure Authentication failed.\n"}},"components/schemas/CardResponse3DSChallenge":{"id":"components/schemas/CardResponse3DSChallenge","kind":"json-schema","title":"CardResponse3DSChallenge","data":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}}},"components/schemas/TransactionResponseCode3DSFingerprint":{"id":"components/schemas/TransactionResponseCode3DSFingerprint","kind":"json-schema","title":"TransactionResponseCode3DSFingerprint","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"H","enum":["H"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response code indicating that the 3D Secure transaction requires device fingerprinting."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"H"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device fingerprinting required. Issuer fingerprint URL returned in the redirectURL field. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/advanced-concepts/3d-secure#handling-device-fingerprint-response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling Device Fingerprint Response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on how to handle the Device Fingerprint process."},"children":[]}]}]}]}]}]}]}},"components/schemas/RedirectURL3DSResponse":{"id":"components/schemas/RedirectURL3DSResponse","kind":"json-schema","title":"RedirectURL3DSResponse","data":{"type":"string","example":"https://issuer.com/challenge","description":"URL to redirect the browser to the 3D Secure transaction response indicates a Device Fingerprint or 3D Secure challenge is required.\n"}},"components/schemas/TransactionResponseCode3DSChallenge":{"id":"components/schemas/TransactionResponseCode3DSChallenge","kind":"json-schema","title":"TransactionResponseCode3DSChallenge","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"G","enum":["G"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response code indicating that the 3D Secure transaction requires a challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"G"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure challenge required. Issuer challenge URL returned in the redirectURL field."},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseReasonCode3DSecure":{"id":"components/schemas/HostResponseReasonCode3DSecure","kind":"json-schema","title":"HostResponseReasonCode3DSecure","data":{"type":"string","example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a response code from the host."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-69"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction has been declined. Invalid 3ds_version parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-68"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication process timed out. Please try again."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-66"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid combination of 3ds values"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-65"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merhant is not allowed for this exemption"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-64"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exemption is not allowed for this transaction amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-63"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant is not enrolled to 3D-secure service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-50"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An error occurred during the 3D secure process"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-39"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to be registered with the 3D Adviser service to complete the request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-37"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction has been denied. Malformed or missing parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-36"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected processor does not support some of the parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-35"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant is not registered."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-33"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to be registered with the routing service to complete the routing request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-32"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are not registered with the selected Processor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Failed due to error in 3D secure process."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-20"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication error. Please contact support."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-17"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected service is unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected service is unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected service is unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant is not enrolled in the 3D Secure Adviser service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction has been declined due to security restrictions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejected. Format Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System error. Please contact support."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter(s) malformed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter(s) malformed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact support."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction was declined by the gateway and will not be processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been denied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The queried transaction is currently being processed. Please try again."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been denied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been denied."},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseReasonDescription3DSecure":{"id":"components/schemas/HostResponseReasonDescription3DSecure","kind":"json-schema","title":"HostResponseReasonDescription3DSecure","data":{"type":"string","maxLength":73,"example":"Pick Up Card","description":"Returns a description from the host.\n"}},"components/schemas/ThreeDSecureCompInd":{"id":"components/schemas/ThreeDSecureCompInd","kind":"json-schema","title":"ThreeDSecureCompInd","data":{"type":"string","enum":["Y","N","U"],"example":"Y","minLength":1,"maxLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether or not the device fingerprint was completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionInvoiceAlphanumeric":{"id":"components/schemas/TransactionInvoiceAlphanumeric","kind":"json-schema","title":"TransactionInvoiceAlphanumeric","data":{"type":"string","maxLength":10,"example":"0510093358","description":"10 character invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway.\n"}},"components/schemas/CustomerFirstNameAPM":{"id":"components/schemas/CustomerFirstNameAPM","kind":"json-schema","title":"CustomerFirstNameAPM","data":{"type":"string","maxLength":30,"example":"John","description":"Customer first name\n"}},"components/schemas/CustomerLastNameAPM":{"id":"components/schemas/CustomerLastNameAPM","kind":"json-schema","title":"CustomerLastNameAPM","data":{"type":"string","maxLength":30,"example":"Smith","description":"Customer last name\n"}},"components/schemas/CustomerCompanyName":{"id":"components/schemas/CustomerCompanyName","kind":"json-schema","title":"CustomerCompanyName","data":{"type":"string","maxLength":30,"example":"Shift4","description":"Customer Company name\n"}},"components/schemas/oct_payout_unencryptedcard":{"id":"components/schemas/oct_payout_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","transaction","card","customer","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["number","expirationDate","entryMode","present"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryModeManual"},"present":{"$ref":"#/components/schemas/CardPresent"},"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"}}},"customer":{"oneOf":[{"title":"First and Last Name","type":"object","required":["firstName","lastName","emailAddress","ipAddress"],"properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameAPM"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameAPM"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},{"title":"Company Name","type":"object","required":["companyName","emailAddress","ipAddress"],"properties":{"companyName":{"$ref":"#/components/schemas/CustomerCompanyName"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}}]},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":135.87},"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119","present":"N"},"customer":{"firstName":"John","lastName":"Smith","emailAddress":"johnsmith@email.com","ipAddress":"63.57.84.101"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here"},"sourceIp":"172.110.166.244"}}},"components/schemas/oct_payout_token_gtv":{"id":"components/schemas/oct_payout_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","transaction","card","customer","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"card":{"type":"object","required":["token"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryModeManual"},"present":{"$ref":"#/components/schemas/CardPresent"},"token":{"$ref":"#/components/schemas/CardTokenRequired"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"}}},"customer":{"oneOf":[{"title":"First and Last Name","type":"object","required":["firstName","lastName","emailAddress","ipAddress"],"properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameAPM"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameAPM"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},{"title":"Company Name","type":"object","required":["companyName","emailAddress","ipAddress"],"properties":{"companyName":{"$ref":"#/components/schemas/CustomerCompanyName"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}}]},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":135.87},"card":{"token":{"value":"8048471746471119"}},"customer":{"companyName":"Shift4","emailAddress":"johnsmith@email.com","ipAddress":"63.57.84.101"},"transaction":{"invoice":"192029","notes":"Transaction notes are added here"},"sourceIp":"172.110.166.244"}}},"components/schemas/AmountFeeOCT":{"id":"components/schemas/AmountFeeOCT","kind":"json-schema","title":"AmountFeeOCT","data":{"type":"number","maxLength":14,"example":1.5,"description":"The fee charged to process the OCT transaction.\n"}},"components/schemas/TransactionAuthSourceAPM":{"id":"components/schemas/TransactionAuthSourceAPM","kind":"json-schema","title":"TransactionAuthSourceAPM","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a response, a code returned by the processor to indicate which host issued the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APM (Online)"},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseOCT":{"id":"components/schemas/HostResponseOCT","kind":"json-schema","title":"HostResponseOCT","data":{"type":"object","description":"Returns the response code detailing why the transaction was declined. \n","properties":{"reasonCode":{"$ref":"#/components/schemas/HostResponseReasonCode"},"reasonDescription":{"$ref":"#/components/schemas/HostResponseReasonDescription"}}}},"components/schemas/TransactionRetrievalReferenceOCT":{"id":"components/schemas/TransactionRetrievalReferenceOCT","kind":"json-schema","title":"TransactionRetrievalReferenceOCT","data":{"type":"string","readOnly":true,"maxLength":32,"example":"ICTN-178768-233-79170-FUX","description":"Reference retrieval number assigned by the authorizing agency. This value is printed on some receipts.\n"}},"components/schemas/ErrorCodeNoCondition":{"id":"components/schemas/ErrorCodeNoCondition","kind":"json-schema","title":"ErrorCodeNoCondition","data":{"type":"integer","maxLength":5,"readOnly":true,"example":64100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the type of error that occurred. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this document for more details."},"children":[]}]}]}]}},"components/schemas/ErrorNoPrimarySecondary":{"id":"components/schemas/ErrorNoPrimarySecondary","kind":"json-schema","title":"ErrorNoPrimarySecondary","data":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ErrorCodeNoCondition"},"severity":{"$ref":"#/components/schemas/ErrorSeverity"},"shortText":{"$ref":"#/components/schemas/ErrorShortText"},"longText":{"$ref":"#/components/schemas/ErrorLongText"}}}},"components/schemas/CustomerNewEmailAddress":{"id":"components/schemas/CustomerNewEmailAddress","kind":"json-schema","title":"CustomerNewEmailAddress","data":{"type":"string","maxLength":80,"example":"firstname.lastname@email.com","description":"Customer's new email address.\n"}},"components/schemas/ACHVerificationTypePrenotification":{"id":"components/schemas/ACHVerificationTypePrenotification","kind":"json-schema","title":"ACHVerificationTypePrenotification","data":{"type":"string","example":"P","enum":["P"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of verification used to validate the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prenotification"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionResponseCodeACHPending":{"id":"components/schemas/TransactionResponseCodeACHPending","kind":"json-schema","title":"TransactionResponseCodeACHPending","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"P","enum":["P"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH transaction is pending"},"children":[]}]}]}]}]}]}]}},"components/schemas/NotificationId":{"id":"components/schemas/NotificationId","kind":"json-schema","title":"NotificationId","data":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"example":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","description":"Notification ID value generated by Shift4 and returned in the response. Used for matching webhook notifications back to their original request.\n"}},"components/schemas/AmountTotalACH":{"id":"components/schemas/AmountTotalACH","kind":"json-schema","title":"AmountTotalACH","data":{"type":"number","maxLength":11,"example":143.29,"description":"The amount being processed for the ACH transaction. The amount must be greater than zero with a maximum amount of 99999999.99.\n"}},"components/schemas/AmountACH":{"id":"components/schemas/AmountACH","kind":"json-schema","title":"AmountACH","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]}],"required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotalACH"}}}},"components/schemas/ACHPaymentTypeCode":{"id":"components/schemas/ACHPaymentTypeCode","kind":"json-schema","title":"ACHPaymentTypeCode","data":{"type":"string","example":"ST","enum":["S","R","ST"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment type. If not provided in the request the transaction will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Entry. Consumer authorizes the use of their ACH credentials for a single transaction. Each subsequent transaction requires the Consumer to authorize the use of their credentials."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring. Transaction is sent on a set time frame for a set amount. For example, a monthly gym membership."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standing Authorization. Consumer authorizes the use of their ACH credentials for the initial and subsequent transactions. Each subsequent transaction does not require the consumer to authorize the use of their credentials."},"children":[]}]}]}]}]}]}]}},"components/schemas/ach_sale_bankaccount":{"id":"components/schemas/ach_sale_bankaccount","kind":"json-schema","title":"Bank & Routing Number","data":{"title":"Bank & Routing Number","type":"object","required":["dateTime","amount","transaction","ach","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"ach":{"type":"object","required":["accountNumber","routingNumber","accountType","accountHolderName"],"properties":{"accountNumber":{"$ref":"#/components/schemas/ACHAccountNumber"},"routingNumber":{"$ref":"#/components/schemas/ACHRoutingNumber"},"accountType":{"$ref":"#/components/schemas/ACHAccountType"},"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"},"paymentTypeCode":{"$ref":"#/components/schemas/ACHPaymentTypeCode"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"transaction":{"invoice":"192029"},"ach":{"accountNumber":"1234567890","routingNumber":"121000248","accountHolderName":"John Smith","accountType":"PC"},"sourceIp":"172.110.166.244"}}},"components/schemas/ACHVerifyBalance":{"id":"components/schemas/ACHVerifyBalance","kind":"json-schema","title":"ACHVerifyBalance","data":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to verify the balance before processing the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balance check will only be possible if the customer logged into their bank account when verifying their account. If the account was verified via Micro Deposits or Prenotification it is not possible to verify the balance. If the balance check is not possible this value will be ignored and the transaction will be processed."},"children":[]}]}]}]}},"components/schemas/ach_sale_token_gtv":{"id":"components/schemas/ach_sale_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","transaction","sourceIp","token"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"ach":{"type":"object","properties":{"verifyBalance":{"$ref":"#/components/schemas/ACHVerifyBalance"},"paymentTypeCode":{"$ref":"#/components/schemas/ACHPaymentTypeCode"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"transaction":{"invoice":"192029"},"token":{"value":"9829283019231234"},"ach":{"verifyBalance":true},"sourceIp":"172.110.166.244"}}},"components/schemas/ACHBalanceVerificationResult":{"id":"components/schemas/ACHBalanceVerificationResult","kind":"json-schema","title":"ACHBalanceVerificationResult","data":{"type":"string","example":"VS","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not the balance was verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance was verified and requested amount is below account balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance was verified and account balance is less then the requested amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unable to check balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account does not support balance verification"},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionResponseCodeACH":{"id":"components/schemas/TransactionResponseCodeACH","kind":"json-schema","title":"TransactionResponseCodeACH","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"P","enum":["P","D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH transaction is pending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH transaciton was declined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH transaction resulted in an error."},"children":[]}]}]}]}]}]}]}},"components/schemas/ach_refund_bankaccount":{"id":"components/schemas/ach_refund_bankaccount","kind":"json-schema","title":"Bank & Routing Number","data":{"title":"Bank & Routing Number","type":"object","required":["dateTime","amount","transaction","ach","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice","originalInvoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"ach":{"type":"object","required":["accountNumber","routingNumber","accountType","accountHolderName"],"properties":{"accountNumber":{"$ref":"#/components/schemas/ACHAccountNumber"},"routingNumber":{"$ref":"#/components/schemas/ACHRoutingNumber"},"accountType":{"$ref":"#/components/schemas/ACHAccountType"},"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"transaction":{"invoice":"192030","originalInvoice":"192029"},"ach":{"accountNumber":"1234567890","routingNumber":"121000248","accountType":"PC","accountHolderName":"John Smith"},"sourceIp":"172.110.166.244"}}},"components/schemas/ach_refund_token_gtv":{"id":"components/schemas/ach_refund_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","transaction","sourceIp","token"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice","originalInvoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"transaction":{"invoice":"192030","originalInvoice":"192029"},"token":{"value":"9829283019231234"},"sourceIp":"172.110.166.244"}}},"components/schemas/TransactionTypeACH":{"id":"components/schemas/TransactionTypeACH","kind":"json-schema","title":"TransactionTypeACH","data":{"type":"string","example":"Sale","enum":["S","R","V","B","D"],"description":"Specifies the ACH transaction type.\n"}},"components/schemas/HostResponseReasonCodeACH":{"id":"components/schemas/HostResponseReasonCodeACH","kind":"json-schema","title":"HostResponseReasonCodeACH","data":{"type":"string","maxLength":3,"example":"R01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a response code from the host."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect DFI Account Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect Routing Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect Routing Number and Incorrect DFI Account Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect Transaction Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect DFI Account Number and Incorrect Transaction Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorrect Routing Number, Incorrect DFI Account Number, and Incorrect Transaction Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R01"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Insufficient Funds"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R02"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Closed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R03"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Account/ Unable to Locate Account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R04"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Account Number Structure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized Debit to Consumer Account Using Corporate SEC Code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned per ODFI’s Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization Revoked by Customer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R08"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Stopped"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R09"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uncollected Funds"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Advises Originator is Not Known to Receiver and/or Originator is Not Authorized by Receiver to Debit Receiver’s Account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Advises Entry Not in Accordance with the Terms of the Authorization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Sold to Another DFI"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid ACH Routing Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R14"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representative Payee Deceased or Unable to Continue in That Capacity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary or Account Holder (Other Than a Representative Payee) Deceased"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Frozen/Entry Returned Per OFAC Instruction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R17"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Record Edit Criteria/Entry with Invalid Account Number Initiated Under Questionable Circumstances/Return of Improperly-Intiated Reversal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R18"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improper Effective Entry Date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R19"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount Field Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R20"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-Transaction Account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R21"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Company Identification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R22"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Individual ID Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R23"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Entry Refused by Receiver"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate Entry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R25"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addenda Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R26"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory Field Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R27"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trace Number Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R28"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Number Check Digit Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R29"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corporate Customer Advises Not Authorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDFI Not Participant in Check Truncation Program"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R31"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissible Return Entry (CCD and CTX only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R32"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDFI Non-Settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R33"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return of XCK Entry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R34"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Participation DFI"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R35"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return of Improper Debit Entry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R36"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return of Improper Credit Entry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R37"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source Document Presented for Payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R38"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop Payment on Source Document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R39"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improper Source Document/Source Document Presented for Payment"},"children":[]}]}]}]}]}]}]}},"components/schemas/HostResponseReasonDescriptionACH":{"id":"components/schemas/HostResponseReasonDescriptionACH","kind":"json-schema","title":"HostResponseReasonDescriptionACH","data":{"type":"string","maxLength":130,"example":"Insufficient Funds","description":"Returns a description from the host.\n"}},"components/schemas/HostResponseACH":{"id":"components/schemas/HostResponseACH","kind":"json-schema","title":"HostResponseACH","data":{"type":"object","description":"Returns the response code detailing why the transaction was declined. \n","properties":{"reasonCode":{"$ref":"#/components/schemas/HostResponseReasonCodeACH"},"reasonDescription":{"$ref":"#/components/schemas/HostResponseReasonDescriptionACH"}}}},"components/schemas/ACHPlaidLinkTokenClientUserId":{"id":"components/schemas/ACHPlaidLinkTokenClientUserId","kind":"json-schema","title":"ACHPlaidLinkTokenClientUserId","data":{"type":"string","example":"ae1a59fe-8646-4637-bbb8-d270856c508c","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id."},"children":[]}]}]}]}},"components/schemas/ACHPlaidLinkTokenLanguage":{"id":"components/schemas/ACHPlaidLinkTokenLanguage","kind":"json-schema","title":"ACHPlaidLinkTokenLanguage","data":{"type":"string","example":"en","enum":["da","nl","en","et","fr","de","it","lv","lt","no","po","ro","es","se"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language that Link should be displayed in. If no language is sent it will default to English."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"da"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Danish"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dutch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"en"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"English"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"et"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estonian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fr"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"French"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"German"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Italian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lv"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latvian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lithuanian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Norwegian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"po"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Polish"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ro"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Romanian"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"es"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spanish"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"se"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swedish"},"children":[]}]}]}]}]}]}]}},"components/schemas/ACHPlaidLinkTokenRedirectUrl":{"id":"components/schemas/ACHPlaidLinkTokenRedirectUrl","kind":"json-schema","title":"ACHPlaidLinkTokenRedirectUrl","data":{"type":"string","example":"merchant.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the URL to which the browser should be redirected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if the customer is using a 'mobile device' or 'website with redirection'. Also the same url needs to be provided during onboarding or later via LBM."},"children":[]}]}]}]}]}},"components/schemas/TransactionResponseCodeACHPlaidLinkToken":{"id":"components/schemas/TransactionResponseCodeACHPlaidLinkToken","kind":"json-schema","title":"TransactionResponseCodeACHPlaidLinkToken","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"S","enum":["S","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Plaid link token request was successful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Plaid link token request was unsuccessful."},"children":[]}]}]}]}]}]}]}},"components/schemas/ACHPlaidLinkToken":{"id":"components/schemas/ACHPlaidLinkToken","kind":"json-schema","title":"ACHPlaidLinkToken","data":{"type":"string","readOnly":true,"example":"link-sandbox-bea285c1-ad79-4191-8d1b-aaf537f7df59","description":"Plaid Link Token\n"}},"components/schemas/ACHPlaidLinkTokenExpiration":{"id":"components/schemas/ACHPlaidLinkTokenExpiration","kind":"json-schema","title":"ACHPlaidLinkTokenExpiration","data":{"type":"string","readOnly":true,"example":"2023-02-13T21:00:25Z","description":"Plaid Link Token Expiration\n"}},"components/schemas/ACHPlaidPublicToken":{"id":"components/schemas/ACHPlaidPublicToken","kind":"json-schema","title":"ACHPlaidPublicToken","data":{"type":"string","example":"public-sandbox-0b7f845f-fa53-4e0a-b77b-9476e71be5ae","description":"Plaid Public Token\n"}},"components/schemas/ACHPlaidPublicTokenMetadata":{"id":"components/schemas/ACHPlaidPublicTokenMetadata","kind":"json-schema","title":"ACHPlaidPublicTokenMetadata","data":{"type":"string","example":"{\"status\":null,\"link_session_id\":\"81fcbacf-e2f8-422b-b041-5e629b32ae3c\",\"institution\":{\"name\":\"Houndstooth Bank\",\"institution_id\":\"ins_109512\"},\"accounts\":[{\"id\":\"dvMPrZ9kR1C8xdRvLR6QIaREG5vBo6SBjaRrr\",\"name\":\"Plaid Checking\",\"mask\":\"0000\",\"type\":\"depository\",\"subtype\":\"checking\",\"verification_status\":\"pending_automatic_verification\",\"class_type\":null}],\"account\":{\"id\":\"dvMPrZ9kR1C8xdRvLR6QIaREG5vBo6SBjaRrr\",\"name\":\"Plaid Checking\",\"mask\":\"0000\",\"type\":\"depository\",\"subtype\":\"checking\",\"verification_status\":\"pending_automatic_verification\",\"class_type\":null},\"account_id\":\"dvMPrZ9kR1C8xdRvLR6QIaREG5vBo6SBjaRrr\",\"transfer_status\":null,\"wallet\":null,\"public_token\":\"public-sandbox-b5e58738-1a75-4a51-b4de-10f24c561038\"}","description":"JSON encoded object received from the Plaid SDK. The metadata object received from the Plaid SDK must be json encoded and sent in this object.\n"}},"components/schemas/TransactionResponseCodeACHPlaidPublicTokenExchange":{"id":"components/schemas/TransactionResponseCodeACHPlaidPublicTokenExchange","kind":"json-schema","title":"TransactionResponseCodeACHPlaidPublicTokenExchange","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D","P"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Plaid public token exchange request was successful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Plaid public token exchange request was unsuccessful."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Plaid public token exchange request is using the automated microdeposit flow."},"children":[]}]}]}]}]}]}]}},"components/schemas/ACHAccountNumberLastFour":{"id":"components/schemas/ACHAccountNumberLastFour","kind":"json-schema","title":"ACHAccountNumberLastFour","data":{"type":"string","minLength":2,"maxLength":4,"example":"1234","description":"The last 2-4 alphanumeric characters of an account's official account number. \n"}},"components/schemas/UpdaterRequestId":{"id":"components/schemas/UpdaterRequestId","kind":"json-schema","title":"UpdaterRequestId","data":{"type":"string","format":"uuid","example":"bad91cf7-0664-40d5-877f-cd4cbe36fc9a","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updater Request ID. Returned in the response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/updater/updaterrequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API request. Sent in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/updater/updaterstatus"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Update Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request when checking on the status of a previous updater request."},"children":[]}]}]}]}},"components/schemas/UpdaterToken":{"id":"components/schemas/UpdaterToken","kind":"json-schema","title":"UpdaterToken","data":{"type":"string","maxLength":16,"description":"The token representing the card account number for which you are requesting an update.\n"}},"components/schemas/UpdaterCardsStatus":{"id":"components/schemas/UpdaterCardsStatus","kind":"json-schema","title":"UpdaterCardsStatus","data":{"type":"string","maxLength":1,"enum":["A","B","C","D","E","F","H","O","T","U"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the card update request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New account number and/or new expiration date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New expiration date, same account number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account is marked as closed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact cardholder for updated information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No updates were found but the account is valid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No match for the data provided. Participating BIN/ issuer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"H"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No match for the data provided. Non-participating BIN/issuer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder opted out from service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token not found / Invalid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown error"},"children":[]}]}]}]}]}]}]}},"components/schemas/UpdaterExpirationDate":{"id":"components/schemas/UpdaterExpirationDate","kind":"json-schema","title":"UpdaterExpirationDate","data":{"type":"string","minLength":4,"maxLength":4,"description":"The card's expiration date in MMYY format.\n"}},"components/schemas/UpdaterNewExpirationDate":{"id":"components/schemas/UpdaterNewExpirationDate","kind":"json-schema","title":"UpdaterNewExpirationDate","data":{"type":"string","minLength":4,"maxLength":4,"description":"The card's updated expiration date in MMYY format. \n"}},"components/schemas/UpdaterNewToken":{"id":"components/schemas/UpdaterNewToken","kind":"json-schema","title":"UpdaterNewToken","data":{"type":"string","maxLength":16,"description":"The token representing the new card number if the card has been replaced.\n"}},"components/schemas/UpdaterStatus":{"id":"components/schemas/UpdaterStatus","kind":"json-schema","title":"UpdaterStatus","data":{"type":"string","maxLength":1,"enum":["P","C"],"example":"C","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the card update request."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is not ready yet, please try again later."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is completed and sent in cards array."},"children":[]}]}]}]}]}]}]}},"components/schemas/dcc_ratelookup_token_gtv":{"id":"components/schemas/dcc_ratelookup_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","currencyCode","amount","clerk","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"card":{"token":{"value":"8048471746471119"}}}}},"components/schemas/dcc_ratelookup_token_legacy":{"id":"components/schemas/dcc_ratelookup_token_legacy","kind":"json-schema","title":"Legacy Token","data":{"title":"Legacy Token","type":"object","required":["dateTime","currencyCode","amount","clerk","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"token":{"$ref":"#/components/schemas/CardTokenRequiredLegacy"}}}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"card":{"token":{"value":"11191pn83hbkkety","serialNumber":"123456"}}}}},"components/schemas/dcc_ratelookup_p2pe_idtech":{"id":"components/schemas/dcc_ratelookup_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","currencyCode","amount","clerk","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"p2pe":{"data":"02df00801f2e1e00939b252a323232312a2a2a2a2a2a2a2a303030395e4d43322f4455414c20545241434b5e2a2a2a2a2a2a2a2a2a2a3f2a3b323232312a2a2a2a2a2a2a2a303030393d2a2a2a2a2a2a2a2a2a2a3f2aa0744ac45073ef2e516cd6b1111c990effb75fbe6521e40be763593c385c6c7cdcd41ffbabb59cd6c999bfe636dff9ef8408e38906db0fdc7497df96a3e8f564b9a4e1bd802f326eb9848b447512384700000000000000000000000000000000000000000000000000000000000000000000000000000000383237543839303939306299495001000000000521d503","format":"02"}}}},"components/schemas/EMVEncryptedTagsOnly":{"id":"components/schemas/EMVEncryptedTagsOnly","kind":"json-schema","title":"EMVEncryptedTagsOnly","data":{"type":"object","writeOnly":true,"description":"Encrypted EMV tags\n","required":["tlvData"],"properties":{"tlvData":{"type":"string","writeOnly":true,"example":"5A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C31799573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the P2PE encrypted tags (5A and 57) in standard TLV format.  The P2PE encrypted tags (5A and 57) will have the entire TLV string encrypted and the encrypted data will be in a TLV format using the same tag. For example, tag 5A would look like the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C3179"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decrypted: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5A084761739001010010"},"children":[]}]}]}]}]}}}},"components/schemas/dcc_ratelookup_p2pe_tdesdukpt_emv":{"id":"components/schemas/dcc_ratelookup_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","currencyCode","amount","clerk","card","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMVEncryptedTagsOnly"}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"p2pe":{"format":"05","ksn":"FFFF49517300010000CA"},"emv":{"tlvData":"5A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C31799573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B3"}}}},"components/schemas/dcc_ratelookup_p2pe_tdesdukpt_msr":{"id":"components/schemas/dcc_ratelookup_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","currencyCode","amount","clerk","card","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"card":{"type":"object","required":["entryMode"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"}}},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"p2pe":{"data":"44188C9A20DD2092254F7FEB0AABD531D86EA10DA37E5540C25B53658BA4FBB903828F835A7287481F6FB5C17A879ECC9768D4C12F99532A","format":"05","ksn":"FFFF49517300010000C9"}}}},"components/schemas/dcc_ratelookup_p2pe_onguardsde_emv":{"id":"components/schemas/dcc_ratelookup_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","currencyCode","amount","clerk","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"p2pe":{"data":"FFFF495A0000000200000002:E:0032:E0AB94F7704E77AB37F81A7E236A1ABC1465C6DFCE43A506240D6E7D6DDA7EA9","format":"03"}}}},"components/schemas/dcc_ratelookup_p2pe_onguardsde_msr":{"id":"components/schemas/dcc_ratelookup_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","currencyCode","amount","clerk","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"p2pe":{"data":"FFFF495A0000000200000005:4:0128:F48C880DE0DAF549E642C5CC25E65ADF9947E7EB0636DB80C4A490B4C0930AEF64B7201505343CED533A2AE9AFABFE6453875F705519A8109362197CA3BD8DA0FE90DB3F954B9CDA0DB58BDA3330862ADD28CB31EFDA7C641575E33D395D8BFF72EBF0B1FF9630DB0EAB080FE8C9B2FAC28127CDC48CA9F7D532D5BDE4CCE270","format":"03"}}}},"components/schemas/dcc_ratelookup_unencryptedcard":{"id":"components/schemas/dcc_ratelookup_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","currencyCode","amount","clerk","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"clerk":{"$ref":"#/components/schemas/Clerk"},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"}}}},"example":{"dateTime":"2024-07-09T09:18:23.283-07:00","currencyCode":"USD","amount":{"total":160},"clerk":{"numericId":1576},"card":{"entryMode":"M","expirationDate":1230,"number":"4321000000001119"}}}},"components/schemas/DCCSupportIndicator":{"id":"components/schemas/DCCSupportIndicator","kind":"json-schema","title":"DCCSupportIndicator","data":{"type":"string","enum":["0","1"],"example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether or not DCC can be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DCC cannot be used (Relevant for a BIN that is not supported / No relevant conversion)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful. DCC can be used."},"children":[]}]}]}]}]}]}]}},"components/schemas/DCCResponse":{"id":"components/schemas/DCCResponse","kind":"json-schema","title":"DCCResponse","data":{"type":"object","description":"Object containing Dynamic Currency Conversion (DCC) information.\n","properties":{"rateTimeStamp":{"$ref":"#/components/schemas/DCCRateTimeStamp"},"currencyCode":{"$ref":"#/components/schemas/DCCCurrencyCode"},"foreignAmount":{"$ref":"#/components/schemas/DCCForeignAmount"},"conversionRate":{"$ref":"#/components/schemas/DCCConversionRate"},"marginPercentage":{"$ref":"#/components/schemas/DCCMarginPercentage"},"currencyMinorUnits":{"$ref":"#/components/schemas/DCCCurrencyMinorUnits"},"transactionId":{"$ref":"#/components/schemas/DCCTransactionID"},"diffOverEcb":{"$ref":"#/components/schemas/DCCDiffOverECB"},"marginOverEcb":{"$ref":"#/components/schemas/DCCMarginOverECB"},"displayUnit":{"$ref":"#/components/schemas/DCCDisplayUnit"},"provider":{"$ref":"#/components/schemas/DCCProvider"},"supportIndicator":{"$ref":"#/components/schemas/DCCSupportIndicator"}}}},"components/schemas/RuleCheck":{"id":"components/schemas/RuleCheck","kind":"json-schema","title":"RuleCheck","data":{"type":"array","items":{"type":"string","enum":["SURCHARGE"]},"example":["SURCHARGE"],"writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which rule checks are being requested:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SURCHARGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks to see if a card is eligible for surcharging. If eligible the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surcharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object will be returned containing the surcharge percentage that can be applied."},"children":[]}]}]}]}]}]}]}},"components/schemas/TransactionRuleVerify":{"id":"components/schemas/TransactionRuleVerify","kind":"json-schema","title":"TransactionRuleVerify","data":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}},"components/schemas/ClerkOptional":{"id":"components/schemas/ClerkOptional","kind":"json-schema","title":"ClerkOptional","data":{"type":"object","properties":{"numericId":{"$ref":"#/components/schemas/ClerkNumericId"}}}},"components/schemas/rules_verify_token_gtv":{"id":"components/schemas/rules_verify_token_gtv","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["dateTime","amount","ruleCheck","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"card":{"type":"object","required":["token"],"properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"},"token":{"$ref":"#/components/schemas/CardTokenRequired"}}},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_p2pe_idtech":{"id":"components/schemas/rules_verify_p2pe_idtech","kind":"json-schema","title":"P2PE - ID TECH - EMV/MSR/Manual","data":{"title":"P2PE - ID TECH - EMV/MSR/Manual","type":"object","required":["dateTime","amount","ruleCheck","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"p2pe":{"$ref":"#/components/schemas/P2PEType0102IDTECH"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_p2pe_tdesdukpt_emv":{"id":"components/schemas/rules_verify_p2pe_tdesdukpt_emv","kind":"json-schema","title":"P2PE - TDES DUKPT - EMV","data":{"title":"P2PE - TDES DUKPT - EMV","type":"object","required":["dateTime","amount","ruleCheck","transaction","p2pe","emv"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTEMV"},"emv":{"$ref":"#/components/schemas/EMVEncryptedTagsOnly"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_p2pe_tdesdukpt_msr":{"id":"components/schemas/rules_verify_p2pe_tdesdukpt_msr","kind":"json-schema","title":"P2PE - TDES DUKPT - MSR/Manual","data":{"title":"P2PE - TDES DUKPT - MSR/Manual","type":"object","required":["dateTime","amount","ruleCheck","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"p2pe":{"$ref":"#/components/schemas/P2PEType05TDESDUKPTMSR"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_p2pe_onguardsde_emv":{"id":"components/schemas/rules_verify_p2pe_onguardsde_emv","kind":"json-schema","title":"P2PE - On-Guard SDE - EMV","data":{"title":"P2PE - On-Guard SDE - EMV","type":"object","required":["dateTime","amount","ruleCheck","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEEMV"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_p2pe_onguardsde_msr":{"id":"components/schemas/rules_verify_p2pe_onguardsde_msr","kind":"json-schema","title":"P2PE - On-Guard SDE - MSR/Manual","data":{"title":"P2PE - On-Guard SDE - MSR/Manual","type":"object","required":["dateTime","amount","ruleCheck","transaction","p2pe"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"p2pe":{"$ref":"#/components/schemas/P2PEType03OnguardSDEMSR"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/rules_verify_unencryptedcard":{"id":"components/schemas/rules_verify_unencryptedcard","kind":"json-schema","title":"Card Number Unencrypted","data":{"title":"Card Number Unencrypted","type":"object","required":["dateTime","amount","ruleCheck","transaction","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"ruleCheck":{"$ref":"#/components/schemas/RuleCheck"},"transaction":{"$ref":"#/components/schemas/TransactionRuleVerify"},"card":{"type":"object","required":["number","expirationDate"],"properties":{"number":{"$ref":"#/components/schemas/CardNumber"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDate"}}},"clerk":{"$ref":"#/components/schemas/ClerkOptional"}}}},"components/schemas/PaymentLinkId":{"id":"components/schemas/PaymentLinkId","kind":"json-schema","title":"PaymentLinkId","data":{"readOnly":true,"type":"string","example":"link_8kdskX8DZ8FR6W3acYPXiyAN","description":"Identifier of Payment Link\n"}},"components/schemas/PaymentLinkType":{"id":"components/schemas/PaymentLinkType","kind":"json-schema","title":"PaymentLinkType","data":{"type":"string","enum":["line_items","card_verification"],"default":"line_items","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of flow the payment link performs."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) — a standard payment flow. The customer pays for the products defined in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — performs a $0 authorization to confirm the card is valid (a security check that a real card and cardholder are behind it) "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charging it. The validated card is also saved to the customer. These links take "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a defined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When omitted, the link defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/PaymentLinkLineItemsProductName":{"id":"components/schemas/PaymentLinkLineItemsProductName","kind":"json-schema","title":"PaymentLinkLineItemsProductName","data":{"type":"string","example":"Example charge","description":"Name of a product"}},"components/schemas/PaymentLinkLineItemsProductDescription":{"id":"components/schemas/PaymentLinkLineItemsProductDescription","kind":"json-schema","title":"PaymentLinkLineItemsProductDescription","data":{"type":"string","example":"Some product description","description":"Description of a product, shown to the customer on the hosted checkout page directly under the product name"}},"components/schemas/PaymentLinkLineItemsProductAmountCurrencyCode":{"id":"components/schemas/PaymentLinkLineItemsProductAmountCurrencyCode","kind":"json-schema","title":"PaymentLinkLineItemsProductAmountCurrencyCode","data":{"type":"string","example":"USD","description":"currency represented as a three-letter ISO currency code"}},"components/schemas/PaymentLinkLineItemsProductAmountTotal":{"id":"components/schemas/PaymentLinkLineItemsProductAmountTotal","kind":"json-schema","title":"PaymentLinkLineItemsProductAmountTotal","data":{"type":"number","example":10,"description":"Payment amount (in major units, with number of allowed decimal places depending on currency)\n"}},"components/schemas/PaymentLinkLineItemsProductAmountOptionsArray":{"id":"components/schemas/PaymentLinkLineItemsProductAmountOptionsArray","kind":"json-schema","title":"PaymentLinkLineItemsProductAmountOptionsArray","data":{"type":"array","items":{"type":"number"},"example":[10,20,30],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available pre-defined payment amounts. Allows the customer to select from a list of options for how much they want to pay. Useful whenever a merchant wants to suggest a few selectable amounts — for example pay-what-you-want pricing, tips, or donations."},"children":[]}]}]}]}},"components/schemas/PaymentLinkLineItemsProductAmountCustom":{"id":"components/schemas/PaymentLinkLineItemsProductAmountCustom","kind":"json-schema","title":"PaymentLinkLineItemsProductAmountCustom","data":{"type":"object","description":"Possible range of custom payment amount\n","required":["min","max"],"properties":{"min":{"type":"number","example":10,"description":"Minimum value of custom payment amount\n"},"max":{"type":"number","example":200,"description":"Maximum value of custom payment amount\n"}}}},"components/schemas/PaymentLinkLineItemsArray":{"id":"components/schemas/PaymentLinkLineItemsArray","kind":"json-schema","title":"PaymentLinkLineItemsArray","data":{"type":"array","description":"List of line items\n","items":{"type":"object","required":["product"],"properties":{"product":{"type":"object","description":"Definition of a product\n","required":["name","amount","currencyCode"],"properties":{"name":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductName"},"description":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductDescription"},"currencyCode":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCurrencyCode"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount definition. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a fixed-amount link, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to let the customer choose the amount. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a customer-chosen amount link may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both together."},"children":[]}]}]}],"oneOf":[{"title":"Fixed Total","type":"object","additionalProperties":false,"required":["total"],"properties":{"total":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountTotal"}}},{"title":"Customer-chosen amount","type":"object","additionalProperties":false,"minProperties":1,"properties":{"options":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountOptionsArray"},"custom":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCustom"}}}]}}}}}}},"components/schemas/PaymentLinkCurrency":{"id":"components/schemas/PaymentLinkCurrency","kind":"json-schema","title":"PaymentLinkCurrency","data":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency for the authorization, represented as a three-letter ISO currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links the currency is taken from the line items and this field may be omitted."},"children":[]}]}]}]}},"components/schemas/PaymentLinkReturnURL":{"id":"components/schemas/PaymentLinkReturnURL","kind":"json-schema","title":"PaymentLinkReturnURL","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer will be redirected to this URL after completing payment on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentLink.url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When not provided the return URL from account setting will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some dynamic parameters will be appended to this URL. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{returnUrl}?status=success&checkout_session_id=chse_xxxxx"},"children":[]}]}]}]}},"components/schemas/PaymentLinkCollectBillingAddress":{"id":"components/schemas/PaymentLinkCollectBillingAddress","kind":"json-schema","title":"PaymentLinkCollectBillingAddress","data":{"type":"boolean","description":"If the value is true, the customer will be asked to provide the billing address.\n\nDefault: false\n"}},"components/schemas/PaymentLinkCollectShippingAddress":{"id":"components/schemas/PaymentLinkCollectShippingAddress","kind":"json-schema","title":"PaymentLinkCollectShippingAddress","data":{"type":"boolean","description":"If the value is true, the customer will be asked to provide the shipping address.\n\nDefault: false\n"}},"components/schemas/PaymentLinkRestrictions":{"id":"components/schemas/PaymentLinkRestrictions","kind":"json-schema","title":"PaymentLinkRestrictions","data":{"type":"object","description":"This object describes time boundaries and preset number of charges made with the Payment link\n","properties":{"dates":{"type":"object","properties":{"activatesAt":{"type":"string","format":"ISO 8601","example":"2025-10-20T11:22:33.444Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activation date of a payment link. By default, payment links are active at the moment of creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max: +1 month"},"children":[]}]}]}]},"expiresAt":{"type":"string","format":"ISO 8601","example":"2025-10-27T12:00:00.000Z","description":"Expiration date of a payment link. By default, payment links do not expire.\n"}}},"payments":{"type":"object","properties":{"limit":{"type":"integer","example":1,"minimum":1,"maximum":999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of successful payments allowed to be done using this payment link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range: 1–999"},"children":[]}]}]}]},"count":{"readOnly":true,"type":"integer","example":0,"description":"Number of successful payments\n"}}}}}},"components/schemas/PaymentLinkNotificationsRequest":{"id":"components/schemas/PaymentLinkNotificationsRequest","kind":"json-schema","title":"PaymentLinkNotificationsRequest","data":{"type":"object","description":"Payment Links notifications\n","properties":{"share":{"type":"object","properties":{"email":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to true, the payment link is automatically sent by email to the customer. The email address is taken from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object on the request — either supplied inline via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.emailAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or read from an existing customer record referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}}},"components/schemas/PaymentLinkStaticFields":{"id":"components/schemas/PaymentLinkStaticFields","kind":"json-schema","title":"PaymentLinkStaticFields","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of custom information (for example: hotel reservation details) in key value pair format. A maximum of 10 entries can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key contains the title of custom information and is a maximum of 55 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value contains the text of custom information and is a maximum of 255 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Date of event\": \"12 April\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Invoice number\": \"ABC2016\""},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"Date of event":"12 April","Invoice number":"ABC2016"}}},"components/schemas/PaymentLinkCustomFieldsTitle":{"id":"components/schemas/PaymentLinkCustomFieldsTitle","kind":"json-schema","title":"PaymentLinkCustomFieldsTitle","data":{"type":"string","maxLength":32,"example":"Additional information","description":"Title of custom fields section\n"}},"components/schemas/PaymentLinkCustomFieldsArray":{"id":"components/schemas/PaymentLinkCustomFieldsArray","kind":"json-schema","title":"PaymentLinkCustomFieldsArray","data":{"type":"array","maxItems":3,"description":"Using custom fields, the merchant can request additional information from the customer. Each custom field will be displayed in the form as a new text field to fill out.\n","items":{"type":"object","required":["key","label"],"properties":{"key":{"type":"string","maxLength":255,"example":"special_wishes","description":"Identifier of custom field\n"},"label":{"type":"string","maxLength":20,"example":"Special wishes","description":"Label of custom field\n"},"optional":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then customer doesn't have to provide any value for this custom field"},"children":[]}]}]}]}}}}},"components/schemas/PaymentLinkLocale":{"id":"components/schemas/PaymentLinkLocale","kind":"json-schema","title":"PaymentLinkLocale","data":{"type":"string","enum":["auto","en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language that will be used on payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = use browser language"},"children":[]}]}]}]}},"components/schemas/PaymentLinkVendorReference":{"id":"components/schemas/PaymentLinkVendorReference","kind":"json-schema","title":"PaymentLinkVendorReference","data":{"type":"string","maxLength":50,"example":"ref_123456789","description":"Merchant Defined Descriptor related to the Payment Link. This field is reportable on the merchant portal and settlement extract.\n"}},"components/schemas/PaymentLinkRequest":{"id":"components/schemas/PaymentLinkRequest","kind":"json-schema","title":"PaymentLinkRequest","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PaymentLinkId"},"type":{"$ref":"#/components/schemas/PaymentLinkType"},"lineItems":{"$ref":"#/components/schemas/PaymentLinkLineItemsArray"},"currency":{"$ref":"#/components/schemas/PaymentLinkCurrency"},"returnUrl":{"$ref":"#/components/schemas/PaymentLinkReturnURL"},"collectBillingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectBillingAddress"},"collectShippingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectShippingAddress"},"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictions"},"notifications":{"$ref":"#/components/schemas/PaymentLinkNotificationsRequest"},"staticFields":{"$ref":"#/components/schemas/PaymentLinkStaticFields"},"customFieldsTitle":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsTitle"},"customFields":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsArray"},"locale":{"$ref":"#/components/schemas/PaymentLinkLocale"},"vendorReference":{"$ref":"#/components/schemas/PaymentLinkVendorReference"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration of the payment link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required fields depend on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is taken from the line items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be omitted. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be supplied at the top level of the request."},"children":[]}]}]}]}],"oneOf":[{"title":"Line items (payment)","required":["lineItems"],"properties":{"type":{"const":"line_items"}}},{"title":"Card verification","required":["type","currency"],"properties":{"type":{"const":"card_verification"}}}]}},"components/schemas/PaymentLinksCustomer":{"id":"components/schemas/PaymentLinksCustomer","kind":"json-schema","title":"PaymentLinksCustomer","data":{"oneOf":[{"title":"New Customer","type":"object","required":["emailAddress"],"properties":{"emailAddress":{"type":"string","example":"john@example.com","description":"Email address. Required when creating an inline customer.\n"},"phoneCountry":{"type":"string","example":"US","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter ISO 3166-1 alpha-2 country code used to determine the phone number's country prefix (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not already include the country calling code prefix (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When provided, the API prepends the corresponding prefix to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and returns the full number in the response."},"children":[]}]}]}]},"phoneNumber":{"type":"string","example":"+1 2345678901","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer phone number. Two formats are accepted:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With country prefix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+1 2345678901"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without country prefix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2345678901"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to the appropriate alpha-2 code."},"children":[]}]}]}]}]},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"middleName":{"$ref":"#/components/schemas/CustomerMiddleName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"addressCity":{"type":"string","example":"New York","description":"City\n"},"addressRegion":{"type":"string","example":"NY","description":"Region or state\n"},"addressCountry":{"type":"string","example":"US","description":"Country\n"}}},{"title":"Existing Customer","type":"object","required":["id"],"properties":{"id":{"type":"string","example":"cust_oM1i4j7EsIY7W5vqqF76diGw","description":"Identifier of an existing customer to reuse\n"}}}]}},"components/schemas/PaymentLinksMetadata":{"id":"components/schemas/PaymentLinksMetadata","kind":"json-schema","title":"PaymentLinksMetadata","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value object for storing additional custom data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is never displayed to customer on the payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"order_id\": \"12345\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"campaign_code\": \"SUMMER2025\""},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"order_id":"12345","campaign_code":"SUMMER2025"}}},"components/schemas/PaymentLinksDateTime":{"id":"components/schemas/PaymentLinksDateTime","kind":"json-schema","title":"PaymentLinksDateTime","data":{"type":"string","format":"ISO 8601","readOnly":true,"example":"2024-05-21T09:18:23.283-07:00","description":"Date-time when the object was created\n"}},"components/schemas/PaymentLinkStatus":{"id":"components/schemas/PaymentLinkStatus","kind":"json-schema","title":"PaymentLinkStatus","data":{"type":"string","enum":["active","expired","deactivated","completed","scheduled"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of a Payment link. It can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link is active and functional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link expired and is no longer functional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link has been deactivated by merchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preset number of successful transactions made with this payment link has been reached, it is no longer functional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link is yet to become active"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/payment-links/paymentslinkupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/paymentlinks/update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request this field can be used to deactivate and reactivate an existing payment link."},"children":[]}]}]}]}},"components/schemas/PaymentLinkLastOpened":{"id":"components/schemas/PaymentLinkLastOpened","kind":"json-schema","title":"PaymentLinkLastOpened","data":{"type":"string","format":"ISO 8601","example":"2025-10-20T11:22:33.444Z","description":"The date the link was last opened. Omitted if the link has not been opened yet.\n"}},"components/schemas/PaymentLinkLineItemsArrayResponse":{"id":"components/schemas/PaymentLinkLineItemsArrayResponse","kind":"json-schema","title":"PaymentLinkLineItemsArrayResponse","data":{"type":"array","description":"List of line items\n","items":{"type":"object","properties":{"product":{"type":"object","description":"Definition of a product\n","properties":{"name":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductName"},"description":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductDescription"},"currencyCode":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCurrencyCode"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount definition. A fixed-amount link returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a customer-chosen amount link returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never present alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"title":"Fixed Total","type":"object","properties":{"total":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountTotal"}}},{"title":"Customer-chosen amount","type":"object","properties":{"options":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountOptionsArray"},"custom":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCustom"}}}]}}}}}}},"components/schemas/PaymentLinkURL":{"id":"components/schemas/PaymentLinkURL","kind":"json-schema","title":"PaymentLinkURL","data":{"type":"string","example":"https://pay.shift4.com/link_8kdskX8DZ8FR6W3acYPXiyAN","description":"URL that can be used to process payment defined by this Payment Link\n"}},"components/schemas/PaymentLinkNotificationsResponse":{"id":"components/schemas/PaymentLinkNotificationsResponse","kind":"json-schema","title":"PaymentLinkNotificationsResponse","data":{"type":"object","description":"Payment Links notifications\n","properties":{"share":{"type":"object","properties":{"email":{"type":"object","description":"Email notification details\n","properties":{"emailAddress":{"readOnly":true,"type":"string","example":"john@example.com","description":"Email address\n"},"status":{"readOnly":true,"type":"string","enum":["sent","delivered","failed"],"description":"Email delivery status.\n"}}}}}}}},"components/schemas/PaymentLinkResponse":{"id":"components/schemas/PaymentLinkResponse","kind":"json-schema","title":"PaymentLinkResponse","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PaymentLinkId"},"type":{"$ref":"#/components/schemas/PaymentLinkType"},"status":{"$ref":"#/components/schemas/PaymentLinkStatus"},"lastOpened":{"$ref":"#/components/schemas/PaymentLinkLastOpened"},"lineItems":{"$ref":"#/components/schemas/PaymentLinkLineItemsArrayResponse"},"currency":{"$ref":"#/components/schemas/PaymentLinkCurrency"},"url":{"$ref":"#/components/schemas/PaymentLinkURL"},"returnUrl":{"$ref":"#/components/schemas/PaymentLinkReturnURL"},"collectBillingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectBillingAddress"},"collectShippingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectShippingAddress"},"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictions"},"notifications":{"$ref":"#/components/schemas/PaymentLinkNotificationsResponse"},"staticFields":{"$ref":"#/components/schemas/PaymentLinkStaticFields"},"customFieldsTitle":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsTitle"},"customFields":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsArray"},"locale":{"$ref":"#/components/schemas/PaymentLinkLocale"},"vendorReference":{"$ref":"#/components/schemas/PaymentLinkVendorReference"}}}},"components/schemas/PaymentLinksCustomerResponse":{"id":"components/schemas/PaymentLinksCustomerResponse","kind":"json-schema","title":"PaymentLinksCustomerResponse","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"cust_oM1i4j7EsIY7W5vqqF76diGw","description":"Identifier of the customer\n"},"emailAddress":{"type":"string","example":"john@example.com","description":"Email\n"},"phoneCountry":{"type":"string","example":"US","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter ISO 3166-1 alpha-2 country code of the phone number's country (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Present when the customer was created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]}]}]}]},"phoneNumber":{"type":"string","example":"+1 2345678901","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided on creation, the number is returned with the corresponding country calling code prepended."},"children":[]}]}]}]},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"middleName":{"$ref":"#/components/schemas/CustomerMiddleName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"addressCity":{"type":"string","example":"New York","description":"City\n"},"addressRegion":{"type":"string","example":"NY","description":"Region or state\n"},"addressCountry":{"type":"string","example":"US","description":"Country\n"}}}},"components/schemas/PaymentLinksHasMore":{"id":"components/schemas/PaymentLinksHasMore","kind":"json-schema","title":"PaymentLinksHasMore","data":{"type":"boolean","description":"If the value is true then more objects can be listed by requesting next page\n"}},"components/schemas/PaymentLinkUpdateRequest":{"id":"components/schemas/PaymentLinkUpdateRequest","kind":"json-schema","title":"PaymentLinkUpdateRequest","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PaymentLinkId"},"status":{"$ref":"#/components/schemas/PaymentLinkStatus"},"lineItems":{"type":"array","description":"List of line items\n","items":{"type":"object","properties":{"product":{"type":"object","description":"Definition of a product\n","properties":{"name":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductName"},"description":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductDescription"},"currencyCode":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCurrencyCode"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount definition. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a fixed-amount link, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to let the customer choose the amount. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a customer-chosen amount link may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both together."},"children":[]}]}]}],"oneOf":[{"title":"Fixed Total","type":"object","additionalProperties":false,"required":["total"],"properties":{"total":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountTotal"}}},{"title":"Customer-chosen amount","type":"object","additionalProperties":false,"minProperties":1,"properties":{"options":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountOptionsArray"},"custom":{"$ref":"#/components/schemas/PaymentLinkLineItemsProductAmountCustom"}}}]}}}}}},"returnUrl":{"$ref":"#/components/schemas/PaymentLinkReturnURL"},"collectBillingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectBillingAddress"},"collectShippingAddress":{"$ref":"#/components/schemas/PaymentLinkCollectShippingAddress"},"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictions"},"notifications":{"$ref":"#/components/schemas/PaymentLinkNotificationsRequest"},"staticFields":{"$ref":"#/components/schemas/PaymentLinkStaticFields"},"customFieldsTitle":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsTitle"},"customFields":{"$ref":"#/components/schemas/PaymentLinkCustomFieldsArray"},"locale":{"$ref":"#/components/schemas/PaymentLinkLocale"}}}},"components/schemas/CheckoutSessionWebV1Action":{"id":"components/schemas/CheckoutSessionWebV1Action","kind":"json-schema","title":"CheckoutSessionWebV1Action","data":{"type":"string","description":"Action a Checkout Session performs.","enum":["payment","card_verification"]}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","description":"Custom field rendered on the checkout form","properties":{"key":{"type":"string","description":"Identifier of custom field","example":"special_wishes","maxLength":255},"label":{"type":"string","description":"Label of custom field","example":"Special wishes","maxLength":32},"value":{"type":"string","description":"Pre-filled value for the field","maxLength":255},"optional":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then customer doesn't have to provide any value for this custom field"},"children":[]}]}]}]}},"required":["key","label"]}},"components/schemas/CustomAmount":{"id":"components/schemas/CustomAmount","kind":"json-schema","title":"CustomAmount","data":{"type":"object","description":"Allowed range for a custom donation amount","properties":{"min":{"type":"number","description":"Minimum custom amount (major units)","example":10.99,"minimum":0.01},"max":{"type":"number","description":"Maximum custom amount (major units)","example":199.99,"minimum":0.01}}}},"components/schemas/ProductWebV1Amount":{"id":"components/schemas/ProductWebV1Amount","kind":"json-schema","title":"ProductWebV1Amount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount definition. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a fixed-amount product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a donation product. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a donation may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both together."},"children":[]}]}]}],"oneOf":[{"title":"Fixed Total","type":"object","additionalProperties":false,"required":["total"],"properties":{"total":{"type":"number","minimum":0.01,"example":10.99,"description":"Fixed payment amount (in major units, with the number of allowed decimal places depending on currency).\n"}}},{"title":"Donation","type":"object","additionalProperties":false,"minProperties":1,"properties":{"options":{"type":"array","items":{"type":"number","minimum":0.01},"example":[10.99,24.55,49.99],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of pre-defined selectable payment amounts. Allows the customer to choose how much to pay. May be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"custom":{"$ref":"#/components/schemas/CustomAmount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed range for a custom payment amount. May be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}]}},"components/schemas/ProductWebV1Request":{"id":"components/schemas/ProductWebV1Request","kind":"json-schema","title":"ProductWebV1Request","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product or service","example":"Wireless Headphones"},"description":{"type":"string","description":"Description of the product or service"},"amount":{"$ref":"#/components/schemas/ProductWebV1Amount","description":"Product price"},"currencyCode":{"type":"string","description":"Three-letter ISO 4217 currency code","enum":["EUR","USD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AZN","BSD","BHD","BDT","BBD","BYN","BYR","BZD","BMD","BTN","BOB","BOV","BAM","BWP","BRL","BND","BGN","BIF","KHR","CAD","CVE","KYD","CLF","CLP","CNY","COP","COU","KMF","CDF","CRC","HRK","CUC","CUP","CZK","DJF","DOP","EGP","SVC","ERN","ETB","FKP","FJD","XAF","GMD","GEL","GHS","GIP","DKK","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MOP","MKD","MGA","MWK","MYR","MVR","MRO","MUR","MXN","MXV","MDL","MNT","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","XCD","WST","STD","SAR","RSD","SCR","SLL","SGD","ANG","SBD","SOS","ZAR","SSP","LKR","SDG","SRD","NOK","SZL","SEK","CHE","CHF","CHW","SYP","TWD","TJS","TZS","THB","XOF","NZD","TOP","TTD","TND","TRY","TMT","AUD","UGX","UAH","AED","GBP","USN","USS","UYI","UYU","UZS","VUV","VEF","VND","XPF","MAD","YER","ZMK","ZMW","ZWL","SLE","STN","MRU","VES"],"example":"USD"}},"required":["amount","currencyCode","name"]}},"components/schemas/LineItemWebV1Request":{"id":"components/schemas/LineItemWebV1Request","kind":"json-schema","title":"LineItemWebV1Request","data":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/ProductWebV1Request","description":"Product purchased in this line item"},"quantity":{"type":"integer","format":"int32","default":"1","description":"Number of units of the product. Donation products must have a quantity of 1.","example":1,"minimum":1}},"required":["product"]}},"components/schemas/CheckoutSession":{"id":"components/schemas/CheckoutSession","kind":"json-schema","title":"CheckoutSession","data":{"type":"object","description":"Checkout session configuration","properties":{"action":{"$ref":"#/components/schemas/CheckoutSessionWebV1Action","description":"Action the checkout session should perform. Defaults to a line-items payment when omitted."},"redirectUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer will be redirected to this URL after completing payment on the hosted checkout page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When not provided the return URL from account setting will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some dynamic parameters will be appended to this URL. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{redirectUrl}?status=success&checkout_session_id=chse_xxxxx"},"children":[]}]}]}],"example":"https://example.com/checkout/complete","maxLength":2048,"minLength":0},"allowSavedCards":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, saved cards may be used in this checkout session. Required to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for card-verification sessions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: false"},"children":[]}]}]}]},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language that will be used on payment page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = use browser language"},"children":[]}]}]}],"example":"en","enum":["auto","en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"]},"collectBillingAddress":{"type":"boolean","description":"If the value is true, the customer will be asked to provide the billing address.\n\nDefault: false"},"collectShippingAddress":{"type":"boolean","description":"If the value is true, the customer will be asked to provide the shipping address.\n\nDefault: false"},"customFieldsTitle":{"type":"string","description":"Title of custom fields section","example":"Additional information"},"customFieldsTitleTranslations":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Translations of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldsTitle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keyed by locale code"},"children":[]}]}]}]},"customFields":{"type":"array","description":"Using custom fields, the merchant can request additional information from the customer. Each custom field will be displayed in the form as a new text field to fill out. A maximum of 3 custom fields can be provided.","items":{"$ref":"#/components/schemas/CustomField"},"maxItems":3,"minItems":0},"staticFields":{"type":"object","additionalProperties":{"type":"string","maxLength":255},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of custom information (for example: hotel reservation details) in key value pair format. A maximum of 10 entries can be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key contains the title of custom information and is a maximum of 50 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value contains the text of custom information and is a maximum of 255 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Date of event\": \"12 April\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Invoice number\": \"ABC2016\""},"children":[]}]}]}],"propertyNames":{"maxLength":50}},"webhookUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination URL this checkout session's webhooks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are sent to."},"children":[]}]}]}]},"capture":{"type":"boolean","description":"If the value is true, the resulting charge will be captured immediately.\n\nDefault: true"},"vendorReference":{"type":"string","description":"Merchant Defined Descriptor related to the Checkout Session. This field is reportable on the merchant portal and settlement extract.","example":"ref_123456789","maxLength":50},"lineItems":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of line items. Required for non-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sessions."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/LineItemWebV1Request"}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217 currency code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sessions."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For line-item sessions it is inferred from the line items and may be omitted."},"children":[]}]}]}],"enum":["EUR","USD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AZN","BSD","BHD","BDT","BBD","BYN","BYR","BZD","BMD","BTN","BOB","BOV","BAM","BWP","BRL","BND","BGN","BIF","KHR","CAD","CVE","KYD","CLF","CLP","CNY","COP","COU","KMF","CDF","CRC","HRK","CUC","CUP","CZK","DJF","DOP","EGP","SVC","ERN","ETB","FKP","FJD","XAF","GMD","GEL","GHS","GIP","DKK","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MOP","MKD","MGA","MWK","MYR","MVR","MRO","MUR","MXN","MXV","MDL","MNT","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","XCD","WST","STD","SAR","RSD","SCR","SLL","SGD","ANG","SBD","SOS","ZAR","SSP","LKR","SDG","SRD","NOK","SZL","SEK","CHE","CHF","CHW","SYP","TWD","TJS","TZS","THB","XOF","NZD","TOP","TTD","TND","TRY","TMT","AUD","UGX","UAH","AED","GBP","USN","USS","UYI","UYU","UZS","VUV","VEF","VND","XPF","MAD","YER","ZMK","ZMW","ZWL","SLE","STN","MRU","VES"],"example":"USD"},"customerCreationPolicy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer creation policy. Mutually exclusive with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided at the top level."},"children":[]}]}]}],"enum":["create","do_not_create"]}}}},"components/schemas/CustomerDetailsWebV1Request":{"id":"components/schemas/CustomerDetailsWebV1Request","kind":"json-schema","title":"CustomerDetailsWebV1Request","data":{"allOf":[{},{"properties":{"postalCode":{"example":"94043","maxLength":16}}}],"required":["emailAddress"]}},"components/schemas/CustomerWebV1Request":{"id":"components/schemas/CustomerWebV1Request","kind":"json-schema","title":"CustomerWebV1Request","data":{"type":"object"}},"components/schemas/CustomerIdWebV1Request":{"id":"components/schemas/CustomerIdWebV1Request","kind":"json-schema","title":"CustomerIdWebV1Request","data":{"allOf":[{"$ref":"#/components/schemas/CustomerWebV1Request"},{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing customer","example":"cust_oM1i4j7EsIY7W5vqqF76diGw"}}}],"required":["id"]}},"components/schemas/CreateCheckoutSessionWebV1Request":{"id":"components/schemas/CreateCheckoutSessionWebV1Request","kind":"json-schema","title":"CreateCheckoutSessionWebV1Request","data":{"type":"object","description":"Payload used to create a checkout session","properties":{"checkoutSession":{"$ref":"#/components/schemas/CheckoutSession","description":"Checkout session configuration"},"customer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer associated with this checkout session. Either an existing customer (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a new inline customer object. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkoutSession.customerCreationPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/CustomerDetailsWebV1Request"},{"$ref":"#/components/schemas/CustomerIdWebV1Request"}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value object for storing additional custom data.\n\nThis is never displayed to customer on the payment page."}},"required":["checkoutSession"]}},"components/schemas/EventData":{"id":"components/schemas/EventData","kind":"json-schema","title":"EventData","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of the event","enum":["payment_link_created","payment_link_updated","payment_link_sms_notification_sent","payment_link_sms_notification_delivered","payment_link_sms_notification_failed","checkout_session_completed","checkout_session_created","checkout_session_expired"],"example":"checkout_session_created"}}}},"components/schemas/CustomerWebV1Response":{"id":"components/schemas/CustomerWebV1Response","kind":"json-schema","title":"CustomerWebV1Response","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer","example":"cust_oM1i4j7EsIY7W5vqqF76diGw"},"emailAddress":{"type":"string","description":"Customer email address","example":"jordan.smith@example.com"},"phoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer phone number in full international format (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+12025550123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When the request supplied a local-format number alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response normalizes it to international format here."},"children":[]}]}]}],"example":"+12025550123"},"phoneCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter ISO 3166-1 alpha-2 country code of the phone number (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Present whenever the request provided one."},"children":[]}]}]}],"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"example":"US"},"firstName":{"type":"string","description":"Customer first name","example":"Jordan"},"middleName":{"type":"string","description":"Customer middle name","example":"Riley"},"lastName":{"type":"string","description":"Customer last name","example":"Smith"},"addressLine1":{"type":"string","description":"Street address","example":"Evergreen Terrace 742"},"postalCode":{"type":"string","description":"Postal or ZIP code","example":"94043"},"addressCity":{"type":"string","description":"City","example":"Mountain View"},"addressRegion":{"type":"string","description":"State, province or region","example":"CA"},"addressCountry":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"example":"US"}}}},"components/schemas/PaymentLinkIdWebV1Response":{"id":"components/schemas/PaymentLinkIdWebV1Response","kind":"json-schema","title":"PaymentLinkIdWebV1Response","data":{"type":"object","description":"Reference to a payment link by its identifier","properties":{"id":{"type":"string","description":"Identifier of the payment link","example":"link_8kdskX8DZ8FR6W3acYPXiyAN"}}}},"components/schemas/CheckoutSessionCustomFieldWebV1Response":{"id":"components/schemas/CheckoutSessionCustomFieldWebV1Response","kind":"json-schema","title":"CheckoutSessionCustomFieldWebV1Response","data":{"type":"object","description":"Custom field that was collected from customer on the payment page","properties":{"key":{"type":"string","description":"Identifier of custom field","example":"special_wishes"},"label":{"type":"string","description":"Label of custom field","example":"Special wishes"},"value":{"type":"string","description":"The value that was provided by the customer for this custom field","example":"Happy Holidays"},"optional":{"type":"boolean","description":"If this flag is set to true, then customer was not required to provide any value for this custom field"}}}},"components/schemas/ProductWebV1Response":{"id":"components/schemas/ProductWebV1Response","kind":"json-schema","title":"ProductWebV1Response","data":{"type":"object","description":"Product purchased in this line item","properties":{"name":{"type":"string","description":"Display name of the product shown on the checkout page","example":"Premium Plan"},"description":{"type":"string","description":"Description of the product or service"},"amount":{"$ref":"#/components/schemas/ProductWebV1Amount","description":"Product price"},"currencyCode":{"type":"string","description":"Three-letter ISO 4217 currency code","enum":["EUR","USD","AFN","ALL","DZD","AOA","ARS","AMD","AWG","AZN","BSD","BHD","BDT","BBD","BYN","BYR","BZD","BMD","BTN","BOB","BOV","BAM","BWP","BRL","BND","BGN","BIF","KHR","CAD","CVE","KYD","CLF","CLP","CNY","COP","COU","KMF","CDF","CRC","HRK","CUC","CUP","CZK","DJF","DOP","EGP","SVC","ERN","ETB","FKP","FJD","XAF","GMD","GEL","GHS","GIP","DKK","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","LTL","MOP","MKD","MGA","MWK","MYR","MVR","MRO","MUR","MXN","MXV","MDL","MNT","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","XCD","WST","STD","SAR","RSD","SCR","SLL","SGD","ANG","SBD","SOS","ZAR","SSP","LKR","SDG","SRD","NOK","SZL","SEK","CHE","CHF","CHW","SYP","TWD","TJS","TZS","THB","XOF","NZD","TOP","TTD","TND","TRY","TMT","AUD","UGX","UAH","AED","GBP","USN","USS","UYI","UYU","UZS","VUV","VEF","VND","XPF","MAD","YER","ZMK","ZMW","ZWL","SLE","STN","MRU","VES"],"example":"USD"}}}},"components/schemas/LineItemWebV1Response":{"id":"components/schemas/LineItemWebV1Response","kind":"json-schema","title":"LineItemWebV1Response","data":{"type":"object","description":"Line item charged in this checkout session","properties":{"product":{"$ref":"#/components/schemas/ProductWebV1Response","description":"Product purchased in this line item"},"quantity":{"type":"integer","format":"int32","description":"Number of units of the product","example":1}}}},"components/schemas/CheckoutSessionResponse":{"id":"components/schemas/CheckoutSessionResponse","kind":"json-schema","title":"CheckoutSessionResponse","data":{"type":"object","description":"Checkout session details","properties":{"id":{"type":"string","description":"Identifier of a Checkout Session","example":"chse_wMCUGVZgpf45fWHzKbYWMKmZ"},"action":{"$ref":"#/components/schemas/CheckoutSessionWebV1Action","description":"Action this checkout session performs"},"clientSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-use token used to collect payment with Custom Components on your own page — pass it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shift4.createCheckout(clientSecret)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the shift4.js library. Do not reuse across customers or checkout sessions."},"children":[]}]}]}],"example":"chcs_II2TvLWBrzFniRdjLpgo2zIflaTCzZ5BGPngPZEu0XasgwYRBCHEpyqE0tO9pYocvoOl8alO9w91CAeW0bl3nrTfO9JH4zFDt8pXB2eyoOpOBeuD3XuxPnGKOiTjor0D0vwRfdMR7moSj3K9yLDktQy6KcoZEa9SgP5DHiXg30L1X26EKy4XCxqBdeB4dcC4osPiXBwJqFfhKsKxG4RUD8I8CCeUfvbXnCVSokauaT0AUEk7pkF3TBgN3Q"},"url":{"type":"string","description":"URL of the Shift4-hosted checkout page. Redirect the customer here if you do not want to embed Custom Components on your own page.","example":"https://pay.shift4.com/chse_wMCUGVZgpf45fWHzKbYWMKmZ"},"status":{"type":"string","description":"Current status of the checkout session","enum":["active","paid","expired","failed"]},"redirectUrl":{"type":"string","description":"URL the customer is redirected to after completing payment on the hosted checkout page.","example":"https://example.com/checkout/complete"},"allowSavedCards":{"type":"boolean","description":"If the value is true, saved cards may be used in this checkout session.\n\nDefault: false"},"locale":{"type":"string","description":"Language used on payment page","example":"en"},"lastOpened":{"type":"string","format":"date-time","description":"Timestamp the customer most recently opened the hosted checkout page","example":"2024-05-21T09:18:23.283-07:00"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp at which the checkout session expires","example":"2024-05-21T09:18:23.283-07:00"},"collectBillingAddress":{"type":"boolean","description":"If the value is true, the customer was asked to provide the billing address.\n\nDefault: false"},"collectShippingAddress":{"type":"boolean","description":"If the value is true, the customer was asked to provide the shipping address.\n\nDefault: false"},"customFieldsTitle":{"type":"string","description":"Title of custom fields section","example":"Additional information"},"customFieldsTitleTranslations":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Translations of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldsTitle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keyed by locale code"},"children":[]}]}]}]},"customFields":{"type":"array","description":"List of custom fields that were collected from customer on the payment page","items":{"$ref":"#/components/schemas/CheckoutSessionCustomFieldWebV1Response"}},"staticFields":{"type":"object","additionalProperties":{"type":"string"},"description":"List of information displayed on the payment page"},"capture":{"type":"boolean","description":"If the value is true, the resulting charge is captured immediately.\n\nDefault: true"},"vendorReference":{"type":"string","description":"Merchant Defined Descriptor related to the Checkout Session. This field is reportable on the merchant portal and settlement extract.","example":"ref_123456789"},"webhookUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination URL this checkout session's webhooks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are sent to."},"children":[]}]}]}]},"lineItems":{"type":"array","description":"List of line items","items":{"$ref":"#/components/schemas/LineItemWebV1Response"}},"lastTransaction":{"type":"object","additionalProperties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the API response from the last transaction processed. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/payments-platform-rest/openapi/transactions/transactionssale#transactions/transactionssale/response&c=200"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale Response Body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full response structure."},"children":[]}]}]}]},"customerCreationPolicy":{"type":"string","description":"Customer creation policy applied to this checkout session","enum":["create","do_not_create"]}}}},"components/schemas/CheckoutSessionWebV1Response":{"id":"components/schemas/CheckoutSessionWebV1Response","kind":"json-schema","title":"CheckoutSessionWebV1Response","data":{"type":"object","description":"Checkout Session resource returned by Create, Retrieve and List endpoints","properties":{"dateTime":{"type":"string","format":"date-time","description":"Timestamp of the most recent event for this checkout session","example":"2024-05-21T09:18:23.283-07:00"},"event":{"$ref":"#/components/schemas/EventData","description":"Most recent event associated with this checkout session"},"customer":{"$ref":"#/components/schemas/CustomerWebV1Response","description":"Customer associated with this checkout session"},"paymentLink":{"$ref":"#/components/schemas/PaymentLinkIdWebV1Response","description":"Payment link this checkout session was created from"},"checkoutSession":{"$ref":"#/components/schemas/CheckoutSessionResponse","description":"Checkout session details"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value object containing additional custom data supplied when the checkout session was created. This is never displayed to customer on the payment page."}}}},"components/schemas/ACHDistributeBankAccount":{"id":"components/schemas/ACHDistributeBankAccount","kind":"json-schema","title":"Bank & Routing Number","data":{"title":"Bank & Routing Number","type":"object","required":["amount","transaction","ach"],"properties":{"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"ach":{"type":"object","required":["accountNumber","routingNumber","accountType","accountHolderName"],"properties":{"accountNumber":{"$ref":"#/components/schemas/ACHAccountNumber"},"routingNumber":{"$ref":"#/components/schemas/ACHRoutingNumber"},"accountType":{"$ref":"#/components/schemas/ACHAccountType"},"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"},"accountVerified":{"$ref":"#/components/schemas/ACHAccountVerified"},"paymentTypeCode":{"$ref":"#/components/schemas/ACHPaymentTypeCode"}}}},"example":{"amount":{"total":135.87},"transaction":{"invoice":"192029"},"ach":{"accountNumber":"1234567890","routingNumber":"121000248","accountHolderName":"John Smith","accountType":"PC","accountVerified":true}}}},"components/schemas/ACHDistributeGTVToken":{"id":"components/schemas/ACHDistributeGTVToken","kind":"json-schema","title":"GTV Token","data":{"title":"GTV Token","type":"object","required":["amount","transaction","token"],"properties":{"amount":{"$ref":"#/components/schemas/AmountACH"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"ach":{"type":"object","properties":{"verifyBalance":{"$ref":"#/components/schemas/ACHVerifyBalance"},"paymentTypeCode":{"$ref":"#/components/schemas/ACHPaymentTypeCode"}}}},"example":{"amount":{"total":135.87},"transaction":{"invoice":"192029"},"token":{"value":"9829283019231234"},"ach":{"verifyBalance":true}}}},"components/schemas/EMVCAPKVersion":{"id":"components/schemas/EMVCAPKVersion","kind":"json-schema","title":"EMVCAPKVersion","data":{"type":"number","example":1,"description":"The version of the EMV CA Public Keys (CAPKs). This field will increment any time changes are made to the EMV CAPKs. It can be used to determine if there are any changes since the previous time you requested the keys.\n"}},"components/schemas/EMVCAPKAid":{"id":"components/schemas/EMVCAPKAid","kind":"json-schema","title":"EMVCAPKAid","data":{"type":"string","example":"A000000003","description":"EMV application identifier.\n"}},"components/schemas/EMVCAPKIndex":{"id":"components/schemas/EMVCAPKIndex","kind":"json-schema","title":"EMVCAPKIndex","data":{"type":"string","example":"92","description":"EMV CA Public Key Index\n"}},"components/schemas/EMVCAPKExpDate":{"id":"components/schemas/EMVCAPKExpDate","kind":"json-schema","title":"EMVCAPKExpDate","data":{"type":"string","example":"12312030","description":"EMV CA Public Key Expiration Date in MMDDYYYY format.\n"}},"components/schemas/EMVCAPKAlgorithm":{"id":"components/schemas/EMVCAPKAlgorithm","kind":"json-schema","title":"EMVCAPKAlgorithm","data":{"type":"string","example":"01","description":"EMV CA Public Key Algorithm\n"}},"components/schemas/EMVCAPKHashAlgorithm":{"id":"components/schemas/EMVCAPKHashAlgorithm","kind":"json-schema","title":"EMVCAPKHashAlgorithm","data":{"type":"string","example":"01","description":"EMV CA Public Key Hash Algorithm\n"}},"components/schemas/EMVCAPKKey":{"id":"components/schemas/EMVCAPKKey","kind":"json-schema","title":"EMVCAPKKey","data":{"type":"string","example":"996AF56F569187D09293C14810450ED8EE3357397B18A2458EFAA92DA3B6DF6514EC060195318FD43BE9B8F0CC669E3F844057CBDDF8BDA191BB64473BC8DC9A730DB8F6B4EDE3924186FFD9B8C7735789C23A36BA0B8AF65372EB57EA5D89E7D14E9C7B6B557460F10885DA16AC923F15AF3758F0F03EBD3C5C2C949CBA306DB44E6A2C076C5F67E281D7EF56785DC4D75945E491F01918800A9E2DC66F60080566CE0DAF8D17EAD46AD8E30A247C9F","description":"EMV CA Public key\n"}},"components/schemas/EMVCAPKExponent":{"id":"components/schemas/EMVCAPKExponent","kind":"json-schema","title":"EMVCAPKExponent","data":{"type":"string","example":"03","description":"EMV CA Public Key Exponent\n"}},"components/schemas/EMVCAPKChecksum":{"id":"components/schemas/EMVCAPKChecksum","kind":"json-schema","title":"EMVCAPKChecksum","data":{"type":"string","example":"429C954A3859CEF91295F663C963E582ED6EB253","description":"EMV CA Public Key Checksum\n"}},"components/schemas/EMVCAPKObject":{"id":"components/schemas/EMVCAPKObject","kind":"json-schema","title":"EMVCAPKObject","data":{"type":"object","properties":{"aid":{"$ref":"#/components/schemas/EMVCAPKAid"},"index":{"$ref":"#/components/schemas/EMVCAPKIndex"},"expDate":{"$ref":"#/components/schemas/EMVCAPKExpDate"},"algorithm":{"$ref":"#/components/schemas/EMVCAPKAlgorithm"},"hashAlgorithm":{"$ref":"#/components/schemas/EMVCAPKHashAlgorithm"},"key":{"$ref":"#/components/schemas/EMVCAPKKey"},"exponent":{"$ref":"#/components/schemas/EMVCAPKExponent"},"checksum":{"$ref":"#/components/schemas/EMVCAPKChecksum"}}}},"components/schemas/EMVCAPKArray":{"id":"components/schemas/EMVCAPKArray","kind":"json-schema","title":"EMVCAPKArray","data":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/EMVCAPKObject"},"example":[{"aid":"A000000025","index":"C9","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"B362DB5733C15B8797B8ECEE55CB1A371F760E0BEDD3715BB270424FD4EA26062C38C3F4AAA3732A83D36EA8E9602F6683EECC6BAFF63DD2D49014BDE4D6D603CD744206B05B4BAD0C64C63AB3976B5C8CAAF8539549F5921C0B700D5B0F83C4E7E946068BAAAB5463544DB18C63801118F2182EFCC8A1E85E53C2A7AE839A5C6A3CABE73762B70D170AB64AFC6CA482944902611FB0061E09A67ACB77E493D998A0CCF93D81A4F6C0DC6B7DF22E62DB","exponent":"03","checksum":"8E8DFF443D78CD91DE88821D70C98F0638E51E49"},{"aid":"A000000025","index":"CA","expDate":"12312026","algorithm":"01","hashAlgorithm":"01","key":"C23ECBD7119F479C2EE546C123A585D697A7D10B55C2D28BEF0D299C01DC65420A03FE5227ECDECB8025FBC86EEBC1935298C1753AB849936749719591758C315FA150400789BB14FADD6EAE2AD617DA38163199D1BAD5D3F8F6A7A20AEF420ADFE2404D30B219359C6A4952565CCCA6F11EC5BE564B49B0EA5BF5B3DC8C5C6401208D0029C3957A8C5922CBDE39D3A564C6DEBB6BD2AEF91FC27BB3D3892BEB9646DCE2E1EF8581EFFA712158AAEC541C0BBB4B3E279D7DA54E45A0ACC3570E712C9F7CDF985CFAFD382AE13A3B214A9E8E1E71AB1EA707895112ABC3A97D0FCB0AE2EE5C85492B6CFD54885CDD6337E895CC70FB3255E3","exponent":"03","checksum":"6BDA32B1AA171444C7E8F88075A74FBFE845765F"},{"aid":"A000000152","index":"5C","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"833F275FCF5CA4CB6F1BF880E54DCFEB721A316692CAFEB28B698CAECAFA2B2D2AD8517B1EFB59DDEFC39F9C3B33DDEE40E7A63C03E90A4DD261BC0F28B42EA6E7A1F307178E2D63FA1649155C3A5F926B4C7D7C258BCA98EF90C7F4117C205E8E32C45D10E3D494059D2F2933891B979CE4A831B301B0550CDAE9B67064B31D8B481B85A5B046BE8FFA7BDB58DC0D7032525297F26FF619AF7F15BCEC0C92BCDCBC4FB207D115AA65CD04C1CF982191","exponent":"03","checksum":"60154098CBBA350F5F486CA31083D1FC474E31F8"},{"aid":"A000000152","index":"5D","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"AD938EA9888E5155F8CD272749172B3A8C504C17460EFA0BED7CBC5FD32C4A80FD810312281B5A35562800CDC325358A9639C501A537B7AE43DF263E6D232B811ACDB6DDE979D55D6C911173483993A423A0A5B1E1A70237885A241B8EEBB5571E2D32B41F9CC5514DF83F0D69270E109AF1422F985A52CCE04F3DF269B795155A68AD2D6B660DDCD759F0A5DA7B64104D22C2771ECE7A5FFD40C774E441379D1132FAF04CDF55B9504C6DCE9F61776D81C7C45F19B9EFB3749AC7D486A5AD2E781FA9D082FB2677665B99FA5F1553135A1FD2A2A9FBF625CA84A7D736521431178F13100A2516F9A43CE095B032B886C7A6AB126E203BE7","exponent":"03","checksum":"B51EC5F7DE9BB6D8BCE8FB5F69BA57A04221F39B"},{"aid":"A000000277","index":"02","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"E0FFBEE77CEE02ADEE8B4B004D26FB46FAF3CE033E3B874D73D099A966A0657497CEE214E95DF2BF5C9D359A3B10C05CFC9929BEF3070036FD19AE661B173E486CBC9B04E4B2E2D0D8209CAF5C200929FA252A21BD69A9A47488844A1DE5BF8729CE5E5E92117047BDDE9FBE72397FD9FC3BE459D8ED06FD6CADF0AFF39C93CC07B312EE2ACB3D4A15E919F57481CFEF","exponent":"010001","checksum":"BAF3652A9F5D0FF45EECECA55B4597B1F53BE283"},{"aid":"A000000277","index":"03","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"E51505CCECDD0799BAFE097200DF40FFC2154836B8D67F1E99D4D415F73C04A9FAD73825D32AE5BA77FCD02597393CE4D8104B6010D5A8F28F2B47BB8298DAFD63C9C0BEF62AF937265614E31AE2AB45B60B968DB9DEE55602C169F6C16D4579BAA24765560300A3056F894BA8FFA566D9CCD79453D804B97DA14F21F9C3528ED8B8A368A9FACF05C46C13A9BA020618425EF1ACF6CB4DD5DCD050273502114B59EE90EBD833F70C2F324741E79A19A1","exponent":"010001","checksum":"0FB60A1BCA38095F3CC578D2DEC95F779840A343"},{"aid":"A000000277","index":"07","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"B2CE89726B6B2D1690A0F8CA75CD0B6B1ACDFBE66D53BA00C500BE612FB421423684FF1868554A7722258012E588ED1CD206C67BB2F7598F3CE67F23A888B8ED7421C49A2EBA224DFBD866F62E59338E9F626D0DFD4C9ACC626E42EC0375EE424C93E5DB5773FC98E4AC9FCDEBD0521B15295C797DCABB4679C055AC374A81B245ABF1092A3D46E1CCE10A84F9FC2FC6ED91025121589C9AA68B56B7FBF0D86B4C8E3C9C08406DBB4609BBFC5308F325A8273CB6D36F3E0AF772507BF8A2A9F5A749B5AF98CCEAB2826C2D9C2AB9103B1BAB0DE92099C8072477EC564062AC38184C60DAD298EF352D92DFA041DDE3DB260CE5302B47A7E9","exponent":"010001","checksum":"44F2C13373A5068B63C9334E914DDE6AB70CE0F1"},{"aid":"A000000277","index":"40","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"F802C308544873AD2225A81943732A4B7CFFA4E3157D17CD5A7723F858F0B11E636D2930FA933778F27C7C49127E0CCA317021CFE8E0F773785EB3FF07587E98CE8ED4FE9E1CA1859F41A9CF2572D8A093C5465F5A29612A45B1700F4DA13814C3D4DF075EAADE8DB4BE4D7B3AE0256F7A0C12E34BD416CAC4F9250C38B7E13B","exponent":"010001","checksum":"2015497BE4B86F104BBF337691825EED64E101CA"},{"aid":"A000000065","index":"11","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"A2583AA40746E3A63C22478F576D1EFC5FB046135A6FC739E82B55035F71B09BEB566EDB9968DD649B94B6DEDC033899884E908C27BE1CD291E5436F762553297763DAA3B890D778C0F01E3344CECDFB3BA70D7E055B8C760D0179A403D6B55F2B3B083912B183ADB7927441BED3395A199EEFE0DEBD1F5FC3264033DA856F4A8B93916885BD42F9C1F456AAB8CFA83AC574833EB5E87BB9D4C006A4B5346BD9E17E139AB6552D9C58BC041195336485","exponent":"03","checksum":"D9FD62C9DD4E6DE7741E9A17FB1FF2C5DB948BCB"},{"aid":"A000000065","index":"13","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"A3270868367E6E29349FC2743EE545AC53BD3029782488997650108524FD051E3B6EACA6A9A6C1441D28889A5F46413C8F62F3645AAEB30A1521EEF41FD4F3445BFA1AB29F9AC1A74D9A16B93293296CB09162B149BAC22F88AD8F322D684D6B49A12413FC1B6AC70EDEDB18EC1585519A89B50B3D03E14063C2CA58B7C2BA7FB22799A33BCDE6AFCBEB4A7D64911D08D18C47F9BD14A9FAD8805A15DE5A38945A97919B7AB88EFA11A88C0CD92C6EE7DC352AB0746ABF13585913C8A4E04464B77909C6BD94341A8976C4769EA6C0D30A60F4EE8FA19E767B170DF4FA80312DBA61DB645D5D1560873E2674E1F620083F30180BD96CA589","exponent":"03","checksum":"54CFAE617150DFA09D3F901C9123524523EBEDF3"},{"aid":"A000000004","index":"06","expDate":"12312029","algorithm":"01","hashAlgorithm":"01","key":"CB26FC830B43785B2BCE37C81ED334622F9622F4C89AAE641046B2353433883F307FB7C974162DA72F7A4EC75D9D657336865B8D3023D3D645667625C9A07A6B7A137CF0C64198AE38FC238006FB2603F41F4F3BB9DA1347270F2F5D8C606E420958C5F7D50A71DE30142F70DE468889B5E3A08695B938A50FC980393A9CBCE44AD2D64F630BB33AD3F5F5FD495D31F37818C1D94071342E07F1BEC2194F6035BA5DED3936500EB82DFDA6E8AFB655B1EF3D0D7EBF86B66DD9F29F6B1D324FE8B26CE38AB2013DD13F611E7A594D675C4432350EA244CC34F3873CBA06592987A1D7E852ADC22EF5A2EE28132031E48F74037E3B34AB747F","exponent":"03","checksum":"F910A1504D5FFB793D94F3B500765E1ABCAD72D9"},{"aid":"A000000004","index":"EF","expDate":"12312029","algorithm":"01","hashAlgorithm":"01","key":"A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B","exponent":"03","checksum":"21766EBB0EE122AFB65D7845B73DB46BAB65427A"},{"aid":"A000000004","index":"F1","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"A0DCF4BDE19C3546B4B6F0414D174DDE294AABBB828C5A834D73AAE27C99B0B053A90278007239B6459FF0BBCD7B4B9C6C50AC02CE91368DA1BD21AAEADBC65347337D89B68F5C99A09D05BE02DD1F8C5BA20E2F13FB2A27C41D3F85CAD5CF6668E75851EC66EDBF98851FD4E42C44C1D59F5984703B27D5B9F21B8FA0D93279FBBF69E090642909C9EA27F898959541AA6757F5F624104F6E1D3A9532F2A6E51515AEAD1B43B3D7835088A2FAFA7BE7","exponent":"03","checksum":"D8E68DA167AB5A85D8C3D55ECB9B0517A1A5B4BB"},{"aid":"A000000003","index":"92","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"996AF56F569187D09293C14810450ED8EE3357397B18A2458EFAA92DA3B6DF6514EC060195318FD43BE9B8F0CC669E3F844057CBDDF8BDA191BB64473BC8DC9A730DB8F6B4EDE3924186FFD9B8C7735789C23A36BA0B8AF65372EB57EA5D89E7D14E9C7B6B557460F10885DA16AC923F15AF3758F0F03EBD3C5C2C949CBA306DB44E6A2C076C5F67E281D7EF56785DC4D75945E491F01918800A9E2DC66F60080566CE0DAF8D17EAD46AD8E30A247C9F","exponent":"03","checksum":"429C954A3859CEF91295F663C963E582ED6EB253"},{"aid":"A000000003","index":"94","expDate":"12312026","algorithm":"01","hashAlgorithm":"01","key":"ACD2B12302EE644F3F835ABD1FC7A6F62CCE48FFEC622AA8EF062BEF6FB8BA8BC68BBF6AB5870EED579BC3973E121303D34841A796D6DCBC41DBF9E52C4609795C0CCF7EE86FA1D5CB041071ED2C51D2202F63F1156C58A92D38BC60BDF424E1776E2BC9648078A03B36FB554375FC53D57C73F5160EA59F3AFC5398EC7B67758D65C9BFF7828B6B82D4BE124A416AB7301914311EA462C19F771F31B3B57336000DFF732D3B83DE07052D730354D297BEC72871DCCF0E193F171ABA27EE464C6A97690943D59BDABB2A27EB71CEEBDAFA1176046478FD62FEC452D5CA393296530AA3F41927ADFE434A2DF2AE3054F8840657A26E0FC617","exponent":"03","checksum":"C4A3C43CCF87327D136B804160E47D43B60E6E0F"},{"aid":"A000000333","index":"08","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"B61645EDFD5498FB246444037A0FA18C0F101EBD8EFA54573CE6E6A7FBF63ED21D66340852B0211CF5EEF6A1CD989F66AF21A8EB19DBD8DBC3706D135363A0D683D046304F5A836BC1BC632821AFE7A2F75DA3C50AC74C545A754562204137169663CFCC0B06E67E2109EBA41BC67FF20CC8AC80D7B6EE1A95465B3B2657533EA56D92D539E5064360EA4850FED2D1BF","exponent":"03","checksum":"EE23B616C95C02652AD18860E48787C079E8E85A"},{"aid":"A000000333","index":"09","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"EB374DFC5A96B71D2863875EDA2EAFB96B1B439D3ECE0B1826A2672EEEFA7990286776F8BD989A15141A75C384DFC14FEF9243AAB32707659BE9E4797A247C2F0B6D99372F384AF62FE23BC54BCDC57A9ACD1D5585C303F201EF4E8B806AFB809DB1A3DB1CD112AC884F164A67B99C7D6E5A8A6DF1D3CAE6D7ED3D5BE725B2DE4ADE23FA679BF4EB15A93D8A6E29C7FFA1A70DE2E54F593D908A3BF9EBBD760BBFDC8DB8B54497E6C5BE0E4A4DAC29E5","exponent":"03","checksum":"A075306EAB0045BAF72CDD33B3B678779DE1F527"},{"aid":"A000000333","index":"0A","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"B2AB1B6E9AC55A75ADFD5BBC34490E53C4C3381F34E60E7FAC21CC2B26DD34462B64A6FAE2495ED1DD383B8138BEA100FF9B7A111817E7B9869A9742B19E5C9DAC56F8B8827F11B05A08ECCF9E8D5E85B0F7CFA644EFF3E9B796688F38E006DEB21E101C01028903A06023AC5AAB8635F8E307A53AC742BDCE6A283F585F48EF","exponent":"03","checksum":"C88BE6B2417C4F941C9371EA35A377158767E4E3"},{"aid":"A000000333","index":"0B","expDate":"12312031","algorithm":"01","hashAlgorithm":"01","key":"CF9FDF46B356378E9AF311B0F981B21A1F22F250FB11F55C958709E3C7241918293483289EAE688A094C02C344E2999F315A72841F489E24B1BA0056CFAB3B479D0E826452375DCDBB67E97EC2AA66F4601D774FEAEF775ACCC621BFEB65FB0053FC5F392AA5E1D4C41A4DE9FFDFDF1327C4BB874F1F63A599EE3902FE95E729FD78D4234DC7E6CF1ABABAA3F6DB29B7F05D1D901D2E76A606A8CBFFFFECBD918FA2D278BDB43B0434F5D45134BE1C2781D157D501FF43E5F1C470967CD57CE53B64D82974C8275937C5D8502A1252A8A5D6088A259B694F98648D9AF2CB0EFD9D943C69F896D49FA39702162ACB5AF29B90BADE005BC157","exponent":"03","checksum":"BD331F9996A490B33C13441066A09AD3FEB5F66C"},{"aid":"A000000780","index":"A4","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"D22EF8F41F0685E371B53625692A7EB13B3E9462DD985E044A5915108D2DFCC0A4171C0C0DE4E6D9BD525CAC461A169DAC5101B975D105DEA2AA34B80D9131F47A278DA609B32B1379F98FB960328DE1E27E1EDAFD2DC8A3643AFEB605582C5F953E0DE029643DE058DA6813137EB9450C5C1AD36823BF4C548A5599F6C025274081F6BBF916D79CC00AB77C3AD8E35282FFC9A24CF5F31B0E5585618A75929FBAD4416EC853A76380C84DB3B208389EC2675C9CDEA4AC106EE6AEB242761EEFED6D744E3439588EB17B2CDD956658F59FBB2186B23B396B48E84A7702B91238059FB314CAFCF59B3F09787CCA396ABA35A144C0435DC99D","exponent":"03","checksum":"8438208C174CC1C3FB7793585BF1DE288349B31C"},{"aid":"A000000768","index":"E1","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"AD767119B139295B9EF760B9A94811580E933A03E76C0A7022F1021278EB6FBBEF36599D5A95C2CB603364E1DA12DF88B76D19F225F14D2A689C580DC2B54457C8BEA50086A4BE897D3353AA003CAFAB5AE3993BE6D379D488689028EC852DFED90EA6FDD73ACF6583934E64601A0EE45AF652B52CC58A9EFFA5D846DD79EFC9A8638275EC264B3C40AA3C8F3DDF1F9D378598362DF48417BF039A04D70B4FFA14A2F6218299428C625EF949F08740ED36FE9265BB8E2CA94604EFC0AEB654F9FC455F22B1EC46871E46638CE190D3691313E41C7F9C8AD4AE3D1B574D4336AD6A2BA551F2DB3A8D44F375CB67D94AFBDFD34DEA92066149","exponent":"03","checksum":"AE03037B9B042B0F9690500DEE287CD706FF73C8"},{"aid":"A000000768","index":"EE","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"A8D150CEE34B16D294B46B99BD6B3284303BD1FFD316C210E876666AD991DFE68DC1BD0835A5E03F753DB0DCE112A928C0C604F5DF256E265E05B59B4DAA15E74B0E5E27E56F8D97C1233D416162DDEC7EFE731D30BBA16683557E4D8FA15269F51D40468D1B2C31CCD314804FC97341F68A1BB78F4985B99F0901557B52196950CF6A12D6FD4356002197B17A8035606DAAC2BFCDB3CD86B9FCDBC64908BFB039C268772D73E44C3867AFC002C12CB5","exponent":"03","checksum":"6DFE06AB7FAD2D98EA18B7849D11DF704D08EFAE"}],"description":"Array containing the current EMV CA Public Keys.\n"}},"components/schemas/BoardingCompanyPlaid":{"id":"components/schemas/BoardingCompanyPlaid","kind":"json-schema","title":"BoardingCompanyPlaid","data":{"type":"object","description":"Company specific boarding information.\n","required":["name","legalEntityName","address"],"properties":{"name":{"type":"string","description":"The company name of the end customer being created. This will be used to display the end customer in the Plaid Dashboard. It will not be shown to end users.\n"},"legalEntityName":{"type":"string","description":"The end customer's legal name. This will be shared with financial institutions as part of the OAuth registration process. It will not be shown to end users.\n"},"address":{"type":"object","required":["city","street","region","postalCode","countryCode"],"properties":{"city":{"type":"string"},"street":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string","description":"ISO-3166-1 alpha-2 country code standar\n"}}},"website":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer's website. Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"www.shift4.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}]}}}},"components/schemas/SerialNumber":{"id":"components/schemas/SerialNumber","kind":"json-schema","title":"SerialNumber","data":{"type":"number","maxLength":10,"example":266,"description":"The Shift4 serial number\n"}},"components/schemas/S4Mid":{"id":"components/schemas/S4Mid","kind":"json-schema","title":"S4Mid","data":{"type":"number","maxLength":10,"example":123456,"description":"The Shift4 MID number\n"}},"components/schemas/ACHBoardingActive":{"id":"components/schemas/ACHBoardingActive","kind":"json-schema","title":"ACHBoardingActive","data":{"type":"string","enum":["Y","N"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or disable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" EMV on the account."},"children":[]}]}]}]}},"components/schemas/ACHWebhookURL":{"id":"components/schemas/ACHWebhookURL","kind":"json-schema","title":"ACHWebhookURL","data":{"type":"string","description":"A URL that outbound HTTP POST message is going to send to merchant from the Shift4 gateway that provides status of the ach request.\n"}},"components/schemas/boarding_create_ach_plaid_request":{"id":"components/schemas/boarding_create_ach_plaid_request","kind":"json-schema","title":"ACH Plaid","data":{"title":"ACH Plaid","type":"object","required":["dateTime","service","company","serial","s4mid","ach"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"service":{"type":"string","enum":["plaid"],"description":"The service being boarded.\n"},"company":{"$ref":"#/components/schemas/BoardingCompanyPlaid"},"serial":{"$ref":"#/components/schemas/SerialNumber"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"ach":{"type":"object","required":["active","paymentDescriptor","webhookUrl"],"properties":{"active":{"$ref":"#/components/schemas/ACHBoardingActive"},"paymentDescriptor":{"type":"string","maxLength":10,"example":"INTERNET","description":"Custom description that will be appended to the merchant name on the customer's statement. \n"},"plaid":{"type":"object","description":"Plaid specific boarding information.\n","properties":{"applicationName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the end customer's application. This will be shown to end users when they go through the Plaid Link flow. Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift4 App"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not sent."},"children":[]}]}]}]},"diligenceAttested":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether or not the partner has completed attestation of diligence for the end customer to be created. Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not sent."},"children":[]}]}]}]},"bankAddendumCompleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether the partner has forwarded the Plaid bank addendum to the end customer. Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not sent."},"children":[]}]}]}]},"products":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"investments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not sent."},"children":[]}]}]}]},"logo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded representation of the end customer's logo. Must be a PNG of size 1024x1024 under 4MB. The logo will be shared with financial institutions and shown to the end user during Link flows. A logo is required if create_link_customization is true. If create_link_customization is false and the logo is omitted, a stock logo will be used."},"children":[]}]}]}]},"createLinkCustomization":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the end customer's default Link customization will be set to match the partner's. You can always change the end customer's Link customization in the Plaid Dashboard. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://plaid.com/docs/link/customization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link Customization docs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"technicalContact":{"type":"object","description":"The technical contact for the end customer. Defaults to partner's technical contact if omitted.\n","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}}},"billingContact":{"type":"object","description":"The billing contact for the end customer. Defaults to partner's technical contact if omitted.\n","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}}},"customerSupportInfo":{"type":"object","description":"This information is public. Users of your app will see this information when managing connections between your app and their bank accounts in Plaid Portal. Defaults to partner's customer support info if omitted.\n","properties":{"email":{"type":"string"},"phoneNumber":{"type":"string"},"contactUrl":{"type":"string"},"linkUpdateUrl":{"type":"string"}}},"assetsUnderManagement":{"type":"object","description":"Assets under management for the given end customer. Required for end customers with monthly service commitments.\n","properties":{"amount":{"type":"number"},"isoCurrencyCode":{"type":"string"}}},"redirectUris":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of URIs indicating the destination(s) where a user can be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. URIs should not contain any query parameters. When used in Production or Development, URIs must use https. To specify any subdomain, use * as a wildcard character, e.g. https://*.example.com/oauth.html. To modify redirect URIs for an end customer after creating them, go to the end customer's API page in the Dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: must be sent if plaid.redirectUrl element is going to be used on plaid account verification endpoint."},"children":[]}]}]}]}]}}},"webhookUrl":{"$ref":"#/components/schemas/ACHWebhookURL"}}}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","service":"plaid","company":{"name":"Merchant XYZ","legalEntityName":"Merchant XYZ","address":{"city":"Las Vegas","street":"123 Main St","region":"NV","postalCode":"89134","countryCode":"US"},"website":"www.merchantxyz.com"},"serial":266,"s4mid":12346,"ach":{"active":"Y","paymentDescriptor":"UTILITY","plaid":{"applicationName":"Shift4 App","diligenceAttested":true,"bankAddendumCompleted":false,"products":["auth","balance"]},"webhookUrl":"api.merchantxyz.com/webhook"}}}},"components/schemas/BoardingCompanyACHStandalone":{"id":"components/schemas/BoardingCompanyACHStandalone","kind":"json-schema","title":"BoardingCompanyACHStandalone","data":{"type":"object","description":"Company specific boarding information.\n","required":["name","legalEntityName","address"],"properties":{"name":{"type":"string","description":"The company name of the end customer being created. This will be used to display the end customer in the Plaid Dashboard. It will not be shown to end users.\n"},"legalEntityName":{"type":"string","description":"The end customer's legal name. This will be shared with financial institutions as part of the OAuth registration process. It will not be shown to end users.\n"},"address":{"type":"object","required":["city","street","region","postalCode","countryCode"],"properties":{"city":{"type":"string"},"street":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string","description":"ISO-3166-1 alpha-2 country code standar\n"}}},"website":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer's website. Defaulted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"www.shift4.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}]}}}},"components/schemas/boarding_create_ach_standalone_request":{"id":"components/schemas/boarding_create_ach_standalone_request","kind":"json-schema","title":"ACH Standalone","data":{"title":"ACH Standalone","type":"object","required":["dateTime","service","company","serial","s4mid","ach"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"service":{"type":"string","enum":["achstandalone"],"description":"The service being boarded.\n"},"company":{"$ref":"#/components/schemas/BoardingCompanyACHStandalone"},"serial":{"$ref":"#/components/schemas/SerialNumber"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"ach":{"type":"object","required":["active","paymentDescriptor","webhookUrl"],"properties":{"active":{"$ref":"#/components/schemas/ACHBoardingActive"},"paymentDescriptor":{"type":"string","maxLength":10,"example":"INTERNET","description":"Custom description that will be appended to the merchant name on the customer's statement. \n"},"webhookUrl":{"$ref":"#/components/schemas/ACHWebhookURL"}}}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","service":"achstandalone","company":{"name":"Merchant XYZ","legalEntityName":"Merchant XYZ","address":{"city":"Las Vegas","street":"123 Main St","region":"NV","postalCode":"89134","countryCode":"US"},"website":"www.merchantxyz.com"},"serial":266,"s4mid":12346,"ach":{"active":"Y","paymentDescriptor":"UTILITY","webhookUrl":"api.merchantxyz.com/webhook"}}}},"components/schemas/BoardingCompanyGTV":{"id":"components/schemas/BoardingCompanyGTV","kind":"json-schema","title":"BoardingCompanyGTV","data":{"type":"object","description":"Company specific boarding information.\n","required":["legalEntityName","address","website"],"properties":{"legalEntityName":{"type":"string","description":"The merchant's legal name\n"},"address":{"type":"object","required":["city","countryCode"],"properties":{"city":{"type":"string","minLength":2,"maxLength":100,"description":"City in the merchant's primary address\n"},"countryCode":{"type":"string","minLength":2,"maxLength":2,"description":"The merchants's 2 letter ISO Country code in ISO-3166-1 alpha-2 format\n"}}},"website":{"description":"The merchant's website.\n"}}}},"components/schemas/GTVID":{"id":"components/schemas/GTVID","kind":"json-schema","title":"GTVID","data":{"type":"string","minLength":2,"maxLength":20,"example":"SPACEX","description":"The Shift4 GTV ID\n"}},"components/schemas/GTVNetworkToken":{"id":"components/schemas/GTVNetworkToken","kind":"json-schema","title":"GTVNetworkToken","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable card brand network tokenization"},"children":[]}]}]}]}},"components/schemas/GTVBinCode":{"id":"components/schemas/GTVBinCode","kind":"json-schema","title":"GTVBinCode","data":{"type":"string","minLength":2,"maxLength":20,"enum":["ML_GC","ML","MLBWESTERN","M","MAI","LTV_DEFAULT","LTV_GC","TV2G","HILTON"],"example":"ML_GC","description":"The GTV Bincode ID\n"}},"components/schemas/GTVBinCodeUnknown":{"id":"components/schemas/GTVBinCodeUnknown","kind":"json-schema","title":"GTVBinCodeUnknown","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to allow or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disallow tokenizing unkonwn BIN codes."},"children":[]}]}]}]}},"components/schemas/GTVTokenMod10":{"id":"components/schemas/GTVTokenMod10","kind":"json-schema","title":"GTVTokenMod10","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for GTV to generate tokens that pass mod10 or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for GTV to generate tokens that do not pass mod10."},"children":[]}]}]}]}},"components/schemas/GTVVaultSize":{"id":"components/schemas/GTVVaultSize","kind":"json-schema","title":"GTVVaultSize","data":{"type":"number","example":1024,"description":"Expected size of vault\n"}},"components/schemas/GTV":{"id":"components/schemas/GTV","kind":"json-schema","title":"GTV","data":{"type":"object","description":"GTV specific boarding information.\n","properties":{"id":{"$ref":"#/components/schemas/GTVID"},"networkToken":{"$ref":"#/components/schemas/GTVNetworkToken"},"bincode":{"$ref":"#/components/schemas/GTVBinCode"},"bincodeUnknown":{"$ref":"#/components/schemas/GTVBinCodeUnknown"},"tokenMod10":{"$ref":"#/components/schemas/GTVTokenMod10"},"vaultSize":{"$ref":"#/components/schemas/GTVVaultSize"}}}},"components/schemas/boarding_create_gtv_request":{"id":"components/schemas/boarding_create_gtv_request","kind":"json-schema","title":"GTV","data":{"title":"GTV","type":"object","required":["dateTime","service","company","s4mid","processor"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"service":{"type":"string","enum":["gtv"],"description":"The service being boarded.\n"},"company":{"$ref":"#/components/schemas/BoardingCompanyGTV"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"processor":{"type":"string","enum":["TSYS","Finaro"]},"gtv":{"$ref":"#/components/schemas/GTV"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","service":"gtv","company":{"legalEntityName":"Merchant XYZ","address":{"city":"Las Vegas","countryCode":"US"},"website":"www.merchantxyz.com"},"s4mid":12346,"processor":"TSYS","gtv":{"id":"SPACEX","networkToken":"Y","bincode":"ML_GC","bincodeUnknown":"Y","tokenMod10":"Y","vaultSize":200000}}}},"components/schemas/BoardingCompanyMagicCube":{"id":"components/schemas/BoardingCompanyMagicCube","kind":"json-schema","title":"BoardingCompanyMagicCube","data":{"type":"object","description":"Company specific boarding information.\n","required":["legalEntityName","address","website"],"properties":{"legalEntityName":{"type":"string","description":"The merchant's legal name\n"},"address":{"type":"object","required":["city","countryCode"],"properties":{"city":{"type":"string","minLength":2,"maxLength":100,"description":"City in the merchant's primary address\n"},"countryCode":{"type":"string","minLength":2,"maxLength":2,"description":"The merchants's 2 letter ISO Country code in ISO-3166-1 alpha-2 format\n"}}},"website":{"description":"The merchant's website.\n"}}}},"components/schemas/boarding_create_magiccube_request":{"id":"components/schemas/boarding_create_magiccube_request","kind":"json-schema","title":"MagicCube","data":{"title":"MagicCube","type":"object","required":["dateTime","service","company","s4mid"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"service":{"type":"string","enum":["magiccube"],"description":"The service being boarded.\n"},"company":{"$ref":"#/components/schemas/BoardingCompanyMagicCube"},"s4mid":{"$ref":"#/components/schemas/S4Mid"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","service":"magiccube","company":{"legalEntityName":"Merchant XYZ","address":{"city":"Las Vegas","countryCode":"US"},"website":"www.merchantxyz.com"},"s4mid":12346}}},"components/schemas/ACHStatus":{"id":"components/schemas/ACHStatus","kind":"json-schema","title":"ACHStatus","data":{"type":"string","enum":["success","failed"],"description":"ACH status response\n"}},"components/schemas/boarding_create_ach_plaid_response":{"id":"components/schemas/boarding_create_ach_plaid_response","kind":"json-schema","title":"ACH Plaid","data":{"title":"ACH Plaid","type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"serial":{"$ref":"#/components/schemas/SerialNumber"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"ach":{"type":"object","properties":{"active":{"$ref":"#/components/schemas/ACHBoardingActive"},"plaid":{"type":"object","properties":{"createDateTime":{"type":"string","format":"ISO 8601","example":"2024-01-17T13:34:25.049-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the given end customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNDER_REVIEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer has been created and enabled in the non-Production environments. The end customer must be manually reviewed by the Plaid team before it can be enabled in production, at which point its status will automatically transition to PENDING_ENABLEMENT or DENIED."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_ENABLEMENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer is ready to be enabled in the Production environment. Call the /partner/customer/enable endpoint to enable the end customer in Production."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer has been enabled in all environments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DENIED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end customer has been created and enabled in the non-Production environments, but it did not pass review by the Plaid team and therefore cannot be enabled in the Production environment. Talk to your Account Manager for more information."},"children":[]}]}]}]}]}]}]},"link_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the Plaid Link boarding."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid Link boarding was successful"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid Link boarding was not successful"},"children":[]}]}]}]}]}]}]}}},"status":{"$ref":"#/components/schemas/ACHStatus"}}},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","serial":266,"s4mid":12346,"ach":{"active":"Y","plaid":{"createDateTime":"2023-02-17T09:08:08.748-07:00","status":"ACTIVE","link_status":"success"},"status":"success"},"server":{"name":"TM01CE"}}}},"components/schemas/boarding_create_ach_standalone_response":{"id":"components/schemas/boarding_create_ach_standalone_response","kind":"json-schema","title":"ACH Standalone","data":{"title":"ACH Standalone","type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"serial":{"$ref":"#/components/schemas/SerialNumber"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"ach":{"type":"object","properties":{"active":{"$ref":"#/components/schemas/ACHBoardingActive"},"status":{"$ref":"#/components/schemas/ACHStatus"}}},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","serial":266,"s4mid":12346,"ach":{"active":"Y","status":"success"},"server":{"name":"TM01CE"}}}},"components/schemas/boarding_create_gtv_response":{"id":"components/schemas/boarding_create_gtv_response","kind":"json-schema","title":"GTV","data":{"title":"GTV","type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"gtv":{"$ref":"#/components/schemas/GTV"},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","s4mid":12346,"gtv":{"id":"SPACEX","networkToken":"Y","bincode":"ML_GC","bincodeUnknown":"Y","tokenMod10":"Y","vaultSize":200000},"server":{"name":"TM01CE"}}}},"components/schemas/boarding_create_magiccube_response":{"id":"components/schemas/boarding_create_magiccube_response","kind":"json-schema","title":"MagicCube","data":{"title":"MagicCube","type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"s4mid":{"$ref":"#/components/schemas/S4Mid"},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-17T09:07:23.283-07:00","s4mid":12346,"server":{"name":"TM01CE"}}}},"components/schemas/Kiosk":{"id":"components/schemas/Kiosk","kind":"json-schema","title":"Kiosk","data":{"type":"object","properties":{"mode":{"type":"string","enum":["enabled","disabled"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable kiosk mode or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable kiosk mode. The response value will indicate the actual state. In the case where you attempt to enable kiosk mode but Commerce Engine is unable to enable it, the response will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/devices_config_comengdevice":{"id":"components/schemas/devices_config_comengdevice","kind":"json-schema","title":"Commerce Engine For On Premise","data":{"title":"Commerce Engine For On Premise","type":"object","required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"kiosk":{"$ref":"#/components/schemas/Kiosk"}}}},"components/schemas/devices_config_comengcloud":{"id":"components/schemas/devices_config_comengcloud","kind":"json-schema","title":"Commerce Engine For Cloud","data":{"title":"Commerce Engine For Cloud","type":"object","required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceComEngCloud"},"kiosk":{"$ref":"#/components/schemas/Kiosk"}}}},"components/schemas/DeviceCloudMQQueue":{"id":"components/schemas/DeviceCloudMQQueue","kind":"json-schema","title":"DeviceCloudMQQueue","data":{"type":"string","example":"93680a92-ca54-4a5d-8f84-e63418860e13","description":"Specifies the message queue name\n"}},"components/schemas/DeviceCloudMQRouting":{"id":"components/schemas/DeviceCloudMQRouting","kind":"json-schema","title":"DeviceCloudMQRouting","data":{"type":"string","example":"Pax.1170301234","description":"Specifies the message queue routing key\n"}},"components/schemas/DeviceCloudMQServer":{"id":"components/schemas/DeviceCloudMQServer","kind":"json-schema","title":"DeviceCloudMQServer","data":{"type":"string","example":"wh-mq-v03.dev.shift4.net:5671","description":"Specifies the message queue server URL the device cloud solution should connect to\n"}},"components/schemas/DeviceCloudMQType":{"id":"components/schemas/DeviceCloudMQType","kind":"json-schema","title":"DeviceCloudMQType","data":{"type":"string","enum":["RMQ"],"example":"RMQ","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of message queue broker the device cloud solution will be connecting to."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RMQ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RabbitMQ"},"children":[]}]}]}]}]}]}]}},"components/schemas/DeviceCloudMQVHost":{"id":"components/schemas/DeviceCloudMQVHost","kind":"json-schema","title":"DeviceCloudMQVHost","data":{"type":"string","example":"rabbitmq-dev","description":"Specifies the message queue virtual host the device cloud solution should connect to\n"}},"components/schemas/DeviceTerminalIdMagicCube":{"id":"components/schemas/DeviceTerminalIdMagicCube","kind":"json-schema","title":"DeviceTerminalIdMagicCube","data":{"type":"string","example":"9876543213","description":"Terminal ID\n"}},"components/schemas/DeviceMCRock":{"id":"components/schemas/DeviceMCRock","kind":"json-schema","title":"DeviceMCRock","data":{"type":"string","example":"QyN2LlqKzuTcpIz9","description":"MagicCube Rock\n"}},"components/schemas/MagicCubePed_PBK":{"id":"components/schemas/MagicCubePed_PBK","kind":"json-schema","title":"MagicCubePed_PBK","data":{"type":"string","example":"-----BEGIN CERTIFICATE-----\\nMIIDMjCCAZoCEQDn7O4vkjJF4n8I2PgAx5JbMA0GCSqGSIb3DQEBCwUAMBcxFTAT\\nBgNVBAMMDG1hZ2ljY3ViZS5jbzAeFw0yMzA3MTkwMDAwMDBaFw0yNDA3MTgwMDAw\\nMDBaMBcxFTATBgNVBAMMDG1hZ2ljY3ViZS5jbzCCASIwDQYJKoZIhvcNAQEBBQAD\\nggEPADCCAQoCggEBANLB4rH6fBHFPrAdLAtoQCmW8sTswNgrIs5M2bqRlk3Tv1wg\\n8wANu2o6TPNTV9bxwKz4cDdWqaM98PXHyVJZmQA4dbzNhrndNSuT6yftL0awpmZm\\nlXevLABtIUVf9S+z1VcDzxFyJaMdpNkBuXG6gTR4dQLXXle9FPH79afvBfRZf\\/Of\\nnPZoGM27AWctFv6W0NwDv0iUhvMYEzEmUR2PwDtD5Ws9\\/sO8W1kpIjNd9KGQOI4o\\nNil4gtnAF7ODGVO6OjIm8YQeD\\/AvfTTo7IOPc\\/kq9h0UN3pulDbvOUloobQouNyJ\\nSq1D10XD3d9tw7vIaurs5NURwy\\/glZDsi+A0uSMCAwEAATANBgkqhkiG9w0BAQsF\\nAAOCAYEAmZdJ+yqeP+tq6wWtBp9TspDKQPXO5xKHS8oLXVjlfjvftAA2260C8u24\\nV9Gta7dJcKxewkVWRh2AyoJToks2aJm8aL1XmtZeJ6bMJEEnxDGOAhsOYF2relyY\\n6mTf9\\/SBMSfK2BP3w1T0TUn+fEXQA4a7DyK73k15WJy4j4wzTmrRGXno0p7Pq4eC\\nNLW9QTYzeoAi\\/nHt5MqxOn23+1kGX3\\/yYoNl7gFWozqzzouNL6qNIdkdEGQYL5Mv\\nl70FyoezWyPmXUMfRGRHwMXKGhRn98pQBkV91K2lg2Ovkwv8hknv1ux59M+gpXZG\\nVAPPuDjkvYh\\/VheKdxjRwaCiIflrDM58af4gZ+AcGVLDTHRie8z5Ok1oA4pavPHb\\neE+0AzUOpq2gxPxMBiBf1CtHTLEMXal2mqJpbkElCVSoXZpJeUibzlSD6sh22Eb4\\nPupc9SDyHv76p\\/Hrqcnr0eiuzbCTtWtPariOruDeseiYvwpIF\\/yssqdzRURe6uPW\\nsT\\/nkmlt\\n-----END CERTIFICATE-----\\n","description":"MagicCube Ped PBK\n"}},"components/schemas/MagicCubeE_IPEK":{"id":"components/schemas/MagicCubeE_IPEK","kind":"json-schema","title":"MagicCubeE_IPEK","data":{"type":"string","example":"Yn2gV_IgV5LAq6zG9QIcqitFjigQvEMy6F0lBZucV_yxoouyzWpB2wDOG7scIgGF5JeWPhuMAsL2t6QFw6tyB2Jozx0tELxXYabsMvvYWRAm7Ruf2YGVbFgT-W7hMhT3N1hzAIXkPhjFUqPBkgLl5bGb1SFa4XL0fVG_iHNXFMYIoh4QMSKC6hcIblqtnDEmt80KxMtx92dDdW32rZwVXDfIvBAy0JzFbSggHbdTkJGp-VQsYKXf0J3cgc9CNcmpgq8f48k-XQIgbexEQXITzABpbZDr3tccljEEU1mEX18-H11ie8BJmcqhhaN40YHqQgWBQ2GJGzAo_V-aQRivTg==","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MagicCube e_ipek"},"children":[]}]}]}]}},"components/schemas/MagicCubeIKSN":{"id":"components/schemas/MagicCubeIKSN","kind":"json-schema","title":"MagicCubeIKSN","data":{"type":"string","example":"__9JUgAXAAAAAA==","description":"MagicCube iksn\n"}},"components/schemas/MagicCubeSystemReadyResult":{"id":"components/schemas/MagicCubeSystemReadyResult","kind":"json-schema","title":"MagicCubeSystemReadyResult","data":{"type":"string","enum":["ok"],"example":"ok","description":"MagicCube System Ready Result\n"}},"components/schemas/CurrencyCodeGlobal":{"id":"components/schemas/CurrencyCodeGlobal","kind":"json-schema","title":"CurrencyCodeGlobal","data":{"type":"string","format":"ISO 4217 3 Character Alphabetic Code","example":"EUR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction currency code. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for details."},"children":[]}]}]}]}},"components/schemas/CardMaskedNumberRequest":{"id":"components/schemas/CardMaskedNumberRequest","kind":"json-schema","title":"CardMaskedNumberRequest","data":{"type":"string","maxLength":32,"example":"XXXXXXXXXXXX1119","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked card number showing just the last 4 digits of the card with the rest of the card digits masked with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CardBinRequest":{"id":"components/schemas/CardBinRequest","kind":"json-schema","title":"CardBinRequest","data":{"type":"string","maxLength":8,"example":"432100","description":"The first 6 or 8 digits of the card.\n"}},"components/schemas/TransactionType":{"id":"components/schemas/TransactionType","kind":"json-schema","title":"TransactionType","data":{"type":"string","example":"Sale","enum":["Sale","Authorization","Incremental","Refund","Void","Capture"],"description":"Specifies the transaction type.\n"}},"components/schemas/TransactionResponseCodeApproved":{"id":"components/schemas/TransactionResponseCodeApproved","kind":"json-schema","title":"TransactionResponseCodeApproved","data":{"type":"string","minLength":1,"maxLength":1,"example":"A","enum":["A"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is approved."},"children":[]}]}]}]}]}]}]}},"components/schemas/PurchaseCardOptional":{"id":"components/schemas/PurchaseCardOptional","kind":"json-schema","title":"PurchaseCardOptional","data":{"type":"object","properties":{"customerReference":{"$ref":"#/components/schemas/PurchaseCardCustomerReference"},"destinationPostalCode":{"$ref":"#/components/schemas/PurchaseCardDestinationPostalCode"},"productDescriptors":{"$ref":"#/components/schemas/PurchaseCardProductDescriptors"}}}},"components/schemas/EMVTlvDataReportUpload":{"id":"components/schemas/EMVTlvDataReportUpload","kind":"json-schema","title":"EMVTlvDataReportUpload","data":{"type":"string","writeOnly":true,"example":"4F07A0000000041010500A4D6173746572436172645F201A546573742F4361726420303920202020202020202020202020205F24032512315F25031511015F2D02656E5F3401018407A0000000041010950508200000009B02C8009F02060000000004449F03060000000000009F34031E03009F3704C5BF918D9F390105","description":"This field will contain all EMV tags in standard TLV format except tags 5A and 57.\n"}},"components/schemas/EMVReportUpload":{"id":"components/schemas/EMVReportUpload","kind":"json-schema","title":"EMVReportUpload","data":{"type":"object","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Required when the request was processed an EMV insert or tap."},"children":[]}]}]}]}],"required":["tlvData"],"properties":{"emptyCandidateList":{"$ref":"#/components/schemas/EMVEmptyCandidateList"},"tlvData":{"$ref":"#/components/schemas/EMVTlvDataReportUpload"}}}},"components/schemas/transactions_reportupload_approval":{"id":"components/schemas/transactions_reportupload_approval","kind":"json-schema","title":"Approval","data":{"title":"Approval","type":"object","required":["dateTime","amount","currencyCode","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeGlobal"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"},"card":{"type":"object","required":["entryMode","present","type"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"debitType":{"$ref":"#/components/schemas/CardDebitType"},"number":{"$ref":"#/components/schemas/CardMaskedNumberRequest"},"bin":{"$ref":"#/components/schemas/CardBinRequest"}}},"transaction":{"type":"object","required":["invoice","type","authorizationCode","responseCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"type":{"$ref":"#/components/schemas/TransactionType"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeApproved"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardOptional"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"device":{"type":"object","properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"emv":{"$ref":"#/components/schemas/EMVReportUpload"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"customer":{"$ref":"#/components/schemas/Customer"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"currencyCode":"EUR","card":{"entryMode":"E","present":"Y","type":"DB","debitType":"girocard","number":"XXXXXXXXXXXX1119","bin":"432100"},"clerk":{"numericId":1576},"device":{"manufacturer":"Verifone","model":"V660p-A","serialNumber":"454123456","terminalId":"002211223344-1"},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"transaction":{"invoice":"192029","authorizationCode":"OK987Z","responseCode":"A","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}],"pspData":{"pspId":"PSP Name XYZ","pspMid":"123456","pspTid":"12345678","pspTxnTraceNo":"000013","pspTxnDate":"20210415","pspTxnTime":"182328","pspResponseCode":"00","pspResponseText":"Payment Approved"}}}}},"components/schemas/TransactionResponseCodeDeclined":{"id":"components/schemas/TransactionResponseCodeDeclined","kind":"json-schema","title":"TransactionResponseCodeDeclined","data":{"type":"string","minLength":1,"maxLength":1,"example":"D","enum":["D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the transaction status"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is declined."},"children":[]}]}]}]}]}]}]}},"components/schemas/transactions_reportupload_decline":{"id":"components/schemas/transactions_reportupload_decline","kind":"json-schema","title":"Decline","data":{"title":"Decline","type":"object","required":["dateTime","amount","currencyCode","card","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"accountType":{"$ref":"#/components/schemas/AccountType"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeGlobal"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"},"card":{"type":"object","required":["entryMode","present","type"],"properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"debitType":{"$ref":"#/components/schemas/CardDebitType"},"number":{"$ref":"#/components/schemas/CardMaskedNumberRequest"},"bin":{"$ref":"#/components/schemas/CardBinRequest"}}},"transaction":{"type":"object","required":["invoice","type","responseCode"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"type":{"$ref":"#/components/schemas/TransactionType"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeDeclined"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"airline":{"$ref":"#/components/schemas/AirlineRequest"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"hotel":{"$ref":"#/components/schemas/HotelCheckOut"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCardOptional"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"device":{"type":"object","properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdComEng"}}},"emv":{"$ref":"#/components/schemas/EMVReportUpload"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"customer":{"$ref":"#/components/schemas/Customer"},"reportingData":{"$ref":"#/components/schemas/ReportingData"},"mPos":{"$ref":"#/components/schemas/mPOS"},"dcc":{"$ref":"#/components/schemas/DCCTransactionRequest"},"surcharge":{"$ref":"#/components/schemas/SurchargeRequest"}},"example":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"currencyCode":"EUR","card":{"entryMode":"E","present":"Y","type":"DB","debitType":"girocard","number":"XXXXXXXXXXXX1119","bin":"432100"},"clerk":{"numericId":1576},"device":{"manufacturer":"Verifone","model":"V660p-A","serialNumber":"454123456","terminalId":"002211223344-1"},"emv":{"tlvData":"9F40056000F0A0019F02060000000111009F03060000000000009F26088D24914341485DE14F07A00000000310109F0607A000000003101082021C009F360202929F34035E03009F2701809F3901059F3303E0F8C89F1A0208409F350122950580800080005F2A0208409A032107229B0268009F21031016209C01009F3704D2EAB1B55F2D02656E5F3401015A181CF757386DE00BC2DE05F965DB1E96D867C2009CA8C317998407A00000000310109F100706010A03A0A000573083FBDC0892887F7C99E0B7E54520CCC94308B4E4C7D4C18CDCE4EAA83C4D18A6AFDCD53EAC46BD5630834EFB238F32B39F0D05B0508088009F0E0500000000009F0F05B0508098009F0702FF009F080200969F0902008C5F280208409F4104000000085F24032212319F1E083131373031373332"},"transaction":{"invoice":"192029","responseCode":"D","hotel":{"additionalCharges":{"giftShop":"Y","laundry":"Y","miniBar":"Y","other":"Y","restaurant":"Y","telephone":"Y"},"arrivalDateTime":"2021-04-12T15:39:01.594-07:00","departureDateTime":"2021-04-15T09:18:23.283-07:00","primaryChargeType":1,"roomRates":[{"nights":2,"rate":159.95},{"nights":3,"rate":125.38}],"specialCode":1},"notes":"Transaction notes are added here","purchaseCard":{"customerReference":"D019D09309F2","destinationPostalCode":"94719","productDescriptors":["Hamburger","Fries","Soda","Cookie"]}},"reportingData":{"customerInfo":[{"firstName":"Jane","lastName":"Smith","dateOfBirth":"12011983","gender":"female","baggage":"checked","seats":"1A","boardingPriority":"1"},{"firstName":"John","lastName":"Smith","dateOfBirth":"01281980","gender":"male","baggage":"carryon","seats":"1B","boardingPriority":"1"}],"pspData":{"pspId":"PSP Name XYZ","pspMid":"123456","pspTid":"12345678","pspTxnTraceNo":"000013","pspTxnDate":"20210415","pspTxnTime":"182328","pspResponseCode":"05","pspResponseText":"Payment Declined"}}}}},"components/schemas/TransactionProcessorPaymentId":{"id":"components/schemas/TransactionProcessorPaymentId","kind":"json-schema","title":"TransactionProcessorPaymentId","data":{"type":"string","maxLength":32,"example":"XZZ5600f5a7b9659661PKK6LHZHRVDWB","description":"A unique transaction identifier from the processor that accompanies all transactions related to the same purchase.\n"}},"components/schemas/TransactionProcessorResponseId":{"id":"components/schemas/TransactionProcessorResponseId","kind":"json-schema","title":"TransactionProcessorResponseId","data":{"type":"string","maxLength":32,"example":"XZZ5600f5a7b9659661LOMKCO64A5A7R","description":"A unique processor response ID.\n"}},"components/schemas/RiskRulesGetStatusParameter":{"id":"components/schemas/RiskRulesGetStatusParameter","kind":"json-schema","title":"RiskRulesGetStatusParameter","data":{"type":"string","example":"emailAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of rule"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Address"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deviceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device ID Fingerprint"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesValue":{"id":"components/schemas/RiskRulesValue","kind":"json-schema","title":"RiskRulesValue","data":{"type":"string","example":"johnsmith@xyz.com","description":"Specifies the value of the rule parameter.\n"}},"components/schemas/RiskRulesGetStatusResult":{"id":"components/schemas/RiskRulesGetStatusResult","kind":"json-schema","title":"RiskRulesGetStatusResult","data":{"type":"string","example":"S","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the result of the get request rule status"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get rule status request succeeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get rule status request failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskRules.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not be returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error condition occurred during get rule status request."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskRules.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not be returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskRules.status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not be returned."},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesGetStatusStatus":{"id":"components/schemas/RiskRulesGetStatusStatus","kind":"json-schema","title":"RiskRulesGetStatusStatus","data":{"type":"string","example":"D","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the status of the rule"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesGetStatus":{"id":"components/schemas/RiskRulesGetStatus","kind":"json-schema","title":"RiskRulesGetStatus","data":{"type":"object","required":["parameter","value","result"],"properties":{"parameter":{"$ref":"#/components/schemas/RiskRulesGetStatusParameter"},"value":{"$ref":"#/components/schemas/RiskRulesValue"},"result":{"$ref":"#/components/schemas/RiskRulesGetStatusResult"},"status":{"$ref":"#/components/schemas/RiskRulesGetStatusStatus"}}}},"components/schemas/RiskRulesGetStatusArray":{"id":"components/schemas/RiskRulesGetStatusArray","kind":"json-schema","title":"RiskRulesGetStatusArray","data":{"type":"array","items":{"$ref":"#/components/schemas/RiskRulesGetStatus"},"example":[{"parameter":"email","value":"johnsmith@xyz.com"},{"parameter":"email","value":"joebob@abc.com"},{"parameter":"deviceId","value":"5F67753832224611BF697A590316AA34"}],"description":"Array of risk rules objects.\n"}},"components/schemas/RiskRulesUpdateParameter":{"id":"components/schemas/RiskRulesUpdateParameter","kind":"json-schema","title":"RiskRulesUpdateParameter","data":{"type":"string","example":"emailAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of rule"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Address"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deviceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device ID Fingerprint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfcb"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund or Chargeback"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesUpdateResult":{"id":"components/schemas/RiskRulesUpdateResult","kind":"json-schema","title":"RiskRulesUpdateResult","data":{"type":"string","example":"S","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the result of the request rule action"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule update succeeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule update failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible reasons: format error, invalid token, invalid status requested, etc."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error condition occurred."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible reasons: unable to reach processor, processor returned unknown error, etc."},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesUpdateStatus":{"id":"components/schemas/RiskRulesUpdateStatus","kind":"json-schema","title":"RiskRulesUpdateStatus","data":{"type":"string","example":"D","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the status of the rule"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value cannot be used if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskRules.parameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 'card' or 'token'"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]}},"components/schemas/RiskRulesCBCode":{"id":"components/schemas/RiskRulesCBCode","kind":"json-schema","title":"RiskRulesCBCode","data":{"type":"integer","example":1,"description":"Chargeback code\n"}},"components/schemas/RiskRulesUpdate":{"id":"components/schemas/RiskRulesUpdate","kind":"json-schema","title":"RiskRulesUpdate","data":{"type":"object","required":["parameter","value","result","status"],"properties":{"parameter":{"$ref":"#/components/schemas/RiskRulesUpdateParameter"},"value":{"$ref":"#/components/schemas/RiskRulesValue"},"result":{"$ref":"#/components/schemas/RiskRulesUpdateResult"},"status":{"$ref":"#/components/schemas/RiskRulesUpdateStatus"},"cbCode":{"$ref":"#/components/schemas/RiskRulesCBCode"}}}},"components/schemas/RiskRulesUpdateArray":{"id":"components/schemas/RiskRulesUpdateArray","kind":"json-schema","title":"RiskRulesUpdateArray","data":{"type":"array","items":{"$ref":"#/components/schemas/RiskRulesUpdate"},"example":[{"parameter":"email","value":"johnsmith@xyz.com","status":"D"},{"parameter":"email","value":"joebob@abc.com","status":"A"},{"parameter":"token","value":"8048471746471119","status":"R"},{"parameter":"card","value":"4321000000001119","status":"X"},{"parameter":"deviceId","value":"5F67753832224611BF697A590316AA34","status":"D"}],"description":"Array of risk rules objects.\n"}},"components/schemas/RiskRulesUpdateStatusResponse":{"id":"components/schemas/RiskRulesUpdateStatusResponse","kind":"json-schema","title":"RiskRulesUpdateStatusResponse","data":{"type":"string","example":"D","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the status of the rule"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskRulesUpdateResponse":{"id":"components/schemas/RiskRulesUpdateResponse","kind":"json-schema","title":"RiskRulesUpdateResponse","data":{"type":"object","required":["parameter","value","result","status"],"properties":{"parameter":{"$ref":"#/components/schemas/RiskRulesUpdateParameter"},"value":{"$ref":"#/components/schemas/RiskRulesValue"},"result":{"$ref":"#/components/schemas/RiskRulesUpdateResult"},"status":{"$ref":"#/components/schemas/RiskRulesUpdateStatusResponse"}}}},"components/schemas/RiskRulesUpdateArrayResponse":{"id":"components/schemas/RiskRulesUpdateArrayResponse","kind":"json-schema","title":"RiskRulesUpdateArrayResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/RiskRulesUpdateResponse"},"example":[{"parameter":"email","value":"johnsmith@xyz.com","status":"D"},{"parameter":"email","value":"joebob@abc.com","status":"A"},{"parameter":"token","value":"8048471746471119","status":"R"},{"parameter":"card","value":"4321000000001119","status":"X"},{"parameter":"deviceId","value":"5F67753832224611BF697A590316AA34","status":"D"}],"description":"Array of risk rules objects.\n"}},"components/schemas/RiskListID":{"id":"components/schemas/RiskListID","kind":"json-schema","title":"RiskListID","data":{"type":"number","example":"306","description":"Risk List ID\n"}},"components/schemas/RiskListRecCreateDateTime":{"id":"components/schemas/RiskListRecCreateDateTime","kind":"json-schema","title":"RiskListRecCreateDateTime","data":{"type":"string","format":"ISO 8601","example":"2023-06-10T06:34:25.049205-07:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The record creation date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm)."},"children":[]}]}]}]}},"components/schemas/RiskListCategory":{"id":"components/schemas/RiskListCategory","kind":"json-schema","title":"RiskListCategory","data":{"type":"string","enum":["sourceIp","emailAddress","emailDomain","fullName","token"],"example":"emailAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The risk category. If there is already an active record for the risk category and value specified the previous record will become inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceIp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extract from sourceIp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"emailAddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extract from customer.emailAddress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"emailDomain"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extract from customer.emailAddress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fullName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extract from customer.fullName"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extract from card.token.value"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskListUser":{"id":"components/schemas/RiskListUser","kind":"json-schema","title":"RiskListUser","data":{"type":"string","example":"John Smith","description":"User requesting the change.\n"}},"components/schemas/RiskListValue":{"id":"components/schemas/RiskListValue","kind":"json-schema","title":"RiskListValue","data":{"type":"string","example":"janedoe@email.com","description":"Risk List value based on the risk category being supplied\n"}},"components/schemas/RiskListAction":{"id":"components/schemas/RiskListAction","kind":"json-schema","title":"RiskListAction","data":{"type":"string","enum":["A","D","N"],"example":"A","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk List Action"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nothing"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskListActive":{"id":"components/schemas/RiskListActive","kind":"json-schema","title":"RiskListActive","data":{"type":"string","enum":["Y","N"],"example":"Y","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk List Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Y"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskListStatus":{"id":"components/schemas/RiskListStatus","kind":"json-schema","title":"RiskListStatus","data":{"type":"string","example":"S","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the result of the rule status"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"S"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]}]}]}]}]}},"components/schemas/RiskListQueryObject":{"id":"components/schemas/RiskListQueryObject","kind":"json-schema","title":"RiskListQueryObject","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RiskListID"},"recCreateDateTime":{"$ref":"#/components/schemas/RiskListRecCreateDateTime"},"category":{"$ref":"#/components/schemas/RiskListCategory"},"user":{"$ref":"#/components/schemas/RiskListUser"},"value":{"$ref":"#/components/schemas/RiskListValue"},"action":{"$ref":"#/components/schemas/RiskListAction"},"active":{"$ref":"#/components/schemas/RiskListActive"},"mid":{"$ref":"#/components/schemas/S4Mid"},"status":{"$ref":"#/components/schemas/RiskListStatus"}}}},"components/schemas/RiskListQuery":{"id":"components/schemas/RiskListQuery","kind":"json-schema","title":"RiskListQuery","data":{"type":"array","items":{"$ref":"#/components/schemas/RiskListQueryObject"}}},"components/schemas/RiskListObject":{"id":"components/schemas/RiskListObject","kind":"json-schema","title":"RiskListObject","data":{"type":"object","required":["category","user","value","action","active","mid"],"properties":{"category":{"$ref":"#/components/schemas/RiskListCategory"},"user":{"$ref":"#/components/schemas/RiskListUser"},"value":{"$ref":"#/components/schemas/RiskListValue"},"action":{"$ref":"#/components/schemas/RiskListAction"},"active":{"$ref":"#/components/schemas/RiskListActive"},"mid":{"$ref":"#/components/schemas/S4Mid"},"status":{"$ref":"#/components/schemas/RiskListStatus"}}}},"components/schemas/RiskList":{"id":"components/schemas/RiskList","kind":"json-schema","title":"RiskList","data":{"type":"array","items":{"$ref":"#/components/schemas/RiskListObject"}}},"components/schemas/ApiOptionsFromTMRequired":{"id":"components/schemas/ApiOptionsFromTMRequired","kind":"json-schema","title":"ApiOptionsFromTMRequired","data":{"type":"array","items":{"type":"string"},"example":["FROMTM"],"writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options modify the request being made. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/appendices/api-options"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROMTM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request."},"children":[]}]}]}]}},"components/schemas/CardNumberUnmaskedResponse":{"id":"components/schemas/CardNumberUnmaskedResponse","kind":"json-schema","title":"CardNumberUnmaskedResponse","data":{"type":"string","maxLength":32,"example":"4321000000001119","description":"The unmasked and unencrypted payment card number.\n"}},"components/schemas/CardExpirationDateString":{"id":"components/schemas/CardExpirationDateString","kind":"json-schema","title":"CardExpirationDateString","data":{"type":"string","minLength":4,"maxLength":4,"format":"MMYY","example":1230,"description":"Card expiration date in MMYY format.\n"}},"components/schemas/Invoices":{"id":"components/schemas/Invoices","kind":"json-schema","title":"Invoices","data":{"type":"array","items":{"type":"string"},"maxItems":100,"example":["0510093358","0510093119","0510093360","0510093361"],"writeOnly":true,"description":"Array of invoices\n"}},"components/schemas/TransactionSafStatus":{"id":"components/schemas/TransactionSafStatus","kind":"json-schema","title":"TransactionSafStatus","data":{"type":"string","readOnly":true,"enum":["PENDING","SENT_ONLINE","NOT_FOUND"],"example":"SENT_ONLINE","description":"The transaction SAF status.\n"}},"components/schemas/CardNumberLast4":{"id":"components/schemas/CardNumberLast4","kind":"json-schema","title":"CardNumberLast4","data":{"type":"string","maxLength":4,"example":"1119","description":"The last 4 digits of the card number\n"}},"components/schemas/ACHVerificationTypeVerifyWebhook":{"id":"components/schemas/ACHVerificationTypeVerifyWebhook","kind":"json-schema","title":"ACHVerificationTypeVerifyWebhook","data":{"type":"string","example":"P","enum":["P","M"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of verification used to validate the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prenotification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit"},"children":[]}]}]}]}]}]}]}},"components/schemas/webhook_ach_verification_status_update":{"id":"components/schemas/webhook_ach_verification_status_update","kind":"json-schema","title":"ACH Verification Status Update","data":{"title":"ACH Verification Status Update","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.verify.verification_status_update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the ACH verification request is updated."},"children":[]}]}]}]}}},"ach":{"type":"object","properties":{"verificationType":{"$ref":"#/components/schemas/ACHVerificationTypeVerifyWebhook"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is declined."},"children":[]}]}]}]}]}]}]},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.verify.verification_status_update"},"ach":{"verificationType":"P"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"A"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}}},"components/schemas/webhook_ach_sale_status_update":{"id":"components/schemas/webhook_ach_sale_status_update","kind":"json-schema","title":"ACH Sale Status Update","data":{"title":"ACH Sale Status Update","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.sale.status_update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the ACH sale request is updated."},"children":[]}]}]}]}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is declined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is funded."},"children":[]}]}]}]}]}]}]},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.sale.status_update"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"A","invoice":"192029"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}}},"components/schemas/webhook_ach_refund_status_update":{"id":"components/schemas/webhook_ach_refund_status_update","kind":"json-schema","title":"ACH Refund Status Update","data":{"title":"ACH Refund Status Update","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.refund.status_update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the ACH refund request is updated."},"children":[]}]}]}]}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is declined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is refunded."},"children":[]}]}]}]}]}]}]},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.refund.status_update"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"A","invoice":"192029"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}}},"components/schemas/webhook_ach_dispute_initiated":{"id":"components/schemas/webhook_ach_dispute_initiated","kind":"json-schema","title":"ACH Dispute Initiated","data":{"title":"ACH Dispute Initiated","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.dispute.initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when ACH  dispute is created."},"children":[]}]}]}]}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACHPending"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.dispute.initiated"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","invoice":"192029"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}}},"components/schemas/TransactionResponseCodeACHDispute":{"id":"components/schemas/TransactionResponseCodeACHDispute","kind":"json-schema","title":"TransactionResponseCodeACHDispute","data":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is declined."},"children":[]}]}]}]}]}]}]}},"components/schemas/webhook_ach_dispute_status_update":{"id":"components/schemas/webhook_ach_dispute_status_update","kind":"json-schema","title":"ACH Dispute Status Update","data":{"title":"ACH Dispute Status Update","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.dispute.status_update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the ACH dispute is updated."},"children":[]}]}]}]}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACHDispute"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.dispute.status_update"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"A","invoice":"192029"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}}},"components/schemas/webhook_ach_distribute_status_update":{"id":"components/schemas/webhook_ach_distribute_status_update","kind":"json-schema","title":"ACH Distribute Status Update","data":{"title":"ACH Distribute Status Update","type":"object","properties":{"event":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach.distribute.status_update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the ACH distribute request is updated."},"children":[]}]}]}]}}},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D","F"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is declined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH request is funded."},"children":[]}]}]}]}]}]}]},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}},"example":{"event":{"type":"ach.distribute.status_update"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"A","invoice":"192029"},"notificationId":"921e41d4-e920-4b24-8bbf-0787379ad4df","server":{"name":"TM01CE"}}}},"schema_219":{"kind":"json-schema","data":{"type":"string","maxLength":11,"example":"2.1"},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"string","maxLength":25,"example":"ForwardPOS"},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"string","maxLength":26,"example":"PAWS"},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"required":["dateTime","credential"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"credential":{"$ref":"#/components/schemas/Credential"}}},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"credential":{"type":"object","properties":{"accessToken":{"$ref":"#/components/schemas/CredentialAccessToken"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"},"lighthouse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LighthouseDataResponse"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"string","format":"uuid","maxLength":52,"example":"EA79FB05-3AA7-4500-AF9A-73F986FF2C1D"},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_authorization_comengdevice"},{"$ref":"#/components/schemas/transactions_authorization_comengcloud"},{"$ref":"#/components/schemas/transactions_authorization_utgdevice"},{"$ref":"#/components/schemas/transactions_authorization_token_gtv"},{"$ref":"#/components/schemas/transactions_authorization_token_legacy"},{"$ref":"#/components/schemas/transactions_authorization_p2pe_idtech"},{"$ref":"#/components/schemas/transactions_authorization_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/transactions_authorization_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/transactions_authorization_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/transactions_authorization_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/transactions_authorization_unencryptedcard"},{"$ref":"#/components/schemas/transactions_authorization_3dsecurei4Go"},{"$ref":"#/components/schemas/transactions_authorization_3dsecurecardnumber"},{"$ref":"#/components/schemas/transactions_authorization_3dsecuretoken_gtv"},{"$ref":"#/components/schemas/transactions_authorization_3dsecuretoken_legacy"},{"$ref":"#/components/schemas/transactions_authorization_applepay"},{"$ref":"#/components/schemas/transactions_authorization_googlepay"},{"$ref":"#/components/schemas/transactions_authorization_incremental"}]},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"levelResult":{"$ref":"#/components/schemas/CardLevelResult"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeResponse"},"token":{"$ref":"#/components/schemas/CardTokenResponse"},"debitType":{"$ref":"#/components/schemas/CardDebitType"},"bin":{"$ref":"#/components/schemas/CardBinResponseRETURNBIN"}}},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"dcc":{"$ref":"#/components/schemas/DCCTransactionResponse"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"emv":{"$ref":"#/components/schemas/EMVResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"},"surcharge":{"$ref":"#/components/schemas/SurchargeTransactionResponse"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"avs":{"$ref":"#/components/schemas/AVS"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"risk":{"$ref":"#/components/schemas/RiskResponseDeny"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"payment":{"type":"object","properties":{"accountReference":{"$ref":"#/components/schemas/PaymentAccountReference"}}}}}}}},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"},"lighthouse":{"$ref":"#/components/schemas/LighthouseResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"error":{"primaryCode":9842,"secondaryCode":0,"shortText":"NOT IN CARDRANGE","longText":"Card type not recognized"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_capture_token_gtv"},{"$ref":"#/components/schemas/transactions_capture_token_legacy"}]},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"levelResult":{"$ref":"#/components/schemas/CardLevelResult"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"token":{"$ref":"#/components/schemas/CardToken"},"bin":{"$ref":"#/components/schemas/CardBinResponseRETURNBIN"}}},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"dcc":{"$ref":"#/components/schemas/DCCTransactionResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"payment":{"type":"object","properties":{"accountReference":{"$ref":"#/components/schemas/PaymentAccountReference"}}}}}}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_sale_comengdevice"},{"$ref":"#/components/schemas/transactions_sale_comengcloud"},{"$ref":"#/components/schemas/transactions_sale_utgdevice"},{"$ref":"#/components/schemas/transactions_sale_token_gtv"},{"$ref":"#/components/schemas/transactions_sale_token_legacy"},{"$ref":"#/components/schemas/transactions_sale_p2pe_idtech"},{"$ref":"#/components/schemas/transactions_sale_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/transactions_sale_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/transactions_sale_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/transactions_sale_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/transactions_sale_unencryptedcard"},{"$ref":"#/components/schemas/transactions_sale_3dsecurei4Go"},{"$ref":"#/components/schemas/transactions_sale_3dsecurecardnumber"},{"$ref":"#/components/schemas/transactions_sale_3dsecuretoken_gtv"},{"$ref":"#/components/schemas/transactions_sale_3dsecuretoken_legacy"},{"$ref":"#/components/schemas/transactions_sale_applepay"},{"$ref":"#/components/schemas/transactions_sale_googlepay"}]},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"levelResult":{"$ref":"#/components/schemas/CardLevelResult"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeResponse"},"token":{"$ref":"#/components/schemas/CardTokenResponse"},"debitType":{"$ref":"#/components/schemas/CardDebitType"},"bin":{"$ref":"#/components/schemas/CardBinResponseRETURNBIN"}}},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"dcc":{"$ref":"#/components/schemas/DCCTransactionResponse"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"emv":{"$ref":"#/components/schemas/EMVResponse"},"lighthouse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LighthouseDataResponse"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"},"surcharge":{"$ref":"#/components/schemas/SurchargeTransactionResponse"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"avs":{"$ref":"#/components/schemas/AVS"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"risk":{"$ref":"#/components/schemas/RiskResponseDeny"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"},"taxFree":{"$ref":"#/components/schemas/TaxFree"},"payment":{"type":"object","properties":{"accountReference":{"$ref":"#/components/schemas/PaymentAccountReference"}}}}}}}},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_refund_comengdevice"},{"$ref":"#/components/schemas/transactions_refund_comengcloud"},{"$ref":"#/components/schemas/transactions_refund_utgdevice"},{"$ref":"#/components/schemas/transactions_refund_token_gtv"},{"$ref":"#/components/schemas/transactions_refund_token_legacy"},{"$ref":"#/components/schemas/transactions_refund_p2pe_idtech"},{"$ref":"#/components/schemas/transactions_refund_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/transactions_refund_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/transactions_refund_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/transactions_refund_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/transactions_refund_unencryptedcard"}]},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"type":"number","maxLength":14,"example":51.32,"description":"The amount of the refund."}}},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryMode"},"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"levelResult":{"$ref":"#/components/schemas/CardLevelResult"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"present":{"$ref":"#/components/schemas/CardPresent"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"balance":{"$ref":"#/components/schemas/CardBalance"},"token":{"$ref":"#/components/schemas/CardToken"},"debitType":{"$ref":"#/components/schemas/CardDebitType"},"bin":{"$ref":"#/components/schemas/CardBinResponseRETURNBIN"}}},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"type":"object","$ref":"#/components/schemas/ClerkResponse"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"emv":{"$ref":"#/components/schemas/EMVResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"signature":{"$ref":"#/components/schemas/Signature"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"payment":{"type":"object","properties":{"accountReference":{"$ref":"#/components/schemas/PaymentAccountReference"}}}}}}}},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionInvoice"},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"string","maxLength":255},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"integer","example":40,"maxLength":48},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"string","maxLength":16,"example":"8048471746471119"},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"$ref":"#/components/schemas/CardResponse"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"}}},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"string","minLength":2,"maxLength":2,"enum":["01","02","03","04","05","06","07","08","09"]},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"card":{"$ref":"#/components/schemas/CardResponseVoid"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"deferredAuth":{"$ref":"#/components/schemas/TransactionDeferredAuth"}}},"payment":{"type":"object","properties":{"accountReference":{"$ref":"#/components/schemas/PaymentAccountReference"}}}}}}}},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_manualauthorization_comengdevice"},{"$ref":"#/components/schemas/transactions_manualauthorization_comengcloud"},{"$ref":"#/components/schemas/transactions_manualauthorization_utgdevice"},{"$ref":"#/components/schemas/transactions_manualauthorization_token_gtv"},{"$ref":"#/components/schemas/transactions_manualauthorization_token_legacy"},{"$ref":"#/components/schemas/transactions_manualauthorization_p2pe_idtech"},{"$ref":"#/components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/transactions_manualauthorization_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/transactions_manualauthorization_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/transactions_manualauthorization_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/transactions_manualauthorization_unencryptedcard"}]},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"$ref":"#/components/schemas/CardResponse"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"emv":{"$ref":"#/components/schemas/EMV"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"avs":{"$ref":"#/components/schemas/AVS"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transactions_manualsale_comengdevice"},{"$ref":"#/components/schemas/transactions_manualsale_comengcloud"},{"$ref":"#/components/schemas/transactions_manualsale_utgdevice"},{"$ref":"#/components/schemas/transactions_manualsale_token_gtv"},{"$ref":"#/components/schemas/transactions_manualsale_token_legacy"},{"$ref":"#/components/schemas/transactions_manualsale_p2pe_idtech"},{"$ref":"#/components/schemas/transactions_manualsale_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/transactions_manualsale_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/transactions_manualsale_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/transactions_manualsale_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/transactions_manualsale_unencryptedcard"}]},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"required":["dateTime","transaction","signature"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"device":{"type":"object","properties":{"manufacturer":{"$ref":"#/components/schemas/DeviceManufacturer"},"model":{"$ref":"#/components/schemas/DeviceModel"},"serialNumber":{"$ref":"#/components/schemas/DeviceSerialNumber"},"capability":{"$ref":"#/components/schemas/DeviceCapability"}}},"signature":{"type":"object","required":["format","data"],"properties":{"data":{"$ref":"#/components/schemas/SignatureData"},"format":{"$ref":"#/components/schemas/SignatureFormat"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}}},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"}}}}}}}},"id":"schema_247"},"schema_250":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/tokens_add_comengdevice"},{"$ref":"#/components/schemas/tokens_add_comengcloud"},{"$ref":"#/components/schemas/tokens_add_utgdevice"},{"$ref":"#/components/schemas/tokens_add_p2pe_idtech"},{"$ref":"#/components/schemas/tokens_add_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/tokens_add_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/tokens_add_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/tokens_add_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/tokens_add_p2pe_aes_mce"},{"$ref":"#/components/schemas/tokens_add_unencryptedcard"},{"$ref":"#/components/schemas/tokens_add_ach"}]},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/tokens_add_response_card"},{"$ref":"#/components/schemas/tokens_add_response_ach"}]},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"card":{"type":"object","required":["token"],"properties":{"token":{"type":"object","required":["value"],"properties":{"serialNumber":{"$ref":"#/components/schemas/CardTokenSerialNumber"},"value":{"$ref":"#/components/schemas/CardTokenValue"}}}}},"customer":{"$ref":"#/components/schemas/Customer"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}}}},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"token":{"$ref":"#/components/schemas/CardToken"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"type":"object","required":["value"],"properties":{"value":{"$ref":"#/components/schemas/CardTokenValue"}}}}}}},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","properties":{"token":{"$ref":"#/components/schemas/CardToken"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"4321000000001119"},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"string","maxLength":2048},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"string","minLength":2,"maxLength":2,"enum":["01","02","03","04","05"]},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"string","maxLength":20},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"string","maxLength":10,"example":"266"},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"string","maxLength":128},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"required":["dateTime","card"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/CardToken"}}}}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"$ref":"#/components/schemas/CardResponseFourWords"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_264"},"schema_270":{"kind":"json-schema","data":{"oneOf":[{"title":"Default","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"type":"object","readOnly":true,"properties":{"addressLine1":{"$ref":"#/components/schemas/MerchantAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/MerchantAddressLine2"},"city":{"$ref":"#/components/schemas/MerchantCity"},"dayEndingTime":{"$ref":"#/components/schemas/MerchantDayEndingTime"},"defaultCurrency":{"$ref":"#/components/schemas/MerchantDefaultCurrency"},"supportedCurrencies":{"$ref":"#/components/schemas/MerchantSupportedCurrencies"},"industry":{"$ref":"#/components/schemas/MerchantIndustry"},"mid":{"$ref":"#/components/schemas/MerchantMID"},"name":{"$ref":"#/components/schemas/MerchantName"},"region":{"$ref":"#/components/schemas/MerchantRegion"},"phone":{"$ref":"#/components/schemas/MerchantPhone"},"postalCode":{"$ref":"#/components/schemas/MerchantPostalCode"},"serialNumber":{"$ref":"#/components/schemas/MerchantSerialNumber"},"cardTypes":{"$ref":"#/components/schemas/MerchantCardTypesArray"},"dcc":{"$ref":"#/components/schemas/MerchantDCCObject"},"gtv":{"$ref":"#/components/schemas/MerchantGTVObject"},"surcharge":{"$ref":"#/components/schemas/MerchantSurchargeObject"},"autoClose":{"$ref":"#/components/schemas/MerchantAutoCloseObject"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},{"title":"RETURNPROCESSORS","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"type":"object","readOnly":true,"properties":{"addressLine1":{"$ref":"#/components/schemas/MerchantAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/MerchantAddressLine2"},"city":{"$ref":"#/components/schemas/MerchantCity"},"dayEndingTime":{"$ref":"#/components/schemas/MerchantDayEndingTime"},"defaultCurrency":{"$ref":"#/components/schemas/MerchantDefaultCurrency"},"supportedCurrencies":{"$ref":"#/components/schemas/MerchantSupportedCurrencies"},"industry":{"$ref":"#/components/schemas/MerchantIndustry"},"mid":{"$ref":"#/components/schemas/MerchantMID"},"name":{"$ref":"#/components/schemas/MerchantName"},"region":{"$ref":"#/components/schemas/MerchantRegion"},"phone":{"$ref":"#/components/schemas/MerchantPhone"},"postalCode":{"$ref":"#/components/schemas/MerchantPostalCode"},"serialNumber":{"$ref":"#/components/schemas/MerchantSerialNumber"},"cardTypes":{"$ref":"#/components/schemas/MerchantCardTypesReturnProcessorsArray"},"dcc":{"$ref":"#/components/schemas/MerchantDCCObject"},"gtv":{"$ref":"#/components/schemas/MerchantGTVObject"},"surcharge":{"$ref":"#/components/schemas/MerchantSurchargeObject"},"autoClose":{"$ref":"#/components/schemas/MerchantAutoCloseObject"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}}]},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_activate_comengdevice"},{"$ref":"#/components/schemas/giftcards_activate_comengcloud"},{"$ref":"#/components/schemas/giftcards_activate_utgdevice"},{"$ref":"#/components/schemas/giftcards_activate_token_gtv"},{"$ref":"#/components/schemas/giftcards_activate_token_legacy"},{"$ref":"#/components/schemas/giftcards_activate_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_activate_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_activate_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_activate_unencryptedcard"}]},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGCResponse"},"card":{"$ref":"#/components/schemas/CardResponseGC"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}}}}}}},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"required":["dateTime","amount","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGC"},"programId":{"$ref":"#/components/schemas/ProgramId"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}}}},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGCResponse"},"card":{"type":"object","properties":{"number":{"type":"string","maxLength":32,"description":"The gift card number that was created during the gift card allocate request.\n"},"type":{"$ref":"#/components/schemas/CardTypeGCResp"},"balance":{"$ref":"#/components/schemas/CardBalance"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"programId":{"$ref":"#/components/schemas/ProgramId"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}}}}}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_deactivate_comengdevice"},{"$ref":"#/components/schemas/giftcards_deactivate_comengcloud"},{"$ref":"#/components/schemas/giftcards_deactivate_utgdevice"},{"$ref":"#/components/schemas/giftcards_deactivate_token_gtv"},{"$ref":"#/components/schemas/giftcards_deactivate_token_legacy"},{"$ref":"#/components/schemas/giftcards_deactivate_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_deactivate_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_deactivate_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_deactivate_unencryptedcard"}]},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"$ref":"#/components/schemas/CardResponseDeact"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_cashout_comengdevice"},{"$ref":"#/components/schemas/giftcards_cashout_comengcloud"},{"$ref":"#/components/schemas/giftcards_cashout_utgdevice"},{"$ref":"#/components/schemas/giftcards_cashout_token_gtv"},{"$ref":"#/components/schemas/giftcards_cashout_token_legacy"},{"$ref":"#/components/schemas/giftcards_cashout_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_cashout_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_cashout_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_cashout_unencryptedcard"}]},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGCResponse"},"card":{"$ref":"#/components/schemas/CardResponseCashout"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_reactivate_comengdevice"},{"$ref":"#/components/schemas/giftcards_reactivate_comengcloud"},{"$ref":"#/components/schemas/giftcards_reactivate_utgdevice"},{"$ref":"#/components/schemas/giftcards_reactivate_token_gtv"},{"$ref":"#/components/schemas/giftcards_reactivate_token_legacy"},{"$ref":"#/components/schemas/giftcards_reactivate_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_reactivate_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_reactivate_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_reactivate_unencryptedcard"}]},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"$ref":"#/components/schemas/CardResponseGC"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_reload_comengdevice"},{"$ref":"#/components/schemas/giftcards_reload_comengcloud"},{"$ref":"#/components/schemas/giftcards_reload_utgdevice"},{"$ref":"#/components/schemas/giftcards_reload_token_gtv"},{"$ref":"#/components/schemas/giftcards_reload_token_legacy"},{"$ref":"#/components/schemas/giftcards_reload_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_reload_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_reload_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_reload_unencryptedcard"}]},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGCResponse"},"card":{"$ref":"#/components/schemas/CardResponseGC"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_balance_comengdevice"},{"$ref":"#/components/schemas/giftcards_balance_comengcloud"},{"$ref":"#/components/schemas/giftcards_balance_utgdevice"},{"$ref":"#/components/schemas/giftcards_balance_token_gtv"},{"$ref":"#/components/schemas/giftcards_balance_token_legacy"},{"$ref":"#/components/schemas/giftcards_balance_p2pe_idtech"},{"$ref":"#/components/schemas/giftcards_balance_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/giftcards_balance_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/giftcards_balance_unencryptedcard"}]},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"$ref":"#/components/schemas/CardResponseDeact"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"history":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNHIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"transactionType":{"type":"string","enum":["Sale","Activate","Allocate","Deactivate","Cashback","Reactivate","Reload","Balance","Cancel"],"description":"The gift card transaction type\n"}}}}}}}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/giftcards_cancel_token_gtv"},{"$ref":"#/components/schemas/giftcards_cancel_token_legacy"}]},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountGCResponse"},"card":{"$ref":"#/components/schemas/CardResponseGC"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/cards_verify_comengdevice"},{"$ref":"#/components/schemas/cards_verify_comengcloud"},{"$ref":"#/components/schemas/cards_verify_utgdevice"},{"$ref":"#/components/schemas/cards_verify_token_gtv"},{"$ref":"#/components/schemas/cards_verify_token_legacy"},{"$ref":"#/components/schemas/cards_verify_p2pe_idtech"},{"$ref":"#/components/schemas/cards_verify_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/cards_verify_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/cards_verify_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/cards_verify_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/cards_verify_unencryptedcard"}]},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"customer":{"$ref":"#/components/schemas/Customer"},"card":{"type":"object","properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCode"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeCardsVerify"},"avs":{"$ref":"#/components/schemas/AVS"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"}}},"server":{"$ref":"#/components/schemas/Server"},"accountNameInquiry":{"$ref":"#/components/schemas/AccountNameInquiryResponse"}}}}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/cards_identify_utgdevice"},{"$ref":"#/components/schemas/cards_identify_token_gtv"},{"$ref":"#/components/schemas/cards_identify_token_legacy"},{"$ref":"#/components/schemas/cards_identify_p2pe_idtech"},{"$ref":"#/components/schemas/cards_identify_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/cards_identify_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/cards_identify_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/cards_identify_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/cards_identify_unencryptedcard"}]},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"$ref":"#/components/schemas/CardResponseIdentify"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_promptsignature_comengdevice"},{"$ref":"#/components/schemas/devices_promptsignature_comengcloud"},{"$ref":"#/components/schemas/devices_promptsignature_utgdevice"}]},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"}}}}}},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"},"promptConfirmation":{"$ref":"#/components/schemas/DevicePromptConfirmation"}}}}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptConfirmation":{"$ref":"#/components/schemas/DevicePromptConfirmation"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_termsandconditions_comengdevice"},{"$ref":"#/components/schemas/devices_termsandconditions_comengcloud"},{"$ref":"#/components/schemas/devices_termsandconditions_utgdevice"}]},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptTermsAndConditions":{"$ref":"#/components/schemas/DevicePromptTermsAndConditions"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"apiOptions":{"$ref":"#/components/schemas/ApiOptions"},"device":{"type":"object","required":["terminalId","lineItems"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"},"lineItems":{"$ref":"#/components/schemas/DeviceLineItemsArray"}}}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"1742"},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_info_comeng"},{"$ref":"#/components/schemas/devices_info_utgingenico"},{"$ref":"#/components/schemas/devices_info_utgverifone"}]},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"required":["dateTime","device"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","required":["terminalId"],"properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalIdRequired"}}}}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_reset_comengdevice"},{"$ref":"#/components/schemas/devices_reset_utgdevice"}]},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_promptcardread_comengdevice"},{"$ref":"#/components/schemas/devices_promptcardread_comengcloud"},{"$ref":"#/components/schemas/devices_promptcardread_utgdevice"}]},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"oneOf":[{"title":"Unencrypted Gift, Loyalty, or Employee Badge Data","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryModeResponseTrackOnly"},"expirationDate":{"type":"integer","minLength":3,"maxLength":4,"format":"MMYY","description":"Card expiration date in MMYY format. This will only be returned for non-card brand cards such as gift cards and employee badge cards.\n\nThis field will not be returned if the swipe data received is in a non-standard format.\n"},"number":{"type":"string","maxLength":32,"description":"The unencrypted card number. This will only be returned for non-card brand cards such as gift cards and employee badge cards.\n\nThis field will not be returned if the swipe data received is in a non-standard format.\n"},"trackData":{"type":"string","description":"The raw track data read from the card swipe. This can contain track 1 data, track 2 data, or both. This will only be returned for non-card brand cards such as gift cards and employee badge cards.\n"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},{"title":"Encrypted Card Brand Data","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"card":{"type":"object","properties":{"entryMode":{"$ref":"#/components/schemas/CardEntryModeResponseTrackOnly"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"}}},"p2pe":{"$ref":"#/components/schemas/P2PE"},"server":{"$ref":"#/components/schemas/Server"}}}}}}]},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_promptinput_comengdevice"},{"$ref":"#/components/schemas/devices_promptinput_comengcloud"},{"$ref":"#/components/schemas/devices_promptinput_utgdevice"}]},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"type":"object","properties":{"terminalId":{"$ref":"#/components/schemas/DeviceTerminalId"},"promptInput":{"$ref":"#/components/schemas/DevicePromptInput"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_processform_comengdevice"},{"$ref":"#/components/schemas/devices_processform_comengcloud"},{"$ref":"#/components/schemas/devices_processform_utgdevice"}]},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_processform_response_utg"},{"$ref":"#/components/schemas/devices_processform_response_comeng_message"},{"$ref":"#/components/schemas/devices_processform_response_comeng_multiButtonScrollingText"}]},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_print_comengdevice_structured"},{"$ref":"#/components/schemas/devices_print_comengcloud_structured"},{"$ref":"#/components/schemas/devices_print_comengdevice_legacy"},{"$ref":"#/components/schemas/devices_print_comengcloud_legacy"},{"$ref":"#/components/schemas/devices_print_utgdevice"}]},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"device":{"$ref":"#/components/schemas/DeviceOnlyTIDResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_getstatus_comengdevice"},{"$ref":"#/components/schemas/devices_getstatus_comengcloud"}]},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"cloudRegistered":{"$ref":"#/components/schemas/CloudRegistered"},"cloudConnected":{"$ref":"#/components/schemas/CloudConnected"},"offlineMode":{"$ref":"#/components/schemas/OfflineMode"}}}}}},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/devices_prompttip_comengdevice"},{"$ref":"#/components/schemas/devices_prompttip_comengcloud"}]},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","properties":{"tip":{"$ref":"#/components/schemas/AmountTipResponse"},"total":{"$ref":"#/components/schemas/AmountTotal"}}},"tip":{"type":"object","properties":{"selectedOption":{"$ref":"#/components/schemas/TipSelectedOption"}}},"server":{"$ref":"#/components/schemas/ServerComEng"}}}}}},"id":"schema_314"},"schema_323":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}}}},"example":{"result":[{"error":{"longText":"Timeout waiting for response across the internet","primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT"}}]}},"id":"schema_323"},"schema_327":{"kind":"json-schema","data":{"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":40102,"severity":"Info","shortText":"Invalid Param","longText":"Client request missing field"},"server":{"name":"TM01CE"}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":64002,"severity":"Error","shortText":"Timed Out","longText":"Connection Timeout"},"server":{"name":"TM01CE"}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"string","format":"ISO 8601","minLength":10},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"string","enum":["Y","N"]},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"batch":{"$ref":"#/components/schemas/BatchResponseNoProcessors"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"}}}}}}}},"id":"schema_331"},"schema_335":{"kind":"json-schema","data":{"required":["dateTime","transaction","batch"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","required":["businessDate"],"properties":{"businessDate":{"$ref":"#/components/schemas/SubmitBatchBusinessDate"}}},"batch":{"$ref":"#/components/schemas/Batch"}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"batch":{"$ref":"#/components/schemas/BatchResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"businessDate":{"$ref":"#/components/schemas/TransactionBusinessDate"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"required":["dateTime","amount","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total","tax"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"tip":{"$ref":"#/components/schemas/AmountTip"},"cashback":{"$ref":"#/components/schemas/AmountCashback"}}},"transaction":{"type":"object","required":["invoice","saleFlag"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlagQR"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"qrCode":{"$ref":"#/components/schemas/QRCodeResponse"},"server":{"$ref":"#/components/schemas/Server"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"tip":{"$ref":"#/components/schemas/AmountTip"},"cashback":{"$ref":"#/components/schemas/AmountCashback"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlagQR"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}}}}}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"required":["dateTime","qrCode"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"qrCode":{"$ref":"#/components/schemas/QRCodeRequest"}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"tax":{"$ref":"#/components/schemas/AmountTax"},"tip":{"$ref":"#/components/schemas/AmountTip"},"cashback":{"$ref":"#/components/schemas/AmountCashback"}}},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlagQR"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"merchant":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/MerchantAddressLine1"},"addressLine2":{"$ref":"#/components/schemas/MerchantAddressLine2"},"city":{"$ref":"#/components/schemas/MerchantCity"},"dayEndingTime":{"$ref":"#/components/schemas/MerchantDayEndingTime"},"industry":{"$ref":"#/components/schemas/MerchantIndustry"},"name":{"$ref":"#/components/schemas/MerchantName"},"region":{"$ref":"#/components/schemas/MerchantRegion"},"phone":{"$ref":"#/components/schemas/MerchantPhone"},"postalCode":{"$ref":"#/components/schemas/MerchantPostalCode"},"serialNumber":{"$ref":"#/components/schemas/MerchantSerialNumber"},"mid":{"$ref":"#/components/schemas/MerchantMID"},"cardTypes":{"$ref":"#/components/schemas/MerchantCardTypesArray"}}},"qrPayConfig":{"$ref":"#/components/schemas/QRPayConfig"},"server":{"$ref":"#/components/schemas/Server"},"credential":{"type":"object","properties":{"accessToken":{"$ref":"#/components/schemas/CredentialAccessToken"},"apiSerialNumber":{"$ref":"#/components/schemas/CredentialApiSerialNumber"},"apiPassword":{"$ref":"#/components/schemas/CredentialAuthToken"}}}}}}}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"card":{"$ref":"#/components/schemas/CardResponse"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"}}},"clerk":{"$ref":"#/components/schemas/ClerkResponse"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"signature":{"$ref":"#/components/schemas/Signature"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeQRPaymentStatus"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"amex":{"$ref":"#/components/schemas/TransactionAmex"},"avs":{"$ref":"#/components/schemas/AVS"}}},"universalToken":{"$ref":"#/components/schemas/UniversalToken"}}}}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","properties":{"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeQRCancel"}}},"merchant":{"type":"object","properties":{"serialNumber":{"$ref":"#/components/schemas/MerchantSerialNumber"},"mid":{"$ref":"#/components/schemas/MerchantMID"},"name":{"$ref":"#/components/schemas/MerchantName"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"required":["dateTime"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"}}},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceMode"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/risk_assess_unencryptedcard"},{"$ref":"#/components/schemas/risk_assess_token_gtv"}]},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","risk","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"card":{"type":"object","properties":{"token":{"$ref":"#/components/schemas/CardTokenResponse"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"risk":{"type":"object","required":["tranId","assessment"],"properties":{"tranId":{"$ref":"#/components/schemas/RiskTranId"},"assessment":{"$ref":"#/components/schemas/RiskAssessment"}}},"transaction":{"type":"object","required":["s4RiskId","invoice"],"properties":{"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskId"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"orderId":{"$ref":"#/components/schemas/TransactionOrderId"}}}}}}}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"},"transaction":{"type":"object","properties":{"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskId"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"type":"object","properties":{"reasonCode":{"$ref":"#/components/schemas/HostResponseReasonCodeRisk"},"reasonDescription":{"$ref":"#/components/schemas/HostResponseReasonDescriptionRisk"}}},"orderId":{"$ref":"#/components/schemas/TransactionOrderId"}}}}}}},"example":{"result":[{"error":{"longText":"format error","primaryCode":9151,"secondaryCode":0,"shortText":"format error"},"transaction":{"s4RiskId":"EC52377F-5A8E-4534-BE7A-CF779A35BE45","invoice":"0207123502","orderId":"orderId","hostResponse":{"reasonCode":"232","reasonDescription":"The credit card information is missing"}}}]}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"},"transaction":{"type":"object","properties":{"s4RiskId":{"$ref":"#/components/schemas/TransactionS4RiskId"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"orderId":{"$ref":"#/components/schemas/TransactionOrderId"}}}}}}},"example":{"result":[{"error":{"longText":"Timeout waiting for response across the internet","primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT"},"transaction":{"s4RiskId":"EC52377F-5A8E-4534-BE7A-CF779A35BE45","invoice":"0207123502","orderId":"orderId"}}]}},"id":"schema_348"},"schema_362":{"kind":"json-schema","data":{"required":["amount","currencyCode","customer","dateTime","sourceIp","transaction"],"properties":{"amount":{"type":"object","required":["tax","total"],"properties":{"tax":{"$ref":"#/components/schemas/AmountTax"},"total":{"$ref":"#/components/schemas/AmountTotal"}}},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"customer":{"type":"object","required":["addressLine1","city","country","emailAddress","firstName","lastName","ipAddress","phoneNumber","phoneCountry","region","externalId","enrollDate"],"properties":{"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"phoneCountry":{"$ref":"#/components/schemas/CustomerPhoneCountry"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"externalId":{"$ref":"#/components/schemas/CustomerExternalId"},"enrollDate":{"$ref":"#/components/schemas/CustomerEnrollDate"}}},"dateTime":{"$ref":"#/components/schemas/DateTime"},"sourceIp":{"$ref":"#/components/schemas/SourceIP"},"transaction":{"type":"object","required":["invoice","vendorReference"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"ota":{"$ref":"#/components/schemas/OTARequestPayPal"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","required":["amount","dateTime","payPal","server","transaction"],"properties":{"amount":{"type":"object","required":["tax","total"],"properties":{"tax":{"$ref":"#/components/schemas/AmountTax"},"total":{"$ref":"#/components/schemas/AmountTotal"}}},"dateTime":{"$ref":"#/components/schemas/DateTime"},"payPal":{"type":"object","required":["clientToken"],"properties":{"clientMetaDataId":{"$ref":"#/components/schemas/PayPalClientMetaDataId"},"clientToken":{"$ref":"#/components/schemas/PayPalClientToken"}}},"server":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/ServerName"}}},"transaction":{"type":"object","required":["authSource","invoice"],"properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}}}}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"required":["dateTime","amount","transaction","sourceIp","customer","currencyCode","payPal"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"payPal":{"type":"object","required":["payerId","paymentMethodNonce","deviceData"],"properties":{"payerId":{"$ref":"#/components/schemas/PayPalPayerId"},"paymentMethodNonce":{"$ref":"#/components/schemas/PayPalPaymentMethodNonce"},"paymentMethodIdUsage":{"$ref":"#/components/schemas/PayPalPaymentMethodIdUsage"},"deviceData":{"$ref":"#/components/schemas/PayPalDeviceData"}}},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"airline":{"$ref":"#/components/schemas/AirlineRequestPayPal"},"notes":{"$ref":"#/components/schemas/TransactionNotes"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"sourceIp":{"$ref":"#/components/schemas/SourceIP"},"customer":{"type":"object","required":["browserType"],"properties":{"browserType":{"$ref":"#/components/schemas/CustomerBrowserType"}}}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","required":["payPal","dateTime","amount","transaction","server"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","required":["authSource","invoice","responseCode"],"properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"server":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/ServerName"}}},"payPal":{"type":"object","required":["transactionId","legacyId","authorizationId","captureId","orderId","status"],"properties":{"transactionId":{"$ref":"#/components/schemas/PayPalTransactionId"},"legacyId":{"$ref":"#/components/schemas/PayPalLegacyId"},"orderId":{"$ref":"#/components/schemas/PayPalOrderId"},"status":{"$ref":"#/components/schemas/PayPalStatus"},"authorizationId":{"$ref":"#/components/schemas/PayPalAuthorizationId"},"captureId":{"$ref":"#/components/schemas/PayPalCaptureId"},"paymentMethodId":{"$ref":"#/components/schemas/PayPalPaymentMethodId"}}}}}}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"required":["dateTime","amount","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"transaction":{"type":"object","required":["invoice","originalInvoice","originalDate"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"originalDate":{"$ref":"#/components/schemas/TransactionOriginalDate"}}}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","transaction","server","payPal"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","required":["total"],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"payPal":{"type":"object","required":["transactionId","legacyId","orderId","status"],"properties":{"transactionId":{"$ref":"#/components/schemas/PayPalTransactionId"},"legacyId":{"$ref":"#/components/schemas/PayPalLegacyId"},"orderId":{"$ref":"#/components/schemas/PayPalOrderId"},"status":{"$ref":"#/components/schemas/PayPalStatus"}}},"transaction":{"type":"object","required":["authSource","invoice","responseCode"],"properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode"}}},"server":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/ServerName"}}}}}}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/3dsecure_standalone_cardnumber"},{"$ref":"#/components/schemas/3dsecure_standalone_token_gtv"}]},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"oneOf":[{"title":"Request Complete","properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","currencyCode"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"$ref":"#/components/schemas/CardResponse"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"shipping":{"$ref":"#/components/schemas/CustomerShipping3DSecure"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode3DSStandalone"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"avs":{"$ref":"#/components/schemas/AVS"}}},"threeDSecure":{"type":"object","properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"},"cardholderInfo":{"$ref":"#/components/schemas/ThreeDSecureCardholderInfo"},"cryptogram":{"$ref":"#/components/schemas/ThreeDSecureCryptogram"},"programProtocol":{"$ref":"#/components/schemas/ThreeDSecureProgramProtocol"},"directoryServerTranId":{"$ref":"#/components/schemas/ThreeDSecureDirectoryServerTranId"},"ecommIndicator":{"$ref":"#/components/schemas/ThreeDSecureEcommIndicator"},"securityLevelIndicator":{"$ref":"#/components/schemas/ThreeDSecureSecurityLevelIndicator"}}},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"}}},"example":{"dateTime":"2022-05-04T09:20:04.487-07:00","amount":{"tax":15,"total":160},"currencyCode":"EUR","card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"threeDSecure":{"trxId":"a7bbd49a-ffe6-49b2-8a92-541f0a3b053d","cryptogram":"AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==","programProtocol":"2","directoryServerTranId":"07e54000-2721-4df9-aa51-04fa0e079aa8","ecommIndicator":"5"},"server":{"name":"TM01CE"},"transaction":{"authSource":"A","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"invoice":"730518","responseCode":"A","retrievalReference":"402F9H0230S0"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}]}}}},{"title":"Device Fingerprint","properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","currencyCode","threeDSecure","redirectUrl"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"$ref":"#/components/schemas/CardResponse3DSChallenge"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"shipping":{"$ref":"#/components/schemas/CustomerShipping3DSecure"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode3DSFingerprint"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"}}},"threeDSecure":{"type":"object","required":["trxId"],"properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"}}},"redirectUrl":{"$ref":"#/components/schemas/RedirectURL3DSResponse"},"server":{"$ref":"#/components/schemas/Server"}}},"example":{"dateTime":"2022-05-04T09:20:04.487-07:00","amount":{"tax":15,"total":160},"currencyCode":"EUR","card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","type":"VS","token":{"value":"8048471746471119"}},"customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","invoice":"730518","responseCode":"H","retrievalReference":"402F9H0230S0"},"redirectUrl":"https://issuer.com/fingerprint","threeDSecure":{"trxId":"a7bbd49a-ffe6-49b2-8a92-541f0a3b053d"},"server":{"name":"TM01CE"}}}}},{"title":"3D Secure Challenge","properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","currencyCode","threeDSecure","redirectUrl"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"$ref":"#/components/schemas/CardResponse3DSChallenge"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"},"shipping":{"$ref":"#/components/schemas/CustomerShipping3DSecure"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode3DSChallenge"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"}}},"threeDSecure":{"type":"object","required":["trxId"],"properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"}}},"redirectUrl":{"$ref":"#/components/schemas/RedirectURL3DSResponse"},"server":{"$ref":"#/components/schemas/Server"}}},"example":{"dateTime":"2022-05-04T09:20:04.487-07:00","amount":{"tax":15,"total":160},"currencyCode":"EUR","card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","type":"VS","token":{"value":"8048471746471119"}},"customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","invoice":"730518","responseCode":"G","retrievalReference":"402F9H0230S0"},"redirectUrl":"https://issuer.com/challenge","server":{"name":"TM01CE"}}}}}]},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/Error"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"hostResponse":{"type":"object","description":"Returns the response code from the host\n","properties":{"reasonCode":{"$ref":"#/components/schemas/HostResponseReasonCode3DSecure"},"reasonDescription":{"$ref":"#/components/schemas/HostResponseReasonDescription3DSecure"}}}}}}}}},"example":{"result":[{"dateTime":"2022-05-04T09:20:04.487-07:00","error":{"primaryCode":9842,"secondaryCode":0,"shortText":"NOT IN CARDRANGE","longText":"Card type not recognized"},"server":{"name":"U2API01CE"},"transaction":{"invoice":"730518"}}]}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"required":["dateTime","transaction","threeDSecure"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"}}},"threeDSecure":{"type":"object","required":["trxId","compInd"],"properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"},"compInd":{"$ref":"#/components/schemas/ThreeDSecureCompInd"}}}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"oneOf":[{"title":"Transaction Complete","properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","currencyCode","card","customer","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"$ref":"#/components/schemas/CardResponse"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authorizationCode":{"$ref":"#/components/schemas/TransactionAuthorizationCode"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"hostResponse":{"$ref":"#/components/schemas/HostResponse"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode3DSStandalone"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"avs":{"$ref":"#/components/schemas/AVS"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"}}},"threeDSecure":{"type":"object","properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"},"cardholderInfo":{"$ref":"#/components/schemas/ThreeDSecureCardholderInfo"}}},"receipt":{"$ref":"#/components/schemas/ReceiptArray"},"server":{"$ref":"#/components/schemas/Server"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"cardBrandToken":{"$ref":"#/components/schemas/CardBrandToken"}}},"example":{"dateTime":"2022-05-04T09:20:04.487-07:00","amount":{"tax":15,"total":160},"currencyCode":"EUR","card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"TM01CE"},"transaction":{"authorizationCode":"OK868Z","authSource":"A","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"invoice":"730518","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}]}}}},{"title":"3D Secure Challenge","properties":{"result":{"type":"array","items":{"type":"object","required":["dateTime","amount","currencyCode","card","customer","transaction","threeDSecure","redirectUrl"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/Amount"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"card":{"$ref":"#/components/schemas/CardResponse3DSChallenge"},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstName"},"lastName":{"$ref":"#/components/schemas/CustomerLastName"},"phoneNumber":{"$ref":"#/components/schemas/CustomerPhoneNumber"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"addressLine1":{"$ref":"#/components/schemas/CustomerAddressLine1"},"city":{"$ref":"#/components/schemas/CustomerCity"},"region":{"$ref":"#/components/schemas/CustomerRegion"},"postalCode":{"$ref":"#/components/schemas/CustomerPostalCode"},"country":{"$ref":"#/components/schemas/CustomerCountry"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"},"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCode3DSChallenge"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReference"},"saleFlag":{"$ref":"#/components/schemas/TransactionSaleFlag"},"cardOnFile":{"$ref":"#/components/schemas/CardOnFile"}}},"threeDSecure":{"type":"object","required":["trxId"],"properties":{"trxId":{"$ref":"#/components/schemas/ThreeDSecureTrxId"}}},"redirectUrl":{"$ref":"#/components/schemas/RedirectURL3DSResponse"},"server":{"$ref":"#/components/schemas/Server"}}},"example":{"dateTime":"2022-05-04T09:20:04.487-07:00","amount":{"tax":15,"total":160},"currencyCode":"EUR","card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","type":"VS","token":{"value":"8048471746471119"}},"customer":{"firstName":"John","lastName":"Smith","addressLine1":"65 Easy St","city":"Las Vegas","postalCode":"65144","emailAddress":"firstname.lastname@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","invoice":"730518","responseCode":"G","retrievalReference":"402F9H0230S0","saleFlag":"S"},"threeDSecure":{"trxId":"a7bbd49a-ffe6-49b2-8a92-541f0a3b053d"},"redirectUrl":"https://issuer.com/challenge","server":{"name":"TM01CE"}}}}}]},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/oct_payout_unencryptedcard"},{"$ref":"#/components/schemas/oct_payout_token_gtv"}]},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]}],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"},"fee":{"$ref":"#/components/schemas/AmountFeeOCT"}}},"card":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"type":{"$ref":"#/components/schemas/CardTypeResp"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}},"customer":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/CustomerFirstNameResponse"},"lastName":{"$ref":"#/components/schemas/CustomerLastNameResponse"},"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"ipAddress":{"$ref":"#/components/schemas/CustomerIpAddress"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A","D"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is declined."},"children":[]}]}]}]}]}]}]},"hostResponse":{"$ref":"#/components/schemas/HostResponseOCT"},"retrievalReference":{"$ref":"#/components/schemas/TransactionRetrievalReferenceOCT"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}}}}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2023-01-06T09:18:23.283-07:00","error":{"code":40102,"severity":"Info","shortText":"Invalid Param","longText":"Client request missing field"},"server":{"name":"TM01CE"}}]}},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2023-01-06T09:18:23.283-07:00","error":{"code":64002,"severity":"Error","shortText":"Timed Out","longText":"Connection Timeout"},"server":{"name":"TM01CE"}}]}},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"required":["dateTime","customer","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"customer":{"type":"object","required":["emailAddress","newEmailAddress"],"properties":{"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"newEmailAddress":{"$ref":"#/components/schemas/CustomerNewEmailAddress"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"}}},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"customer":{"type":"object","properties":{"emailAddress":{"$ref":"#/components/schemas/CustomerEmailAddress"},"newEmailAddress":{"$ref":"#/components/schemas/CustomerNewEmailAddress"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"type":"string","minLength":1,"maxLength":1,"readOnly":true,"example":"A","enum":["A"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code indicating the Shift4 host response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is approved."},"children":[]}]}]}]}]}]}]}}},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2022-05-10T06:34:25.049-07:00","customer":{"emailAddress":"firstname.lastname@email.com","newEmailAddress":"firstname.lastname@email.com"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","responseCode":"A"},"server":{"name":"TM01CE"}}]}},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"object","required":["dateTime","ach","sourceIp"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"ach":{"type":"object","required":["accountNumber","routingNumber","accountType","verificationType","accountHolderName"],"properties":{"accountNumber":{"$ref":"#/components/schemas/ACHAccountNumber"},"routingNumber":{"$ref":"#/components/schemas/ACHRoutingNumber"},"accountType":{"$ref":"#/components/schemas/ACHAccountType"},"verificationType":{"$ref":"#/components/schemas/ACHVerificationTypePrenotification"},"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"}}},"sourceIp":{"$ref":"#/components/schemas/SourceIP"},"transaction":{"type":"object","properties":{"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}}},"example":{"dateTime":"2023-02-08T09:18:23.283-07:00","ach":{"accountNumber":"1234567890","routingNumber":"121000248","accountType":"PC","verificationType":"P","accountHolderName":"John Smith"},"sourceIp":"172.110.166.244"}},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"token":{"$ref":"#/components/schemas/TokenACH"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACHPending"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"P"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}]}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":40102,"severity":"Info","shortText":"Invalid Param","longText":"Client request missing field"},"server":{"name":"TM01CE"}}]}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":64002,"severity":"Error","shortText":"Timed Out","longText":"Connection Timeout"},"server":{"name":"TM01CE"}}]}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ach_sale_bankaccount"},{"$ref":"#/components/schemas/ach_sale_token_gtv"}]},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]}],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"ach":{"type":"object","properties":{"balanceVerificationResult":{"$ref":"#/components/schemas/ACHBalanceVerificationResult"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACH"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ach_refund_bankaccount"},{"$ref":"#/components/schemas/ach_refund_token_gtv"}]},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]}],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"token":{"$ref":"#/components/schemas/TokenACH"},"server":{"$ref":"#/components/schemas/Server"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"originalInvoice":{"$ref":"#/components/schemas/TransactionOriginalInvoice"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACH"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"}}}}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"required":["dateTime","transaction"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"transaction":{"type":"object","required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"}}}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing information regarding the amount being requested. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the object is required and specifies the amount being requested."},"children":[]}]}]}],"properties":{"total":{"$ref":"#/components/schemas/AmountTotal"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"type":{"$ref":"#/components/schemas/TransactionTypeACH"},"invoice":{"$ref":"#/components/schemas/TransactionInvoiceAlphanumeric"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACH"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"hostResponse":{"$ref":"#/components/schemas/HostResponseACH"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"required":["dateTime","plaid"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"plaid":{"type":"object","required":["client_user_id"],"properties":{"client_user_id":{"$ref":"#/components/schemas/ACHPlaidLinkTokenClientUserId"},"language":{"$ref":"#/components/schemas/ACHPlaidLinkTokenLanguage"},"redirectUrl":{"$ref":"#/components/schemas/ACHPlaidLinkTokenRedirectUrl"}}}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACHPlaidLinkToken"}}},"plaid":{"type":"object","properties":{"link_token":{"$ref":"#/components/schemas/ACHPlaidLinkToken"},"expiration":{"$ref":"#/components/schemas/ACHPlaidLinkTokenExpiration"},"client_user_id":{"$ref":"#/components/schemas/ACHPlaidLinkTokenClientUserId"}}},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"required":["dateTime","ach","plaid"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"ach":{"type":"object","required":["accountHolderName"],"properties":{"accountHolderName":{"$ref":"#/components/schemas/ACHAccountHolderName"}}},"plaid":{"type":"object","required":["public_token","metadata"],"properties":{"public_token":{"$ref":"#/components/schemas/ACHPlaidPublicToken"},"metadata":{"$ref":"#/components/schemas/ACHPlaidPublicTokenMetadata"}}}}},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"transaction":{"type":"object","properties":{"authSource":{"$ref":"#/components/schemas/TransactionAuthSourceAPM"},"responseCode":{"$ref":"#/components/schemas/TransactionResponseCodeACHPlaidPublicTokenExchange"}}},"notificationId":{"$ref":"#/components/schemas/NotificationId"},"ach":{"type":"object","properties":{"accountLastFour":{"$ref":"#/components/schemas/ACHAccountNumberLastFour"}}},"token":{"$ref":"#/components/schemas/TokenACH"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_392"},"schema_395":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/webhook_ach_verification_status_update"},{"$ref":"#/components/schemas/webhook_ach_sale_status_update"},{"$ref":"#/components/schemas/webhook_ach_refund_status_update"},{"$ref":"#/components/schemas/webhook_ach_dispute_initiated"},{"$ref":"#/components/schemas/webhook_ach_dispute_status_update"},{"$ref":"#/components/schemas/webhook_ach_distribute_status_update"}]},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"required":["dateTime","cards"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"cards":{"type":"array","minItems":1,"maxItems":5000,"description":"Array of card tokens\n","items":{"type":"object","required":["token"],"properties":{"token":{"description":"The token representing the card account number for which you are requesting an update.\n","type":"string","maxLength":16}}},"example":[{"token":"8589410119524356"},{"token":"8048471746471119"},{"token":"8589410119529857"}]}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"updaterRequestId":{"$ref":"#/components/schemas/UpdaterRequestId"}}}}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"error":{"code":40103,"severity":"Info","shortText":"Invalid Param","longText":"Client request missing field"},"server":{"name":"TM01CE"}}]}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"error":{"$ref":"#/components/schemas/ErrorNoPrimarySecondary"},"server":{"$ref":"#/components/schemas/Server"}}}}},"example":{"result":[{"dateTime":"2024-01-17T13:35:25.049-07:00","error":{"code":64002,"severity":"Error","shortText":"Timed Out","longText":"Connection Timeout"},"server":{"name":"TM01CE"}}]}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"required":["dateTime","updaterRequestId"],"properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"updaterRequestId":{"$ref":"#/components/schemas/UpdaterRequestId"}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"cards":{"type":"array","description":"Array of card tokens\n","items":{"type":"object","properties":{"token":{"$ref":"#/components/schemas/UpdaterToken"},"status":{"$ref":"#/components/schemas/UpdaterCardsStatus"},"expirationDate":{"$ref":"#/components/schemas/UpdaterExpirationDate"},"newExpirationDate":{"$ref":"#/components/schemas/UpdaterNewExpirationDate"},"newToken":{"$ref":"#/components/schemas/UpdaterNewToken"}}},"example":[{"token":"8589410119524356","status":"A","expirationDate":"0824","newToken":"8589410119524357"},{"token":"8048471746471119","status":"B","expirationDate":"0925","newExpirationDate":"1026"},{"token":"8589410119529857","status":"E","expirationDate":"1024"}]},"dateTime":{"$ref":"#/components/schemas/DateTime"},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"server":{"$ref":"#/components/schemas/Server"},"updaterRequestId":{"$ref":"#/components/schemas/UpdaterRequestId"},"updaterStatus":{"$ref":"#/components/schemas/UpdaterStatus"}}}}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/dcc_ratelookup_token_gtv"},{"$ref":"#/components/schemas/dcc_ratelookup_token_legacy"},{"$ref":"#/components/schemas/dcc_ratelookup_p2pe_idtech"},{"$ref":"#/components/schemas/dcc_ratelookup_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/dcc_ratelookup_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/dcc_ratelookup_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/dcc_ratelookup_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/dcc_ratelookup_unencryptedcard"}]},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"$ref":"#/components/schemas/AmountTotalOnly"},"card":{"type":"object","properties":{"expirationDate":{"$ref":"#/components/schemas/CardExpirationDateResponse"},"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"securityCode":{"$ref":"#/components/schemas/CardSecurityCodeResponse"},"token":{"$ref":"#/components/schemas/CardTokenResponse"}}},"dcc":{"$ref":"#/components/schemas/DCCResponse"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/rules_verify_token_gtv"},{"$ref":"#/components/schemas/rules_verify_p2pe_idtech"},{"$ref":"#/components/schemas/rules_verify_p2pe_tdesdukpt_emv"},{"$ref":"#/components/schemas/rules_verify_p2pe_tdesdukpt_msr"},{"$ref":"#/components/schemas/rules_verify_p2pe_onguardsde_emv"},{"$ref":"#/components/schemas/rules_verify_p2pe_onguardsde_msr"},{"$ref":"#/components/schemas/rules_verify_unencryptedcard"}]},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/DateTime"},"amount":{"type":"object","properties":{"total":{"type":"number","maxLength":14,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount being charged for a particular transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contained "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SURCHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request and the card is surcharge eligible the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will be incremented by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.surcharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. For example, if the rule verification request had "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surcharge.percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was 1.5%, the rule verification response would include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 101.50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.surcharge = 1.50"},"children":[]}]}]}]},"surcharge":{"type":"number","maxLength":14,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional: Returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contained "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SURCHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request and the card is surcharge eligible."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The surcharge fee amount that can be applied to the transaction. The fee amount is also added into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if the rule verification request had "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surcharge.percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was 1.5%, the rule verification response would include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.total = 101.50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.surcharge = 1.50"},"children":[]}]}]}]}}},"card":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/CardMaskedNumber"},"token":{"$ref":"#/components/schemas/CardTokenResponse"},"type":{"$ref":"#/components/schemas/CardTypeResp"}}},"surcharge":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contained "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SURCHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request."},"children":[]}]}]}],"properties":{"result":{"$ref":"#/components/schemas/SurchargeResult"},"transactionId":{"$ref":"#/components/schemas/RulesTransactionId"},"percentage":{"$ref":"#/components/schemas/SurchargePercentage"}}},"transaction":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/TransactionInvoice"},"vendorReference":{"$ref":"#/components/schemas/TransactionVendorReference"},"authSource":{"$ref":"#/components/schemas/TransactionAuthSource"}}},"merchant":{"$ref":"#/components/schemas/MerchantResponse"},"clerk":{"$ref":"#/components/schemas/ClerkOptional"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"universalToken":{"$ref":"#/components/schemas/UniversalToken"},"server":{"$ref":"#/components/schemas/Server"}}}}}},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","required":["paymentLink"],"properties":{"paymentLink":{"$ref":"#/components/schemas/PaymentLinkRequest"},"customer":{"$ref":"#/components/schemas/PaymentLinksCustomer"},"metadata":{"$ref":"#/components/schemas/PaymentLinksMetadata"}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/PaymentLinksDateTime"},"paymentLink":{"$ref":"#/components/schemas/PaymentLinkResponse"},"customer":{"$ref":"#/components/schemas/PaymentLinksCustomerResponse"},"metadata":{"$ref":"#/components/schemas/PaymentLinksMetadata"}}}}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"properties":{"result":{"type":"array","items":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}}}},"example":{"result":[{"error":{"code":40100,"severity":"Info","shortText":"Invalid Param","longText":"Client request invalid","primaryCode":9800,"secondaryCode":0}}]}},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"number","maximum":100},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"string"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"string","format":"ISO 8601","example":"2024-05-21T09:18:23.283-07:00"},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"properties":{"hasMore":{"$ref":"#/components/schemas/PaymentLinksHasMore"},"result":{"type":"array","items":{"type":"object","properties":{"dateTime":{"$ref":"#/components/schemas/PaymentLinksDateTime"},"paymentLink":{"$ref":"#/components/schemas/PaymentLinkResponse"},"customer":{"$ref":"#/components/schemas/PaymentLinksCustomerResponse"},"metadata":{"$ref":"#/components/schemas/PaymentLinksMetadata"}}}}}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","properties":{"paymentLink":{"$ref":"#/components/schemas/PaymentLinkUpdateRequest"},"metadata":{"$ref":"#/components/schemas/PaymentLinksMetadata"}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"properties":{"event":{"type":"object","properties":{"type":{"type":"string","enum":["payment_link_created","payment_link_updated"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the status of the Payment Links request is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_link_created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Link has been created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_link_updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Link has been updated."},"children":[]}]}]}]}]}]}]}}},"dateTime":{"$ref":"#/components/schemas/PaymentLinksDateTime"},"paymentLink":{"$ref":"#/components/schemas/PaymentLinkResponse"},"customer":{"$ref":"#/components/schemas/PaymentLinksCustomerResponse"},"metadata":{"$ref":"#/components/schemas/PaymentLinksMetadata"}}},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","description":"A single-element list holding the Checkout Session.","items":{"$ref":"#/components/schemas/CheckoutSessionWebV1Response"}}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"maximum":100},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"format":"ISO 8601"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"enum":["active","paid","expired","failed"]},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutSessionWebV1Response"}},"hasMore":{"type":"boolean"}}},"id":"schema_420"}},"exampleStore":{"components/examples/AuthTokenNotValidError":{"id":"components/examples/AuthTokenNotValidError","value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AuthToken","longText":"AuthToken not valid ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"summary":"AuthToken Not Valid"},"components/examples/transactionsauthorization_resp_p2peemv":{"id":"components/examples/transactionsauthorization_resp_p2peemv","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"E","number":"XXXXXXXXXXXX4111","present":"Y","token":{"value":"8058471748284111"},"type":"MC"},"clerk":{"numericId":1576},"emv":{"tlvData":"910A0102030405060708090A"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"AmountAuthorized","printName":"9F02","printValue":"000000000444"},{"key":"ApplicationIdentifier","printName":"AID","printValue":"A0000000041010"},{"key":"ApplicationLabel","printValue":"MasterCard"},{"key":"CVMResults","printName":"9F34","printValue":"1E0300"},{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"CHIP"},{"key":"CardholderVerificationMethod","printName":"CVM","printValue":"SIGN"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX4111"},{"key":"PANSequenceNumber","printName":"5F34","printValue":"01"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TerminalVerificationResults","printName":"TVR","printValue":"0820000000"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"},{"key":"TransactionStatusIndicator","printName":"TSI","printValue":"C800"},{"key":"UnpredictableNumber","printName":"9F37","printValue":"C5BF918D"}],"server":{"name":"U2API01CE"},"transaction":{"authorizationCode":"OK253W","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using EMV with P2PE"},"components/examples/transactionsauthorization_resp_p2pe":{"id":"components/examples/transactionsauthorization_resp_p2pe","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXXXX0009","present":"Y","token":{"value":"8058471748050009"},"type":"MC"},"clerk":{"numericId":1576},"customer":{"firstName":"MC2\\/DUAL","lastName":"TRACK"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX0009"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK183Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using P2PE"},"components/examples/transactionsauthorization_resp_token":{"id":"components/examples/transactionsauthorization_resp_token","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","expirationDate":1222,"number":"XXXXXXXXXXXX1119","present":"N","token":{"value":"11191pn83hbkkety"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK126Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using token"},"components/examples/transactionsauthorization_resp_utgdevice":{"id":"components/examples/transactionsauthorization_resp_utgdevice","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"card":{"entryMode":"1","number":"XXXXXXXXXX4509","present":"Y","token":{"value":"6011013928534509"},"type":"NS"},"clerk":{"numericId":1576},"customer":{"firstName":"DC\\/TRACK1","lastName":"ONLY"},"device":{"terminalId":"350"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"LOCALUTG"},"transaction":{"authorizationCode":"OK892Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using UTG-controlled device"},"components/examples/transactionsauthorization_resp_track":{"id":"components/examples/transactionsauthorization_resp_track","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"2","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"1119p4kgmkb39zx2"},"type":"VS"},"clerk":{"numericId":1576},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK007Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using track information"},"components/examples/transactionsauthorization_resp_raw":{"id":"components/examples/transactionsauthorization_resp_raw","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK408Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using unencrypted card number"},"components/examples/transactionssale_resp_p2peemv":{"id":"components/examples/transactionssale_resp_p2peemv","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"E","number":"XXXXXXXXXXXX4111","present":"Y","token":{"value":"8058471748284111"},"type":"MC"},"clerk":{"numericId":1576},"emv":{"tlvData":"910A0102030405060708090A"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"AmountAuthorized","printName":"9F02","printValue":"000000000444"},{"key":"ApplicationIdentifier","printName":"AID","printValue":"A0000000041010"},{"key":"ApplicationLabel","printValue":"MasterCard"},{"key":"CVMResults","printName":"9F34","printValue":"1E0300"},{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"CHIP"},{"key":"CardholderVerificationMethod","printName":"CVM","printValue":"SIGN"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX4111"},{"key":"PANSequenceNumber","printName":"5F34","printValue":"01"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TerminalVerificationResults","printName":"TVR","printValue":"0820000000"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"},{"key":"TransactionStatusIndicator","printName":"TSI","printValue":"C800"},{"key":"UnpredictableNumber","printName":"9F37","printValue":"C5BF918D"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK710W","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using EMV with P2PE"},"components/examples/transactionssale_resp_p2pe":{"id":"components/examples/transactionssale_resp_p2pe","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"VS/DUAL","lastName":"TRACK"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK850Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using P2PE"},"components/examples/transactionssale_resp_token":{"id":"components/examples/transactionssale_resp_token","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK854Z","authSource":"E","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using token"},"components/examples/transactionssale_resp_utgdevice":{"id":"components/examples/transactionssale_resp_utgdevice","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXX4509","present":"Y","token":{"value":"6011013928534509"},"type":"NS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"LOCALUTG"},"transaction":{"authorizationCode":"OK978Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using UTG-controlled device"},"components/examples/transactionssale_resp_track":{"id":"components/examples/transactionssale_resp_track","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"2","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK862Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using track information"},"components/examples/transactionssale_resp_raw":{"id":"components/examples/transactionssale_resp_raw","value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK868Z","authSource":"E","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"summary":"Using unencrypted card number"},"components/examples/InvoiceError":{"id":"components/examples/InvoiceError","value":{"result":[{"error":{"primaryCode":9815,"secondaryCode":0,"shortText":"NO INV","longText":"Invoice Not Found 192029 0000057984  ENGINE02CE"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"summary":"Invoice Not Found"},"components/examples/AccessTokenNotFoundError":{"id":"components/examples/AccessTokenNotFoundError","value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AccessToken","longText":"AccessToken not found ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"summary":"AccessToken Not Found"},"components/examples/GiftCardActivateError":{"id":"components/examples/GiftCardActivateError","value":{"result":[{"error":{"primaryCode":9101,"secondaryCode":0,"shortText":"ACTIVATE FAILED","longText":"ACTIVATE FAILED iyc_activateCard: Invalid card or serial number 222 Mid(444444) Invoice(6200007001) ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"summary":"Gift Card Activate Failed"},"components/examples/BatchError":{"id":"components/examples/BatchError","value":{"result":[{"error":{"primaryCode":9300,"secondaryCode":2,"shortText":"BATCH FAILED","longText":"Received Net Amount 1124.49 doesn't match existing Net Amount 1356.27. Batch submission process failed."},"server":{"name":"U2API02CE"}}]},"summary":"Batch Error"},"components/examples/GetEMVCAPKDev":{"id":"components/examples/GetEMVCAPKDev","value":{"result":[{"capkVersion":1,"capks":[{"aid":"A000000003","index":"92","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"996AF56F569187D09293C14810450ED8EE3357397B18A2458EFAA92DA3B6DF6514EC060195318FD43BE9B8F0CC669E3F844057CBDDF8BDA191BB64473BC8DC9A730DB8F6B4EDE3924186FFD9B8C7735789C23A36BA0B8AF65372EB57EA5D89E7D14E9C7B6B557460F10885DA16AC923F15AF3758F0F03EBD3C5C2C949CBA306DB44E6A2C076C5F67E281D7EF56785DC4D75945E491F01918800A9E2DC66F60080566CE0DAF8D17EAD46AD8E30A247C9F","exponent":"03","checksum":"429C954A3859CEF91295F663C963E582ED6EB253"},{"aid":"A000000003","index":"94","expDate":"12312032","algorithm":"01","hashAlgorithm":"01","key":"ACD2B12302EE644F3F835ABD1FC7A6F62CCE48FFEC622AA8EF062BEF6FB8BA8BC68BBF6AB5870EED579BC3973E121303D34841A796D6DCBC41DBF9E52C4609795C0CCF7EE86FA1D5CB041071ED2C51D2202F63F1156C58A92D38BC60BDF424E1776E2BC9648078A03B36FB554375FC53D57C73F5160EA59F3AFC5398EC7B67758D65C9BFF7828B6B82D4BE124A416AB7301914311EA462C19F771F31B3B57336000DFF732D3B83DE07052D730354D297BEC72871DCCF0E193F171ABA27EE464C6A97690943D59BDABB2A27EB71CEEBDAFA1176046478FD62FEC452D5CA393296530AA3F41927ADFE434A2DF2AE3054F8840657A26E0FC617","exponent":"03","checksum":"C4A3C43CCF87327D136B804160E47D43B60E6E0F"},{"aid":"A000000003","index":"95","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"BE9E1FA5E9A803852999C4AB432DB28600DCD9DAB76DFAAA47355A0FE37B1508AC6BF38860D3C6C2E5B12A3CAAF2A7005A7241EBAA7771112C74CF9A0634652FBCA0E5980C54A64761EA101A114E0F0B5572ADD57D010B7C9C887E104CA4EE1272DA66D997B9A90B5A6D624AB6C57E73C8F919000EB5F684898EF8C3DBEFB330C62660BED88EA78E909AFF05F6DA627B","exponent":"03","checksum":"EE1511CEC71020A9B90443B37B1D5F6E703030F6"},{"aid":"A000000003","index":"99","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"AB79FCC9520896967E776E64444E5DCDD6E13611874F3985722520425295EEA4BD0C2781DE7F31CD3D041F565F747306EED62954B17EDABA3A6C5B85A1DE1BEB9A34141AF38FCF8279C9DEA0D5A6710D08DB4124F041945587E20359BAB47B7575AD94262D4B25F264AF33DEDCF28E09615E937DE32EDC03C54445FE7E382777","exponent":"03","checksum":"4ABFFD6B1C51212D05552E431C5B17007D2F5E6D"},{"aid":"A000000004","index":"06","expDate":"12312029","algorithm":"01","hashAlgorithm":"01","key":"CB26FC830B43785B2BCE37C81ED334622F9622F4C89AAE641046B2353433883F307FB7C974162DA72F7A4EC75D9D657336865B8D3023D3D645667625C9A07A6B7A137CF0C64198AE38FC238006FB2603F41F4F3BB9DA1347270F2F5D8C606E420958C5F7D50A71DE30142F70DE468889B5E3A08695B938A50FC980393A9CBCE44AD2D64F630BB33AD3F5F5FD495D31F37818C1D94071342E07F1BEC2194F6035BA5DED3936500EB82DFDA6E8AFB655B1EF3D0D7EBF86B66DD9F29F6B1D324FE8B26CE38AB2013DD13F611E7A594D675C4432350EA244CC34F3873CBA06592987A1D7E852ADC22EF5A2EE28132031E48F74037E3B34AB747F","exponent":"03","checksum":"F910A1504D5FFB793D94F3B500765E1ABCAD72D9"},{"aid":"A000000004","index":"EF","expDate":"12312032","algorithm":"01","hashAlgorithm":"01","key":"A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B","exponent":"03","checksum":"21766EBB0EE122AFB65D7845B73DB46BAB65427A"},{"aid":"A000000004","index":"F1","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"A0DCF4BDE19C3546B4B6F0414D174DDE294AABBB828C5A834D73AAE27C99B0B053A90278007239B6459FF0BBCD7B4B9C6C50AC02CE91368DA1BD21AAEADBC65347337D89B68F5C99A09D05BE02DD1F8C5BA20E2F13FB2A27C41D3F85CAD5CF6668E75851EC66EDBF98851FD4E42C44C1D59F5984703B27D5B9F21B8FA0D93279FBBF69E090642909C9EA27F898959541AA6757F5F624104F6E1D3A9532F2A6E51515AEAD1B43B3D7835088A2FAFA7BE7","exponent":"03","checksum":"D8E68DA167AB5A85D8C3D55ECB9B0517A1A5B4BB"},{"aid":"A000000004","index":"F3","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"98F0C770F23864C2E766DF02D1E833DFF4FFE92D696E1642F0A88C5694C6479D16DB1537BFE29E4FDC6E6E8AFD1B0EB7EA0124723C333179BF19E93F10658B2F776E829E87DAEDA9C94A8B3382199A350C077977C97AFF08FD11310AC950A72C3CA5002EF513FCCC286E646E3C5387535D509514B3B326E1234F9CB48C36DDD44B416D23654034A66F403BA511C5EFA3","exponent":"03","checksum":"A69AC7603DAF566E972DEDC2CB433E07E8B01A9A"},{"aid":"A000000004","index":"F8","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"A1F5E1C9BD8650BD43AB6EE56B891EF7459C0A24FA84F9127D1A6C79D4930F6DB1852E2510F18B61CD354DB83A356BD190B88AB8DF04284D02A4204A7B6CB7C5551977A9B36379CA3DE1A08E69F301C95CC1C20506959275F41723DD5D2925290579E5A95B0DF6323FC8E9273D6F849198C4996209166D9BFC973C361CC826E1","exponent":"03","checksum":"F06ECC6D2AAEBF259B7E755A38D9A9B24E2FF3DD"},{"aid":"A000000004","index":"FA","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"A90FCD55AA2D5D9963E35ED0F440177699832F49C6BAB15CDAE5794BE93F934D4462D5D12762E48C38BA83D8445DEAA74195A301A102B2F114EADA0D180EE5E7A5C73E0C4E11F67A43DDAB5D55683B1474CC0627F44B8D3088A492FFAADAD4F42422D0E7013536C3C49AD3D0FAE96459B0F6B1B6056538A3D6D44640F94467B108867DEC40FAAECD740C00E2B7A8852D","exponent":"03","checksum":"5BED4068D96EA16D2D77E03D6036FC7A160EA99C"},{"aid":"A000000004","index":"FE","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"A653EAC1C0F786C8724F737F172997D63D1C3251C44402049B865BAE877D0F398CBFBE8A6035E24AFA086BEFDE9351E54B95708EE672F0968BCD50DCE40F783322B2ABA04EF137EF18ABF03C7DBC5813AEAEF3AA7797BA15DF7D5BA1CBAF7FD520B5A482D8D3FEE105077871113E23A49AF3926554A70FE10ED728CF793B62A1","exponent":"03","checksum":"9A295B05FB390EF7923F57618A9FDA2941FC34E0"},{"aid":"A000000025","index":"C1","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"E69E319C34D1B4FB43AED4BD8BBA6F7A8B763F2F6EE5DDF7C92579A984F89C4A9C15B27037764C58AC7E45EFBC34E138E56BA38F76E803129A8DDEB5E1CC8C6B30CF634A9C9C1224BF1F0A9A18D79ED41EBCF1BE78087AE8B7D2F896B1DE8B7E784161A138A0F2169AD33E146D1B16AB595F9D7D98BE671062D217F44EB68C68640C7D57465A063F6BAC776D3E2DAC61","exponent":"03","checksum":"DC79D6B5FC879362299BC5A637DAD2E0D99656B8"},{"aid":"A000000025","index":"C2","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"B875002F38BA26D61167C5D440367604AD38DF2E93D8EE8DA0E8D9C0CF4CC5788D11DEA689E5F41D23A3DA3E0B1FA5875AE25620F5A6BCCEE098C1B35C691889D7D0EF670EB8312E7123FCC5DC7D2F0719CC80E1A93017F944D097330EDF945762FEE62B7B0BA0348228DBF38D4216E5A67A7EF74F5D3111C44AA31320F623CB3C53E60966D6920067C9E082B746117E48E4F00E110950CA54DA3E38E5453BD5544E3A6760E3A6A42766AD2284E0C9AF","exponent":"03","checksum":"8E748296359A7428F536ADDA8E2C037E2B697EF6"},{"aid":"A000000025","index":"C3","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"B93182ABE343DFBF388C71C4D6747DCDEC60367FE63CFAA942D7D323E688D0832836548BF0EDFF1EDEEB882C75099FF81A93FA525C32425B36023EA02A8899B9BF7D7934E86F997891823006CEAA93091A73C1FDE18ABD4F87A22308640C064C8C027685F1B2DB7B741B67AB0DE05E870481C5F972508C17F57E4F833D63220F6EA2CFBB878728AA5887DE407D10C6B8F58D46779ECEC1E2155487D52C78A5C03897F2BB580E0A2BBDE8EA2E1C18F6AAF3EB3D04C3477DEAB88F150C8810FD1EF8EB0596866336FE2C1FBC6BEC22B4FE5D885647726DB59709A505F75C49E0D8D71BF51E4181212BE2142AB2A1E8C0D3B7136CD7B7708E4D","exponent":"03","checksum":"12F1790CB0273DC73C6E70784BC24C12E8DB71F6"},{"aid":"A000000025","index":"C8","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"BF0CFCED708FB6B048E3014336EA24AA007D7967B8AA4E613D26D015C4FE7805D9DB131CED0D2A8ED504C3B5CCD48C33199E5A5BF644DA043B54DBF60276F05B1750FAB39098C7511D04BABC649482DDCF7CC42C8C435BAB8DD0EB1A620C31111D1AAAF9AF6571EEBD4CF5A08496D57E7ABDBB5180E0A42DA869AB95FB620EFF2641C3702AF3BE0B0C138EAEF202E21D","exponent":"03","checksum":"33BD7A059FAB094939B90A8F35845C9DC779BD50"},{"aid":"A000000025","index":"C9","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"B362DB5733C15B8797B8ECEE55CB1A371F760E0BEDD3715BB270424FD4EA26062C38C3F4AAA3732A83D36EA8E9602F6683EECC6BAFF63DD2D49014BDE4D6D603CD744206B05B4BAD0C64C63AB3976B5C8CAAF8539549F5921C0B700D5B0F83C4E7E946068BAAAB5463544DB18C63801118F2182EFCC8A1E85E53C2A7AE839A5C6A3CABE73762B70D170AB64AFC6CA482944902611FB0061E09A67ACB77E493D998A0CCF93D81A4F6C0DC6B7DF22E62DB","exponent":"03","checksum":"8E8DFF443D78CD91DE88821D70C98F0638E51E49"},{"aid":"A000000025","index":"CA","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"C23ECBD7119F479C2EE546C123A585D697A7D10B55C2D28BEF0D299C01DC65420A03FE5227ECDECB8025FBC86EEBC1935298C1753AB849936749719591758C315FA150400789BB14FADD6EAE2AD617DA38163199D1BAD5D3F8F6A7A20AEF420ADFE2404D30B219359C6A4952565CCCA6F11EC5BE564B49B0EA5BF5B3DC8C5C6401208D0029C3957A8C5922CBDE39D3A564C6DEBB6BD2AEF91FC27BB3D3892BEB9646DCE2E1EF8581EFFA712158AAEC541C0BBB4B3E279D7DA54E45A0ACC3570E712C9F7CDF985CFAFD382AE13A3B214A9E8E1E71AB1EA707895112ABC3A97D0FCB0AE2EE5C85492B6CFD54885CDD6337E895CC70FB3255E3","exponent":"03","checksum":"6BDA32B1AA171444C7E8F88075A74FBFE845765F"},{"aid":"A000000065","index":"11","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"A2583AA40746E3A63C22478F576D1EFC5FB046135A6FC739E82B55035F71B09BEB566EDB9968DD649B94B6DEDC033899884E908C27BE1CD291E5436F762553297763DAA3B890D778C0F01E3344CECDFB3BA70D7E055B8C760D0179A403D6B55F2B3B083912B183ADB7927441BED3395A199EEFE0DEBD1F5FC3264033DA856F4A8B93916885BD42F9C1F456AAB8CFA83AC574833EB5E87BB9D4C006A4B5346BD9E17E139AB6552D9C58BC041195336485","exponent":"03","checksum":"D9FD62C9DD4E6DE7741E9A17FB1FF2C5DB948BCB"},{"aid":"A000000065","index":"13","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"A3270868367E6E29349FC2743EE545AC53BD3029782488997650108524FD051E3B6EACA6A9A6C1441D28889A5F46413C8F62F3645AAEB30A1521EEF41FD4F3445BFA1AB29F9AC1A74D9A16B93293296CB09162B149BAC22F88AD8F322D684D6B49A12413FC1B6AC70EDEDB18EC1585519A89B50B3D03E14063C2CA58B7C2BA7FB22799A33BCDE6AFCBEB4A7D64911D08D18C47F9BD14A9FAD8805A15DE5A38945A97919B7AB88EFA11A88C0CD92C6EE7DC352AB0746ABF13585913C8A4E04464B77909C6BD94341A8976C4769EA6C0D30A60F4EE8FA19E767B170DF4FA80312DBA61DB645D5D1560873E2674E1F620083F30180BD96CA589","exponent":"03","checksum":"54CFAE617150DFA09D3F901C9123524523EBEDF3"},{"aid":"A000000065","index":"0F","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"9EFBADDE4071D4EF98C969EB32AF854864602E515D6501FDE576B310964A4F7C2CE842ABEFAFC5DC9E26A619BCF2614FE07375B9249BEFA09CFEE70232E75FFD647571280C76FFCA87511AD255B98A6B577591AF01D003BD6BF7E1FCE4DFD20D0D0297ED5ECA25DE261F37EFE9E175FB5F12D2503D8CFB060A63138511FE0E125CF3A643AFD7D66DCF9682BD246DDEA1","exponent":"03","checksum":"2A1B82DE00F5F0C401760ADF528228D3EDE0F403"},{"aid":"A000000152","index":"5A","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"EDD8252468A705614B4D07DE3211B30031AEDB6D33A4315F2CFF7C97DB918993C2DC02E79E2FF8A2683D5BBD0F614BC9AB360A448283EF8B9CF6731D71D6BE939B7C5D0B0452D660CF24C21C47CAC8E26948C8EED8E3D00C016828D642816E658DC2CFC61E7E7D7740633BEFE34107C1FB55DEA7FAAEA2B25E85BED948893D07","exponent":"03","checksum":"CC9585E8E637191C10FCECB32B5AE1B9D410B52D"},{"aid":"A000000152","index":"5B","expDate":"12312050","algorithm":"01","hashAlgorithm":"01","key":"D3F45D065D4D900F68B2129AFA38F549AB9AE4619E5545814E468F382049A0B9776620DA60D62537F0705A2C926DBEAD4CA7CB43F0F0DD809584E9F7EFBDA3778747BC9E25C5606526FAB5E491646D4DD28278691C25956C8FED5E452F2442E25EDC6B0C1AA4B2E9EC4AD9B25A1B836295B823EDDC5EB6E1E0A3F41B28DB8C3B7E3E9B5979CD7E079EF024095A1D19DD","exponent":"03","checksum":"4DC5C6CAB6AE96974D9DC8B2435E21F526BC7A60"},{"aid":"A000000152","index":"5C","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"833F275FCF5CA4CB6F1BF880E54DCFEB721A316692CAFEB28B698CAECAFA2B2D2AD8517B1EFB59DDEFC39F9C3B33DDEE40E7A63C03E90A4DD261BC0F28B42EA6E7A1F307178E2D63FA1649155C3A5F926B4C7D7C258BCA98EF90C7F4117C205E8E32C45D10E3D494059D2F2933891B979CE4A831B301B0550CDAE9B67064B31D8B481B85A5B046BE8FFA7BDB58DC0D7032525297F26FF619AF7F15BCEC0C92BCDCBC4FB207D115AA65CD04C1CF982191","exponent":"03","checksum":"60154098CBBA350F5F486CA31083D1FC474E31F8"},{"aid":"A000000152","index":"5D","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"AD938EA9888E5155F8CD272749172B3A8C504C17460EFA0BED7CBC5FD32C4A80FD810312281B5A35562800CDC325358A9639C501A537B7AE43DF263E6D232B811ACDB6DDE979D55D6C911173483993A423A0A5B1E1A70237885A241B8EEBB5571E2D32B41F9CC5514DF83F0D69270E109AF1422F985A52CCE04F3DF269B795155A68AD2D6B660DDCD759F0A5DA7B64104D22C2771ECE7A5FFD40C774E441379D1132FAF04CDF55B9504C6DCE9F61776D81C7C45F19B9EFB3749AC7D486A5AD2E781FA9D082FB2677665B99FA5F1553135A1FD2A2A9FBF625CA84A7D736521431178F13100A2516F9A43CE095B032B886C7A6AB126E203BE7","exponent":"03","checksum":"B51EC5F7DE9BB6D8BCE8FB5F69BA57A04221F39B"},{"aid":"A000000277","index":"02","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"E0FFBEE77CEE02ADEE8B4B004D26FB46FAF3CE033E3B874D73D099A966A0657497CEE214E95DF2BF5C9D359A3B10C05CFC9929BEF3070036FD19AE661B173E486CBC9B04E4B2E2D0D8209CAF5C200929FA252A21BD69A9A47488844A1DE5BF8729CE5E5E92117047BDDE9FBE72397FD9FC3BE459D8ED06FD6CADF0AFF39C93CC07B312EE2ACB3D4A15E919F57481CFEF","exponent":"010001","checksum":"BAF3652A9F5D0FF45EECECA55B4597B1F53BE283"},{"aid":"A000000277","index":"03","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"E51505CCECDD0799BAFE097200DF40FFC2154836B8D67F1E99D4D415F73C04A9FAD73825D32AE5BA77FCD02597393CE4D8104B6010D5A8F28F2B47BB8298DAFD63C9C0BEF62AF937265614E31AE2AB45B60B968DB9DEE55602C169F6C16D4579BAA24765560300A3056F894BA8FFA566D9CCD79453D804B97DA14F21F9C3528ED8B8A368A9FACF05C46C13A9BA020618425EF1ACF6CB4DD5DCD050273502114B59EE90EBD833F70C2F324741E79A19A1","exponent":"010001","checksum":"0FB60A1BCA38095F3CC578D2DEC95F779840A343"},{"aid":"A000000277","index":"07","expDate":"12312032","algorithm":"01","hashAlgorithm":"01","key":"B2CE89726B6B2D1690A0F8CA75CD0B6B1ACDFBE66D53BA00C500BE612FB421423684FF1868554A7722258012E588ED1CD206C67BB2F7598F3CE67F23A888B8ED7421C49A2EBA224DFBD866F62E59338E9F626D0DFD4C9ACC626E42EC0375EE424C93E5DB5773FC98E4AC9FCDEBD0521B15295C797DCABB4679C055AC374A81B245ABF1092A3D46E1CCE10A84F9FC2FC6ED91025121589C9AA68B56B7FBF0D86B4C8E3C9C08406DBB4609BBFC5308F325A8273CB6D36F3E0AF772507BF8A2A9F5A749B5AF98CCEAB2826C2D9C2AB9103B1BAB0DE92099C8072477EC564062AC38184C60DAD298EF352D92DFA041DDE3DB260CE5302B47A7E9","exponent":"010001","checksum":"44F2C13373A5068B63C9334E914DDE6AB70CE0F1"},{"aid":"A000000277","index":"40","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"F802C308544873AD2225A81943732A4B7CFFA4E3157D17CD5A7723F858F0B11E636D2930FA933778F27C7C49127E0CCA317021CFE8E0F773785EB3FF07587E98CE8ED4FE9E1CA1859F41A9CF2572D8A093C5465F5A29612A45B1700F4DA13814C3D4DF075EAADE8DB4BE4D7B3AE0256F7A0C12E34BD416CAC4F9250C38B7E13B","exponent":"010001","checksum":"2015497BE4B86F104BBF337691825EED64E101CA"},{"aid":"A000000277","index":"41","expDate":"20241231","algorithm":"01","hashAlgorithm":"01","key":"ADC39532AB26462DC02B25CB92748AAC679F07CF7AFD8F9B83C4B94D8C06A1F0D841F35A5F598DD3915FDA8929B8BF2BE0CD03CDC625BFA0FED60D6B8A6778B138C30D4ACA134F337E90F82E4D2FF6180ACA6664F562DF2A11120D10957DF4B2E75607FC960176CBBE6AE3E3F6D5556E47A5EABC850388175609C9AC7AFF6AF12A522EE1EAD1D94EC964E325C97CAC84A1D508769F65FEE99F25196403C98E721116B8084379277AB4D9A2F867B8FCBB280447646915702F20C8ABEE1A29A358D25CFF7EEA66813CB10996BC33E18FC15190CC3B1CDF14934652BA5C8C2E201988E098402556B3ED068862925B90BE2FD61E337FC5BAF7A9","exponent":"010001","checksum":"FD47C4AAB01B9B89314539BB32E0A29770A04387'"},{"aid":"A000000277","index":"42","expDate":"20241231","algorithm":"01","hashAlgorithm":"01","key":"99E0195F9B477160EE90F5FE9773D68DD684C7192528DB67DF0D93B0FDD60B1A9F999A726B7BD97586354575A787363290E7AB423E3D52D037BE38057BA5A9292A5652677E3F754BD642A1702E97279E67AA3411413A7AAB452DF6A1246CA9EF297CBD3BDC1B0A2CA863A48CF87E62400E7AAD29A4880E799187F50861C6C6E976142AD3F456DAEFCB3041557787B4981414D915AFF3EA8CAB738533BBACCA12F75BF107C10F6A029417A051BE0A3285","exponent":"010001","checksum":"64876E40CD5DDE35CF107E8314C67BDE640A6BEE'"},{"aid":"A000000333","index":"08","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"B61645EDFD5498FB246444037A0FA18C0F101EBD8EFA54573CE6E6A7FBF63ED21D66340852B0211CF5EEF6A1CD989F66AF21A8EB19DBD8DBC3706D135363A0D683D046304F5A836BC1BC632821AFE7A2F75DA3C50AC74C545A754562204137169663CFCC0B06E67E2109EBA41BC67FF20CC8AC80D7B6EE1A95465B3B2657533EA56D92D539E5064360EA4850FED2D1BF","exponent":"03","checksum":"EE23B616C95C02652AD18860E48787C079E8E85A"},{"aid":"A000000333","index":"09","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"EB374DFC5A96B71D2863875EDA2EAFB96B1B439D3ECE0B1826A2672EEEFA7990286776F8BD989A15141A75C384DFC14FEF9243AAB32707659BE9E4797A247C2F0B6D99372F384AF62FE23BC54BCDC57A9ACD1D5585C303F201EF4E8B806AFB809DB1A3DB1CD112AC884F164A67B99C7D6E5A8A6DF1D3CAE6D7ED3D5BE725B2DE4ADE23FA679BF4EB15A93D8A6E29C7FFA1A70DE2E54F593D908A3BF9EBBD760BBFDC8DB8B54497E6C5BE0E4A4DAC29E5","exponent":"03","checksum":"A075306EAB0045BAF72CDD33B3B678779DE1F527"},{"aid":"A000000333","index":"0A","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"B2AB1B6E9AC55A75ADFD5BBC34490E53C4C3381F34E60E7FAC21CC2B26DD34462B64A6FAE2495ED1DD383B8138BEA100FF9B7A111817E7B9869A9742B19E5C9DAC56F8B8827F11B05A08ECCF9E8D5E85B0F7CFA644EFF3E9B796688F38E006DEB21E101C01028903A06023AC5AAB8635F8E307A53AC742BDCE6A283F585F48EF","exponent":"03","checksum":"C88BE6B2417C4F941C9371EA35A377158767E4E3"},{"aid":"A000000333","index":"0B","expDate":"12312031","algorithm":"01","hashAlgorithm":"01","key":"CF9FDF46B356378E9AF311B0F981B21A1F22F250FB11F55C958709E3C7241918293483289EAE688A094C02C344E2999F315A72841F489E24B1BA0056CFAB3B479D0E826452375DCDBB67E97EC2AA66F4601D774FEAEF775ACCC621BFEB65FB0053FC5F392AA5E1D4C41A4DE9FFDFDF1327C4BB874F1F63A599EE3902FE95E729FD78D4234DC7E6CF1ABABAA3F6DB29B7F05D1D901D2E76A606A8CBFFFFECBD918FA2D278BDB43B0434F5D45134BE1C2781D157D501FF43E5F1C470967CD57CE53B64D82974C8275937C5D8502A1252A8A5D6088A259B694F98648D9AF2CB0EFD9D943C69F896D49FA39702162ACB5AF29B90BADE005BC157","exponent":"03","checksum":"BD331F9996A490B33C13441066A09AD3FEB5F66C"},{"aid":"A000000768","index":"E1","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"AD767119B139295B9EF760B9A94811580E933A03E76C0A7022F1021278EB6FBBEF36599D5A95C2CB603364E1DA12DF88B76D19F225F14D2A689C580DC2B54457C8BEA50086A4BE897D3353AA003CAFAB5AE3993BE6D379D488689028EC852DFED90EA6FDD73ACF6583934E64601A0EE45AF652B52CC58A9EFFA5D846DD79EFC9A8638275EC264B3C40AA3C8F3DDF1F9D378598362DF48417BF039A04D70B4FFA14A2F6218299428C625EF949F08740ED36FE9265BB8E2CA94604EFC0AEB654F9FC455F22B1EC46871E46638CE190D3691313E41C7F9C8AD4AE3D1B574D4336AD6A2BA551F2DB3A8D44F375CB67D94AFBDFD34DEA92066149","exponent":"03","checksum":"AE03037B9B042B0F9690500DEE287CD706FF73C8"},{"aid":"A000000768","index":"EE","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"A8D150CEE34B16D294B46B99BD6B3284303BD1FFD316C210E876666AD991DFE68DC1BD0835A5E03F753DB0DCE112A928C0C604F5DF256E265E05B59B4DAA15E74B0E5E27E56F8D97C1233D416162DDEC7EFE731D30BBA16683557E4D8FA15269F51D40468D1B2C31CCD314804FC97341F68A1BB78F4985B99F0901557B52196950CF6A12D6FD4356002197B17A8035606DAAC2BFCDB3CD86B9FCDBC64908BFB039C268772D73E44C3867AFC002C12CB5","exponent":"03","checksum":"6DFE06AB7FAD2D98EA18B7849D11DF704D08EFAE"},{"aid":"A000000780","index":"A4","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"D22EF8F41F0685E371B53625692A7EB13B3E9462DD985E044A5915108D2DFCC0A4171C0C0DE4E6D9BD525CAC461A169DAC5101B975D105DEA2AA34B80D9131F47A278DA609B32B1379F98FB960328DE1E27E1EDAFD2DC8A3643AFEB605582C5F953E0DE029643DE058DA6813137EB9450C5C1AD36823BF4C548A5599F6C025274081F6BBF916D79CC00AB77C3AD8E35282FFC9A24CF5F31B0E5585618A75929FBAD4416EC853A76380C84DB3B208389EC2675C9CDEA4AC106EE6AEB242761EEFED6D744E3439588EB17B2CDD956658F59FBB2186B23B396B48E84A7702B91238059FB314CAFCF59B3F09787CCA396ABA35A144C0435DC99D","exponent":"03","checksum":"8438208C174CC1C3FB7793585BF1DE288349B31C"}],"server":{"name":"TM01CE"}}]},"summary":"Development Keys"},"components/examples/GetEMVCAPKProd":{"id":"components/examples/GetEMVCAPKProd","value":{"result":[{"capkVersion":1,"capks":[{"aid":"A000000003","index":"08","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"D9FD6ED75D51D0E30664BD157023EAA1FFA871E4DA65672B863D255E81E137A51DE4F72BCC9E44ACE12127F87E263D3AF9DD9CF35CA4A7B01E907000BA85D24954C2FCA3074825DDD4C0C8F186CB020F683E02F2DEAD3969133F06F7845166ACEB57CA0FC2603445469811D293BFEFBAFAB57631B3DD91E796BF850A25012F1AE38F05AA5C4D6D03B1DC2E568612785938BBC9B3CD3A910C1DA55A5A9218ACE0F7A21287752682F15832A678D6E1ED0B","exponent":"03","checksum":"20D213126955DE205ADC2FD2822BD22DE21CF9A8"},{"aid":"A000000003","index":"09","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"9D912248DE0A4E39C1A7DDE3F6D2588992C1A4095AFBD1824D1BA74847F2BC4926D2EFD904B4B54954CD189A54C5D1179654F8F9B0D2AB5F0357EB642FEDA95D3912C6576945FAB897E7062CAA44A4AA06B8FE6E3DBA18AF6AE3738E30429EE9BE03427C9D64F695FA8CAB4BFE376853EA34AD1D76BFCAD15908C077FFE6DC5521ECEF5D278A96E26F57359FFAEDA19434B937F1AD999DC5C41EB11935B44C18100E857F431A4A5A6BB65114F174C2D7B59FDF237D6BB1DD0916E644D709DED56481477C75D95CDD68254615F7740EC07F330AC5D67BCD75BF23D28A140826C026DBDE971A37CD3EF9B8DF644AC385010501EFC6509D7A41","exponent":"03","checksum":"1FF80A40173F52D7D27E0F26A146A1C8CCB29046"},{"aid":"A000000004","index":"05","expDate":"12312024","algorithm":"01","key":"B8048ABC30C90D976336543E3FD7091C8FE4800DF820ED55E7E94813ED00555B573FECA3D84AF6131A651D66CFF4284FB13B635EDD0EE40176D8BF04B7FD1C7BACF9AC7327DFAA8AA72D10DB3B8E70B2DDD811CB4196525EA386ACC33C0D9D4575916469C4E4F53E8E1C912CC618CB22DDE7C3568E90022E6BBA770202E4522A2DD623D180E215BD1D1507FE3DC90CA310D27B3EFCCD8F83DE3052CAD1E48938C68D095AAC91B5F37E28BB49EC7ED597","hashAlgorithm":"01","exponent":"03","checksum":"EBFA0D5D06D8CE702DA3EAE890701D45E274C845"},{"aid":"A000000004","index":"06","expDate":"12312029","algorithm":"01","hashAlgorithm":"01","key":"CB26FC830B43785B2BCE37C81ED334622F9622F4C89AAE641046B2353433883F307FB7C974162DA72F7A4EC75D9D657336865B8D3023D3D645667625C9A07A6B7A137CF0C64198AE38FC238006FB2603F41F4F3BB9DA1347270F2F5D8C606E420958C5F7D50A71DE30142F70DE468889B5E3A08695B938A50FC980393A9CBCE44AD2D64F630BB33AD3F5F5FD495D31F37818C1D94071342E07F1BEC2194F6035BA5DED3936500EB82DFDA6E8AFB655B1EF3D0D7EBF86B66DD9F29F6B1D324FE8B26CE38AB2013DD13F611E7A594D675C4432350EA244CC34F3873CBA06592987A1D7E852ADC22EF5A2EE28132031E48F74037E3B34AB747F","exponent":"03","checksum":"F910A1504D5FFB793D94F3B500765E1ABCAD72D9"},{"aid":"A000000277","index":"06","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"DB43A71FF30392069A9600143DCB628A4DABDFE69E31CB6151D9A2EB18A53ABA1EF75518CD3EDA29B96D55B002870A649AAFC65CE472BD01352C2D2E77D4EE352B3A64BC2CC170E29D426D7B3317BD3C4FC32EA2151CA0F1071A2ACFECD70468D3EBC7A44440DD63EC9499F302348BB6235F964BF3CAA30B29939B9901C42B5540BF4F837DD898F5392076F9B95F0EBCB6846374FFE71895A422775D95CABA9C25510627D4F7B57A3DBD755608EDD843","exponent":"010001","checksum":"D18AB9F1518FBC0F6EB0EEFB00C5D07CAE8A2197"},{"aid":"A000000277","index":"08","expDate":"12312025","algorithm":"01","hashAlgorithm":"01","key":"AB1B0667B2A68883477B2ED48F3068CB0F57ABBEC93E0AF40180BACD895120E36E2710784599CDE9035550D96BD6C5CEA55C4E8C88A5D0A81CE1309559BCE91930C7AA3E3D0A2D79A6036BE03C4000658A78ECA742034BE5FB0E08D530C7FF9458211E78E33E3803F8DFF24A4117EE0EDFE7A98CB3AE2ECCB2A3C3A75C32512EDD1183CF218BE1642FA78430A18A495E6FEFA7B98860C6FCEBFD27537D34F4E55B9CBDEB19DF029BDF00993E1A2E0B9E89E1B49777FCB7C1610CDA94A488C9177908B75C48DFE3F8BBD52886233B44B1A58373D5AFD0F309ABB939C39DF95D923F76B7300E83D182C2922EBB9FD018867A0E6D179EFF8C87","exponent":"010001","checksum":"46EAD2ED0B8645D4DCB2AE4B1D285A0632B452D4"},{"aid":"A000000025","index":"0F","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"C8D5AC27A5E1FB89978C7C6479AF993AB3800EB243996FBB2AE26B67B23AC482C4B746005A51AFA7D2D83E894F591A2357B30F85B85627FF15DA12290F70F05766552BA11AD34B7109FA49DE29DCB0109670875A17EA95549E92347B948AA1F045756DE56B707E3863E59A6CBE99C1272EF65FB66CBB4CFF070F36029DD76218B21242645B51CA752AF37E70BE1A84FF31079DC0048E928883EC4FADD497A719385C2BBBEBC5A66AA5E5655D18034EC5","exponent":"03","checksum":"A73472B3AB557493A9BC2179CC8014053B12BAB4"},{"aid":"A000000025","index":"10","expDate":"12312029","algorithm":"10","hashAlgorithm":"01","key":"CF98DFEDB3D3727965EE7797723355E0751C81D2D3DF4D18EBAB9FB9D49F38C8C4A826B99DC9DEA3F01043D4BF22AC3550E2962A59639B1332156422F788B9C16D40135EFD1BA94147750575E636B6EBC618734C91C1D1BF3EDC2A46A43901668E0FFC136774080E888044F6A1E65DC9AAA8928DACBEB0DB55EA3514686C6A732CEF55EE27CF877F110652694A0E3484C855D882AE191674E25C296205BBB599455176FDD7BBC549F27BA5FE35336F7E29E68D783973199436633C67EE5A680F05160ED12D1665EC83D1997F10FD05BBDBF9433E8F797AEE3E9F02A34228ACE927ABE62B8B9281AD08D3DF5C7379685045D7BA5FCDE58637","exponent":"03","checksum":"C729CF2FD262394ABC4CC173506502446AA9B9FD"},{"aid":"A000000152","index":"04","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"8EEEC0D6D3857FD558285E49B623B109E6774E06E9476FE1B2FB273685B5A235E955810ADDB5CDCC2CB6E1A97A07089D7FDE0A548BDC622145CA2DE3C73D6B14F284B3DC1FA056FC0FB2818BCD7C852F0C97963169F01483CE1A63F0BF899D412AB67C5BBDC8B4F6FB9ABB57E95125363DBD8F5EBAA9B74ADB93202050341833DEE8E38D28BD175C83A6EA720C262682BEABEA8E955FE67BD9C2EFF7CB9A9F45DD5BDA4A1EEFB148BC44FFF68D9329FD","exponent":"03","checksum":"17F971CAF6B708E5B9165331FBA91593D0C0BF66"},{"aid":"A000000152","index":"05","expDate":"12312026","algorithm":"01","hashAlgorithm":"01","key":"E1200E9F4428EB71A526D6BB44C957F18F27B20BACE978061CCEF23532DBEBFAF654A149701C14E6A2A7C2ECAC4C92135BE3E9258331DDB0967C3D1D375B996F25B77811CCCC06A153B4CE6990A51A0258EA8437EDBEB701CB1F335993E3F48458BC1194BAD29BF683D5F3ECB984E31B7B9D2F6D947B39DEDE0279EE45B47F2F3D4EEEF93F9261F8F5A571AFBFB569C150370A78F6683D687CB677777B2E7ABEFCFC8F5F93501736997E8310EE0FD87AFAC5DA772BA277F88B44459FCA563555017CD0D66771437F8B6608AA1A665F88D846403E4C41AFEEDB9729C2B2511CFE228B50C1B152B2A60BBF61D8913E086210023A3AA499E423","exponent":"03","checksum":"12BCD407B6E627A750FDF629EE8C2C9CC7BA636A"},{"aid":"A000000065","index":"12","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"ADF05CD4C5B490B087C3467B0F3043750438848461288BFEFD6198DD576DC3AD7A7CFA07DBA128C247A8EAB30DC3A30B02FCD7F1C8167965463626FEFF8AB1AA61A4B9AEF09EE12B009842A1ABA01ADB4A2B170668781EC92B60F605FD12B2B2A6F1FE734BE510F60DC5D189E401451B62B4E06851EC20EBFF4522AACC2E9CDC89BC5D8CDE5D633CFD77220FF6BBD4A9B441473CC3C6FEFC8D13E57C3DE97E1269FA19F655215B23563ED1D1860D8681","exponent":"03","checksum":"874B379B7F607DC1CAF87A19E400B6A9E25163E8"},{"aid":"A000000065","index":"14","expDate":"12312026","algorithm":"01","hashAlgorithm":"01","key":"AEED55B9EE00E1ECEB045F61D2DA9A66AB637B43FB5CDBDB22A2FBB25BE061E937E38244EE5132F530144A3F268907D8FD648863F5A96FED7E42089E93457ADC0E1BC89C58A0DB72675FBC47FEE9FF33C16ADE6D341936B06B6A6F5EF6F66A4EDD981DF75DA8399C3053F430ECA342437C23AF423A211AC9F58EAF09B0F837DE9D86C7109DB1646561AA5AF0289AF5514AC64BC2D9D36A179BB8A7971E2BFA03A9E4B847FD3D63524D43A0E8003547B94A8A75E519DF3177D0A60BC0B4BAB1EA59A2CBB4D2D62354E926E9C7D3BE4181E81BA60F8285A896D17DA8C3242481B6C405769A39D547C74ED9FF95A70A796046B5EFF36682DC29","exponent":"03","checksum":"C0D15F6CD957E491DB56DCDD1CA87A03EBE06B7B"},{"aid":"A000000333","index":"03","expDate":"12312024","algorithm":"01","hashAlgorithm":"01","key":"B0627DEE87864F9C18C13B9A1F025448BF13C58380C91F4CEBA9F9BCB214FF8414E9B59D6ABA10F941C7331768F47B2127907D857FA39AAF8CE02045DD01619D689EE731C551159BE7EB2D51A372FF56B556E5CB2FDE36E23073A44CA215D6C26CA68847B388E39520E0026E62294B557D6470440CA0AEFC9438C923AEC9B2098D6D3A1AF5E8B1DE36F4B53040109D89B77CAFAF70C26C601ABDF59EEC0FDC8A99089140CD2E817E335175B03B7AA33D","exponent":"03","checksum":"87F0CD7C0E86F38F89A66F8C47071A8B88586F26"},{"aid":"A000000333","index":"04","expDate":"12312032","algorithm":"01","hashAlgorithm":"01","key":"BC853E6B5365E89E7EE9317C94B02D0ABB0DBD91C05A224A2554AA29ED9FCB9D86EB9CCBB322A57811F86188AAC7351C72BD9EF196C5A01ACEF7A4EB0D2AD63D9E6AC2E7836547CB1595C68BCBAFD0F6728760F3A7CA7B97301B7E0220184EFC4F653008D93CE098C0D93B45201096D1ADFF4CF1F9FC02AF759DA27CD6DFD6D789B099F16F378B6100334E63F3D35F3251A5EC78693731F5233519CDB380F5AB8C0F02728E91D469ABD0EAE0D93B1CC66CE127B29C7D77441A49D09FCA5D6D9762FC74C31BB506C8BAE3C79AD6C2578775B95956B5370D1D0519E37906B384736233251E8F09AD79DFBE2C6ABFADAC8E4D8624318C27DAF1","exponent":"03","checksum":"F527081CF371DD7E1FD4FA414A665036E0F5E6E5"},{"aid":"A000000780","index":"05","expDate":"12312030","algorithm":"01","hashAlgorithm":"01","key":"95E3D868E014B01210491A6EA00C097D4261AED776930E6D4FCA31C7477E29AEC5B77F7D2F0B6E61B34C876806A71A8FF1EC3E897943BE5524E7A0F7BD23840FF3B1D25C078BC32FE38E57307B413A255E268B795B45CB5B430BEAD8ABFB835F3248AFA34F85DD028DBC77D1EABFA79A2D891806A0B0BC5D25D213188E3E18DB25F45B7942320D1F55D637299334744D5633D954C70E1BAA73C2562F3C142DF9545CE4841653B80D6DD1D88C2F652ABED57551BDCA98C16D77A4139D2F84E5E3633A00DEFB3E865825DB326E6B68DC04B6AE1FAEABB6C867C30E172C94E33FC220C7C7C4342A4356DABE0A5CAB61606B649B5F33B75E35CD","exponent":"03","checksum":"30AB6C5690B74D7117355AFBA07749B5142B57F2"},{"aid":"A000000768","index":"F2","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"9318623777A684FA329C2DC24AA398678DE27CB2C547C6DB6542125409528823D75F42455789C2F7705D8B77EEA7674F923E3D657C0AB8ADF4941ED3AB2877058D30BE31572BF3D570652ED9F3C9E320BA8D96FF000047FEA4582E6BA368D8FF16BE90843657CB7467D4980C9B2ED67333BFBDAE60CAB42D420A34D648816406112186EA397E7155F5EE3858D8CCACA9D11E9D85BC5373FF4B074D3BAC5C3220003B7096614EB1D7FB9216D22D6B7B7695ADDC109A51D0CACFF438A0763F001711B687BAFCD26671FCA21EDD042B1201FCB01D5807C4E94D23CB3D56E3AD16F1F03DB61381FC7F152A391D8A62BCB9D339E12A23A76F9213","exponent":"03","checksum":"D8E9DA9B8461A43F469BBD08CD3A52B0B3AA775F"},{"aid":"A000000768","index":"FF","expDate":"12312027","algorithm":"01","hashAlgorithm":"01","key":"86EFCDB87055ED668CF037EC4177B05B102C01EBAF0318CA2362698012ECED53CF176A06DE4F8A113CA091E7E9BDA6A715E3D89926895DFC320574D02EFFBFF1B81F158B9896651EFF8CBC548C51E7BD68338F5A11171C4540E194A91D9D36A6C4132D3799DF911F32132A0B5CCC632200EFBE5752DCCF930F2B7AB76B81588894604215B193CBF160C5BAA32C89F450D15CF0E6B866D3AA249960B69B18B9B2575D741BB2089102A96E6A42067EF6BB","exponent":"03","checksum":"E7ABF106A6704AE58CBA4ACA509FD9EC33A147D5"}],"server":{"name":"TM01CE"}}]},"summary":"Production Keys"},"paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AuthToken","longText":"AuthToken not valid ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"AuthToken Not Valid","id":"paths/~1credentials~1accesstoken/post/responses/400/content/application~1json/examples/Error"},"paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1credentials~1accesstoken/post/responses/504/content/application~1json/example"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"E","number":"XXXXXXXXXXXX4111","present":"Y","token":{"value":"8058471748284111"},"type":"MC"},"clerk":{"numericId":1576},"emv":{"tlvData":"910A0102030405060708090A"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"AmountAuthorized","printName":"9F02","printValue":"000000000444"},{"key":"ApplicationIdentifier","printName":"AID","printValue":"A0000000041010"},{"key":"ApplicationLabel","printValue":"MasterCard"},{"key":"CVMResults","printName":"9F34","printValue":"1E0300"},{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"CHIP"},{"key":"CardholderVerificationMethod","printName":"CVM","printValue":"SIGN"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX4111"},{"key":"PANSequenceNumber","printName":"5F34","printValue":"01"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TerminalVerificationResults","printName":"TVR","printValue":"0820000000"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"},{"key":"TransactionStatusIndicator","printName":"TSI","printValue":"C800"},{"key":"UnpredictableNumber","printName":"9F37","printValue":"C5BF918D"}],"server":{"name":"U2API01CE"},"transaction":{"authorizationCode":"OK253W","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"P2PEEMV","summary":"Using EMV with P2PE","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PEEMV"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXXXX0009","present":"Y","token":{"value":"8058471748050009"},"type":"MC"},"clerk":{"numericId":1576},"customer":{"firstName":"MC2\\/DUAL","lastName":"TRACK"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX0009"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK183Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"P2PE","summary":"Using P2PE","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/P2PE"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","expirationDate":1222,"number":"XXXXXXXXXXXX1119","present":"N","token":{"value":"11191pn83hbkkety"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK126Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Token","summary":"Using token","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Token"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"tax":15,"total":140},"card":{"entryMode":"1","number":"XXXXXXXXXX4509","present":"Y","token":{"value":"6011013928534509"},"type":"NS"},"clerk":{"numericId":1576},"customer":{"firstName":"DC\\/TRACK1","lastName":"ONLY"},"device":{"terminalId":"350"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"LOCALUTG"},"transaction":{"authorizationCode":"OK892Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Device","summary":"Using UTG-controlled device","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Device"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"2","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"1119p4kgmkb39zx2"},"type":"VS"},"clerk":{"numericId":1576},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK007Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Track","summary":"Using track information","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Track"},"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK408Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Unenc","summary":"Using unencrypted card number","id":"paths/~1transactions~1authorization/post/responses/200/content/application~1json/examples/Unenc"},"paths/~1transactions~1authorization/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1authorization/post/responses/504/content/application~1json/example"},"paths/~1transactions~1capture/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1capture/post/responses/504/content/application~1json/example"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"E","number":"XXXXXXXXXXXX4111","present":"Y","token":{"value":"8058471748284111"},"type":"MC"},"clerk":{"numericId":1576},"emv":{"tlvData":"910A0102030405060708090A"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"AmountAuthorized","printName":"9F02","printValue":"000000000444"},{"key":"ApplicationIdentifier","printName":"AID","printValue":"A0000000041010"},{"key":"ApplicationLabel","printValue":"MasterCard"},{"key":"CVMResults","printName":"9F34","printValue":"1E0300"},{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"CHIP"},{"key":"CardholderVerificationMethod","printName":"CVM","printValue":"SIGN"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX4111"},{"key":"PANSequenceNumber","printName":"5F34","printValue":"01"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TerminalVerificationResults","printName":"TVR","printValue":"0820000000"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"},{"key":"TransactionStatusIndicator","printName":"TSI","printValue":"C800"},{"key":"UnpredictableNumber","printName":"9F37","printValue":"C5BF918D"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK710W","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"P2PEEMV","summary":"Using EMV with P2PE","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PEEMV"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"VS/DUAL","lastName":"TRACK"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK850Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"P2PE","summary":"Using P2PE","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/P2PE"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK854Z","authSource":"E","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Token","summary":"Using token","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Token"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","number":"XXXXXXXXXX4509","present":"Y","token":{"value":"6011013928534509"},"type":"NS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"LOCALUTG"},"transaction":{"authorizationCode":"OK978Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Device","summary":"Using UTG-controlled device","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Device"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"2","number":"XXXXXXXXXXXX1119","present":"Y","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"SWIPED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI02CE"},"transaction":{"authorizationCode":"OK862Z","authSource":"E","hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Track","summary":"Using track information","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Track"},"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"M","number":"XXXXXXXXXXXX1119","present":"N","securityCode":{"result":"M","valid":"Y"},"token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK868Z","authSource":"E","avs":{"postalCodeVerified":"N","result":"A","streetVerified":"Y","valid":"Y"},"hostResponse":{"reasonCode":"04","reasonDescription":"PickUpCard_NoFraud","reattemptPermission":"Reattempt not permitted"},"invoice":"192029","responseCode":"A","retrievalReference":"402F9H0230S0","saleFlag":"S"}}]},"key":"Unenc","summary":"Using unencrypted card number","id":"paths/~1transactions~1sale/post/responses/200/content/application~1json/examples/Unenc"},"paths/~1transactions~1sale/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1sale/post/responses/504/content/application~1json/example"},"paths/~1transactions~1refund/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1refund/post/responses/504/content/application~1json/example"},"paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9815,"secondaryCode":0,"shortText":"NO INV","longText":"Invoice Not Found 192029 0000057984  ENGINE02CE"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"Invoice Not Found","id":"paths/~1transactions~1invoice/get/responses/400/content/application~1json/examples/Error"},"paths/~1transactions~1invoice/get/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1invoice/get/responses/504/content/application~1json/example"},"paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9815,"secondaryCode":0,"shortText":"NO INV","longText":"Invoice Not Found 192029 0000057984  ENGINE02CE"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"Invoice Not Found","id":"paths/~1transactions~1invoice/delete/responses/400/content/application~1json/examples/Error"},"paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1invoice/delete/responses/504/content/application~1json/example"},"paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1manualauthorization/post/responses/504/content/application~1json/example"},"paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1manualsale/post/responses/504/content/application~1json/example"},"paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9815,"secondaryCode":0,"shortText":"NO INV","longText":"Invoice Not Found 192029 0000057984  ENGINE02CE"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"Invoice Not Found","id":"paths/~1transactions~1signature/post/responses/400/content/application~1json/examples/Error"},"paths/~1transactions~1signature/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1transactions~1signature/post/responses/504/content/application~1json/example"},"paths/~1tokens~1add/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1add/post/responses/504/content/application~1json/example"},"paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"serialNumber":"266","value":"1119eqetd26hfne4"}}},"id":"paths/~1tokens~1duplicate/post/requestBody/content/application~1json/example"},"paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2022-05-10T06:34:25.049-07:00","card":{"expirationDate":1230,"number":"XXXXXXXXXXXX1119","type":"VS","token":{"value":"1119djw7fh2jwo4r"}},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"TM01CE"},"universalToken":{"value":"97032276-5944-00000001-16985FD179D"}}]},"id":"paths/~1tokens~1duplicate/post/responses/200/content/application~1json/example"},"paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1duplicate/post/responses/400/content/application~1json/example"},"paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1duplicate/post/responses/504/content/application~1json/example"},"paths/~1tokens~1delete/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"1119eqetd26hfne4"}}},"id":"paths/~1tokens~1delete/post/requestBody/content/application~1json/example"},"paths/~1tokens~1delete/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2022-05-10T06:34:25.049-07:00","card":{"token":{"value":"1119eqetd26hfne4"}},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"TM01CE"}}]},"id":"paths/~1tokens~1delete/post/responses/200/content/application~1json/example"},"paths/~1tokens~1delete/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1delete/post/responses/400/content/application~1json/example"},"paths/~1tokens~1delete/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1delete/post/responses/504/content/application~1json/example"},"paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~1universaltoken/get/responses/504/content/application~1json/example"},"paths/~1tokens~14words/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"token":{"value":"8048471746471119"}}},"id":"paths/~1tokens~14words/post/requestBody/content/application~1json/example"},"paths/~1tokens~14words/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~14words/post/responses/400/content/application~1json/example"},"paths/~1tokens~14words/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1tokens~14words/post/responses/504/content/application~1json/example"},"paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AccessToken","longText":"AccessToken not found ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"AccessToken Not Found","id":"paths/~1merchants~1merchant/get/responses/400/content/application~1json/examples/Error"},"paths/~1merchants~1merchant/get/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1merchants~1merchant/get/responses/504/content/application~1json/example"},"paths/~1giftcards~1activate/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":20},"card":{"number":"XXXXXXXXXXXX1333","balance":{"amount":20},"token":{"value":"8058471748050009"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192030","responseCode":"A"}}]},"id":"paths/~1giftcards~1activate/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9101,"secondaryCode":0,"shortText":"ACTIVATE FAILED","longText":"ACTIVATE FAILED iyc_activateCard: Invalid card or serial number 222 Mid(444444) Invoice(6200007001) ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"Gift Card Activate Failed","id":"paths/~1giftcards~1activate/post/responses/400/content/application~1json/examples/Error"},"paths/~1giftcards~1activate/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1activate/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":25},"programId":"95","transaction":{"invoice":"192029"}},"id":"paths/~1giftcards~1allocate/post/requestBody/content/application~1json/example"},"paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":20},"card":{"number":"1000083000004141494","type":"GC","balance":{"amount":20}},"merchant":{"mid":15877,"name":"Merchant XYZ"},"programId":"95","server":{"name":"UTGAPI01CE"},"transaction":{"invoice":"192029","responseCode":"A"}}]},"id":"paths/~1giftcards~1allocate/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"longText":"ALLOCATE Failed: Need sample error","primaryCode":9101,"secondaryCode":0,"shortText":"ALLOCATE FAILED"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1allocate/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1allocate/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"entryMode":"1","number":"XXXXXXXXXXXX1333","present":"Y","deactivationReason":"lost or stolen","balance":{"amount":20},"token":{"value":"0009hfqbt8b396x1"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192032","responseCode":"A"}}]},"id":"paths/~1giftcards~1deactivate/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1deactivate/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1deactivate/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":20},"card":{"entryMode":"1","number":"XXXXXXXXXXXX1333","present":"Y","deactivationReason":"lost or stolen","token":{"value":"0009hfqbt8b396x1"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192034","responseCode":"A"}}]},"id":"paths/~1giftcards~1cashback/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cashback/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cashback/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"number":"XXXXXXXXXXXX1333","balance":{"amount":30},"token":{"value":"0009hfqbt8b396x1"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192033","responseCode":"A"}}]},"id":"paths/~1giftcards~1reactivate/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1reactivate/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1reactivate/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1reload/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":20},"card":{"number":"XXXXXXXXXXXX1333","balance":{"amount":30},"token":{"value":"0009hfqbt8b396x1"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192031","responseCode":"A"}}]},"id":"paths/~1giftcards~1reload/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1reload/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1reload/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1reload/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1reload/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active":{"value":{"result":[{"dateTime":"2019-04-15T16:10:44.000-07:00","card":{"balance":{"amount":20},"entryMode":"M","number":"XXXXXXXXXXXX1333","token":{"value":"1333jd4nmj9p787m"},"type":"YC"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"U2API01CE"},"transaction":{"authSource":"E","invoice":"6241932450","responseCode":"A"},"history":[{"dateTime":"2019-04-12T08:13:23.000-07:00","amount":{"total":80},"transactionType":"Sale"},{"dateTime":"2019-03-12T08:10:44.000-07:00","amount":{"total":100},"transactionType":"Activate"}]}]},"key":"Active","summary":"Active Card","id":"paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Active"},"paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","card":{"balance":{"amount":24.33},"deactivationReason":"lost or stolen","entryMode":"M","number":"XXXXXXXXXXXX8774","present":"Y","token":{"value":"87743q5p3ffhv67y"},"type":"YC"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"U2API01CE"},"transaction":{"authSource":"E","invoice":"192029","responseCode":"A"}}]},"key":"Inactive","summary":"Inactive Card","id":"paths/~1giftcards~1balance/post/responses/200/content/application~1json/examples/Inactive"},"paths/~1giftcards~1balance/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1balance/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1balance/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1balance/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cancel/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cancel/post/responses/504/content/application~1json/example"},"paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":20},"card":{"entryMode":"1","number":"XXXXXXXXXXXX1333","present":"Y","deactivationReason":"lost or stolen","token":{"value":"0009hfqbt8b396x1"},"type":"YC"},"device":{"terminalId":"1742"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"UTGAPI01CE"},"transaction":{"authSource":"E","invoice":"192034","responseCode":"A"}}]},"id":"paths/~1giftcards~1cashout/post/responses/200/content/application~1json/example"},"paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9846,"secondaryCode":0,"shortText":"BAD UNIQUE ID","longText":"Unique Identifier(8048471746471119) not found for Merchant 0000057984 ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cashout/post/responses/400/content/application~1json/example"},"paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1giftcards~1cashout/post/responses/504/content/application~1json/example"},"paths/~1cards~1verify/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1cards~1verify/post/responses/504/content/application~1json/example"},"paths/~1cards~1identify/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1cards~1identify/post/responses/504/content/application~1json/example"},"paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptsignature/post/responses/400/content/application~1json/example"},"paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptsignature/post/responses/504/content/application~1json/example"},"paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptconfirmation/post/responses/400/content/application~1json/example"},"paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptconfirmation/post/responses/504/content/application~1json/example"},"paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1termsandconditions/post/responses/400/content/application~1json/example"},"paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1termsandconditions/post/responses/504/content/application~1json/example"},"paths/~1devices~1lineitems/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","device":{"lineItems":["Hamburger","Fries","Soda","Cookie"],"terminalId":"1742"}},"id":"paths/~1devices~1lineitems/post/requestBody/content/application~1json/example"},"paths/~1devices~1lineitems/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1lineitems/post/responses/400/content/application~1json/example"},"paths/~1devices~1lineitems/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1lineitems/post/responses/504/content/application~1json/example"},"paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1lineitems/delete/responses/400/content/application~1json/example"},"paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1lineitems/delete/responses/504/content/application~1json/example"},"paths/~1devices~1info/get/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1info/get/responses/400/content/application~1json/example"},"paths/~1devices~1info/get/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1info/get/responses/504/content/application~1json/example"},"paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1initializereaders/post/responses/400/content/application~1json/example"},"paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1initializereaders/post/responses/504/content/application~1json/example"},"paths/~1devices~1reset/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1reset/post/responses/400/content/application~1json/example"},"paths/~1devices~1reset/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1reset/post/responses/504/content/application~1json/example"},"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard":{"value":{"result":[{"dateTime":"2024-05-21T09:18:23.283-07:00","card":{"entryMode":"2","expirationDate":643,"number":"0001366477393106","trackData":";0001366477393106=430692960042575?"},"server":{"name":"Commerce Engine K"}}]},"key":"unencryptedgiftcard","summary":"Unencrypted Gift Card","id":"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedgiftcard"},"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard":{"value":{"result":[{"dateTime":"2024-05-21T09:18:23.283-07:00","card":{"entryMode":"2","trackData":";:<>4114952129?"},"server":{"name":"Commerce Engine K"}}]},"key":"unencryptedemployeecard","summary":"Unencrypted Employee Badge Data Card","id":"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/unencryptedemployeecard"},"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard":{"value":{"result":[{"dateTime":"2024-05-21T09:18:23.283-07:00","card":{"entryMode":"1","number":"XXXXXXXXXXXX6186","type":"NS"},"p2pe":{"data":"a%B369989****6186^DC/TRACK1 ONLY^2212101**************************??b?c;FFFF49003614954000BB:1:0072:8B997BF3896636D43593897B86C58A4C7B684B69C5DC150FF53882A15C34C3FCBCEBCFEA0FA68FAC3F0148431B3C6470514A20A5104AF853BDF4D1BD8EBD0E9FAB493176BD2614DC","format":"03"},"server":{"name":"U2API01CE"}}]},"key":"encryptedcard","summary":"Encrypted Card Brand Data","id":"paths/~1devices~1promptcardread/post/responses/200/content/application~1json/examples/encryptedcard"},"paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptcardread/post/responses/400/content/application~1json/example"},"paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptcardread/post/responses/504/content/application~1json/example"},"paths/~1devices~1promptinput/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptinput/post/responses/400/content/application~1json/example"},"paths/~1devices~1promptinput/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1promptinput/post/responses/504/content/application~1json/example"},"paths/~1devices~1processform/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1processform/post/responses/400/content/application~1json/example"},"paths/~1devices~1processform/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1processform/post/responses/504/content/application~1json/example"},"paths/~1devices~1print/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1print/post/responses/400/content/application~1json/example"},"paths/~1devices~1print/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1print/post/responses/504/content/application~1json/example"},"paths/~1devices~1getstatus/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1getstatus/post/responses/400/content/application~1json/example"},"paths/~1devices~1getstatus/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1getstatus/post/responses/504/content/application~1json/example"},"paths/~1devices~1prompttip/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9956,"secondaryCode":0,"shortText":"TID NO PINPAD","longText":"Terminal(100) is not configured for any PinPad DEFAULT"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1prompttip/post/responses/400/content/application~1json/example"},"paths/~1devices~1prompttip/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1devices~1prompttip/post/responses/504/content/application~1json/example"},"paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AccessToken","longText":"AccessToken not found ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"AccessToken Not Found","id":"paths/~1reports~1batchtotals/get/responses/400/content/application~1json/examples/Error"},"paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1reports~1batchtotals/get/responses/504/content/application~1json/example"},"paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9300,"secondaryCode":2,"shortText":"BATCH FAILED","longText":"Received Net Amount 1124.49 doesn't match existing Net Amount 1356.27. Batch submission process failed."},"server":{"name":"U2API02CE"}}]},"key":"Error","summary":"Batch Error","id":"paths/~1batches~1submit/post/responses/400/content/application~1json/examples/Error"},"paths/~1batches~1submit/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1batches~1submit/post/responses/504/content/application~1json/example"},"paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"longText":"Fail to post QR Pay record","primaryCode":9870,"secondaryCode":4,"shortText":"QR PAY ERROR"},"server":{"name":"U2API02CE"}}]},"id":"paths/~1qrpayments~1getqrcode/post/responses/400/content/application~1json/example"},"paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1getqrcode/post/responses/504/content/application~1json/example"},"paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"longText":"Invalid QR Code - not found","primaryCode":9870,"secondaryCode":1,"shortText":"QR PAY ERROR"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1getqrdetails/post/responses/400/content/application~1json/example"},"paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1getqrdetails/post/responses/504/content/application~1json/example"},"paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"cashback":20,"tax":15,"tip":20,"total":160},"card":{"entryMode":"1","expirationDate":1222,"number":"XXXXXXXXXXXX1119","present":"N","token":{"value":"8048471746471119"},"type":"VS"},"clerk":{"numericId":1576},"customer":{"firstName":"John","lastName":"Smith"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"receipt":[{"key":"CardEntryMode","printName":"ENTRY METHOD","printValue":"KEYED"},{"key":"MaskedPAN","printValue":"XXXXXXXXXXXX1119"},{"key":"SignatureRequired","printValue":"Y"},{"key":"TransactionResponse","printName":"Response","printValue":"APPROVED"}],"server":{"name":"UTGAPI01CE"},"transaction":{"authorizationCode":"OK126Z","authSource":"E","invoice":"192029","responseCode":"A","saleFlag":"S"}}]},"key":"QRPAYSUCCESS","summary":"QR Payment Processed Successfully","id":"paths/~1qrpayments~1getqrpaymentstatus/post/responses/200/content/application~1json/examples/QRPAYSUCCESS"},"paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"longText":"QR Pay is Cancelled - unable to process request","primaryCode":9870,"secondaryCode":6,"shortText":"QR PAY ERROR"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1getqrpaymentstatus/post/responses/400/content/application~1json/example"},"paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1getqrpaymentstatus/post/responses/504/content/application~1json/example"},"paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example":{"value":{"result":[{"error":{"longText":"Invalid QR Code - not found","primaryCode":9870,"secondaryCode":1,"shortText":"QR PAY ERROR"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1cancelqrpayment/post/responses/400/content/application~1json/example"},"paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1qrpayments~1cancelqrpayment/post/responses/504/content/application~1json/example"},"paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AuthToken","longText":"AuthToken not valid ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"AuthToken Not Valid","id":"paths/~1mode~1offline/post/responses/400/content/application~1json/examples/Error"},"paths/~1mode~1offline/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1mode~1offline/post/responses/504/content/application~1json/example"},"paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error":{"value":{"result":[{"error":{"primaryCode":9862,"secondaryCode":0,"shortText":"AuthToken","longText":"AuthToken not valid ENGINE01CE"},"server":{"name":"U2API01CE"}}]},"key":"Error","summary":"AuthToken Not Valid","id":"paths/~1mode~1online/post/responses/400/content/application~1json/examples/Error"},"paths/~1mode~1online/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1mode~1online/post/responses/504/content/application~1json/example"},"paths/~1risk~1assess/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":76001.99},"card":{"token":{"value":"8058471748284111"}},"merchant":{"mid":15877,"name":"Merchant XYZ"},"risk":{"tranId":"DDWT0P3LG6LL","assessment":"A"},"transaction":{"s4RiskId":"EC52377F-5A8E-4534-BE7A-CF779A35BE45","invoice":"0207123502","orderId":"orderId"}}]},"id":"paths/~1risk~1assess/post/responses/200/content/application~1json/example"},"paths/~1paypal~1sale/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2022-04-14T13:31:52.023807","amount":{"total":15},"currencyCode":"USD","transaction":{"invoice":"0414133134"},"payPal":{"payerId":"6CB2GS6AQRS5S","paymentMethodNonce":"fd66f90e-c8ec-0363-6b45-aeb930175e43","deviceData":"{\"correlation_id\":\"010e4 a744d78644f971fc5f9dc1c43aa\"}"},"sourceIp":"10.249.11.254","customer":{"browserType":"Mozilla 5.0"}},"id":"paths/~1paypal~1sale/post/requestBody/content/application~1json/example"},"paths/~1paypal~1sale/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2022-04-14T12:18:26.717923-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","invoice":"0414151800","responseCode":"A"},"server":{"name":"WH-APM-V01.PPDEV1"},"payPal":{"transactionId":"dHJhbnNhY3Rpb25fazd6cDB5ZzA","legacyId":"k7zp0yg0","orderId":"444106-8010720-0414151800-4371","authorizationId":"6W6361048T1775802","captureId":"3EK61497JE2934158","status":"SETTLING","paymentMethodId":"dda7z0fq"},"amount":{"total":15}}]},"id":"paths/~1paypal~1sale/post/responses/200/content/application~1json/example"},"paths/~1paypal~1refund/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":15},"transaction":{"invoice":"0414151837","originalInvoice":"0414151800","originalDate":"2022-04-14T00:00:00-04:00"}},"id":"paths/~1paypal~1refund/post/requestBody/content/application~1json/example"},"paths/~1paypal~1refund/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2022-04-14T12:18:47.515770-07:00","amount":{"total":15},"merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","invoice":"0414151837","responseCode":"A"},"payPal":{"transactionId":"cmVmdW5kX2s4dDRkZGEx","legacyId":"k8t4dda1","orderId":"444106-8010720-0414151837-4372","status":"SETTLING"},"server":{"name":"WH-APM-V01.PPDEV1"}}]},"id":"paths/~1paypal~1refund/post/responses/200/content/application~1json/example"},"paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~13dsecure~1standalone/post/responses/504/content/application~1json/example"},"paths/~13dsecure~1completion/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2022-05-04T09:20:04.487-07:00","transaction":{"invoice":"730518"},"threeDSecure":{"trxId":"a7bbd49a-ffe6-49b2-8a92-541f0a3b053d","compInd":"Y"}},"id":"paths/~13dsecure~1completion/post/requestBody/content/application~1json/example"},"paths/~13dsecure~1completion/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~13dsecure~1completion/post/responses/504/content/application~1json/example"},"paths/~1oct~1payout/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2021-04-15T09:18:23.283-07:00","amount":{"total":160},"card":{"number":"XXXXXXXXXXXX1119","type":"VS","token":{"value":"8048471746471119"}},"customer":{"firstName":"John","lastName":"Smith","emailAddress":"johnsmith@email.com","ipAddress":"63.57.84.101"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"TM01CE"},"transaction":{"authSource":"A","invoice":"192029","responseCode":"A","retrievalReference":"ICTN-178768-233-79170-FUX"}}]},"id":"paths/~1oct~1payout/post/responses/200/content/application~1json/example"},"paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example":{"value":{"dateTime":"2021-04-15T09:18:23.283-07:00","sourceIp":"63.57.84.101","customer":{"emailAddress":"oldaddress@email.com","newEmailAddress":"newaddress@email.com"}},"id":"paths/~1oct~1updaterecipient/post/requestBody/content/application~1json/example"},"paths/~1ach~1sale/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"ach":{"balanceVerificationResult":"VS"},"transaction":{"authSource":"A","invoice":"192029","responseCode":"P"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}]},"id":"paths/~1ach~1sale/post/responses/200/content/application~1json/example"},"paths/~1ach~1refund/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","invoice":"192030","originalInvoice":"192029","responseCode":"P"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}]},"id":"paths/~1ach~1refund/post/responses/200/content/application~1json/example"},"paths/~1ach~1status/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","amount":{"total":135.87},"merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","type":"S","invoice":"192029","responseCode":"P"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}]},"id":"paths/~1ach~1status/post/responses/200/content/application~1json/example"},"paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","responseCode":"S"},"plaid":{"link_token":"link-sandbox-bea285c1-ad79-4191-8d1b-aaf537f7df59","expiration":"2023-02-13T21:00:25Z","client_user_id":"ae1a59fe-8646-4637-bbb8-d270856c508c"},"server":{"name":"TM01CE"}}]},"id":"paths/~1ach~1plaid~1link_token~1create/post/responses/200/content/application~1json/example"},"paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2023-02-08T09:18:23.283-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"transaction":{"authSource":"A","responseCode":"A"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","ach":{"accountLastFour":"7890"},"token":{"value":"9829283019231234","type":"ACH"},"server":{"name":"TM01CE"}}]},"id":"paths/~1ach~1plaid~1public_token~1exchange/post/responses/200/content/application~1json/example"},"paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2024-07-09T09:18:23.283-07:00","amount":{"total":160},"card":{"number":"XXXXXXXXXXXX1119","token":{"value":"8048471746471119"}},"dcc":{"rateTimeStamp":"2024-07-09T09:18:25.875-07:00","currencyCode":"CAD","foreignAmount":180.23,"conversionRate":"1.35","marginPercentage":"9.73","currencyMinorUnits":2,"transactionId":"1A2820D2G334","diffOverEcb":"2.85","displayUnit":2,"provider":"GLOBAL_BLUE","supportIndicator":"0"},"server":{"name":"TM01CE"}}]},"id":"paths/~1dcc~1ratelookup/post/responses/200/content/application~1json/example"},"paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1dcc~1ratelookup/post/responses/504/content/application~1json/example"},"paths/~1rule~1verify/post/responses/200/content/application~1json/example":{"value":{"result":[{"dateTime":"2024-05-21T09:18:23.283-07:00","amount":{"total":163.2,"surcharge":3.2},"card":{"number":"XXXXXXXXXXXX1119","token":{"value":"8048471746471119"},"type":"VS"},"surcharge":{"result":"P","transactionId":"string","percentage":2},"transaction":{"invoice":"0510093358","vendorReference":"12382-01"},"merchant":{"mid":15877,"name":"Merchant XYZ"},"server":{"name":"TM01CE"}}]},"id":"paths/~1rule~1verify/post/responses/200/content/application~1json/example"},"paths/~1rule~1verify/post/responses/504/content/application~1json/example":{"value":{"result":[{"error":{"primaryCode":9951,"secondaryCode":0,"shortText":"RESPONSE TIMEOUT","longText":"Timeout waiting for response across the internet"},"lighthouse":{"data":"eyJwYXltZW50SWQiOiI4NWM0MWNhNy01NzVjLTQzNGUtODIyZi0xYzZlOTE0ZDAzODYiLCJyZW1haW5pbmdBbW91bnQiOjB9"},"server":{"name":"U2API01CE"}}]},"id":"paths/~1rule~1verify/post/responses/504/content/application~1json/example"}},"securitySchemeStore":{"AccessToken":{"id":"AccessToken","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security credential used to authenticate API requests and all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"i4Go®"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"AccessToken: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D\n"},"children":[]}]}],"in":"header","paramName":"AccessToken"},"HMAC-SHA256":{"id":"HMAC-SHA256","type":"http","scheme":"hmac-sha256","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication using HMAC-256 signatures as the authorization scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in the following format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC-SHA256"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Credential"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"={value}&"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"={value}"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Argument"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC-SHA256"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization scheme."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credential"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the key used to compute the signature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64 encoded HMACSHA256 value."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: HMAC-SHA256 Credential=AESKEY1&Signature=8SFtIc6zQlswxAZqDKXL+BpRmlDvIWyjOwU8wdl0zK4=\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: HMAC-SHA256 Credential=AESKEY1&Signature=8SFtIc6zQlswxAZqDKXL+BpRmlDvIWyjOwU8wdl0zK4=\n"},"children":[]}]}]}},"servers":[{"url":"https://api.shift4test.com/api/rest/v1","description":"Host Direct Test URL"},{"url":"https://api.shift4api.net/api/rest/v1","description":"Host Direct Production URL"}]},"options":{"hideSchemaTitles":true,"sortRequiredPropsFirst":true,"jsonSamplesExpandLevel":4,"hideDownloadButtons":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/payments-platform-rest/openapi.json?download"},{"url":"/_bundle/apis/payments-platform-rest/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shift4 Payment API"}},"baseSlug":"/apis/payments-platform-rest/openapi","routesMapping":{}}