{"items":[{"type":"link","label":"Shift4 Payment API","link":"/apis/payments-platform-rest/openapi","routeSlug":"/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."}},"httpPath":"/credentials/accesstoken"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/transactions/signature"}]},{"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."}},"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."}},"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."}},"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."}},"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)."}},"httpPath":"/tokens/4words"}]},{"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."}},"httpPath":"/merchants/merchant"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/giftcards/cashout"}]},{"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."}},"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."}},"httpPath":"/cards/identify"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/devices/prompttip"}]},{"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."}},"httpPath":"/reports/batchtotals"}]},{"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."}},"httpPath":"/batches/submit"}]},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/qrpayments/cancelqrpayment"}]},{"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."}},"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."}},"httpPath":"/mode/online"}]},{"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."}},"httpPath":"/risk/assess"}]},{"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."}},"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."}},"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."}},"httpPath":"/paypal/refund"}]},{"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."}},"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."}},"httpPath":"/3dsecure/completion"}]},{"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."}},"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."}},"httpPath":"/oct/updaterecipient"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/ach/plaid/public_token/exchange"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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."}},"httpPath":"ach-notification"}]},{"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."}},"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."}},"httpPath":"/updater/status"}]},{"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."}},"httpPath":"/dcc/ratelookup"}]},{"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."}},"httpPath":"/rule/verify"}]},{"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"}},"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"}},"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"}},"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."}},"httpPath":"/paymentlinks/update"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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."}},"httpPath":"paymentlinks-notification"}]},{"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."}},"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."}},"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."}},"httpPath":"/checkoutsessions/retrieve"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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."}},"httpPath":"checkoutsessions-notification"}]}]}