{"items":[{"type":"link","fsPath":"docs/api/index.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/docs/api","routeSlug":"/docs/api"},{"type":"link","label":"Shift4 Gateway API","link":"/docs/api/shift4-gateway","routeSlug":"/docs/api/shift4-gateway"},{"type":"link","label":"Base URL","link":"/docs/api/shift4-gateway/section/base-url","routeSlug":"/docs/api/shift4-gateway/section/base-url"},{"type":"link","label":"Authentication","link":"/docs/api/shift4-gateway/section/authentication","routeSlug":"/docs/api/shift4-gateway/section/authentication"},{"type":"group","label":"Charges","link":"/docs/api/shift4-gateway/charges","routeSlug":"/docs/api/shift4-gateway/charges","items":[{"label":"Create a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/createcharge","routeSlug":"/docs/api/shift4-gateway/charges/createcharge","metadata":{"seo":{"title":"Create a charge","description":"Creates a new charge. To charge a credit card, you create a charge object. If your API key is in test mode, the supplied payment source (e.g., card token) won't actually be charged, although everything else will occur as if in live mode."}},"httpPath":"/charges"},{"label":"List charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/listcharges","routeSlug":"/docs/api/shift4-gateway/charges/listcharges","metadata":{"seo":{"title":"List charges","description":"Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first."}},"httpPath":"/charges"},{"label":"Retrieve a charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/getcharge","routeSlug":"/docs/api/shift4-gateway/charges/getcharge","metadata":{"seo":{"title":"Retrieve a charge","description":"Retrieves the details of a charge that has previously been created."}},"httpPath":"/charges/{chargeId}"},{"label":"Update a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/updatecharge","routeSlug":"/docs/api/shift4-gateway/charges/updatecharge","metadata":{"seo":{"title":"Update a charge","description":"Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged."}},"httpPath":"/charges/{chargeId}"},{"label":"Capture a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/capturecharge","routeSlug":"/docs/api/shift4-gateway/charges/capturecharge","metadata":{"seo":{"title":"Capture a charge","description":"Captures a previously uncaptured charge. This is the second step of a two-step payment flow (authorize then capture). Charges must be captured within 5 days of authorization."}},"httpPath":"/charges/{chargeId}/capture"},{"label":"Increment an authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/incrementalauthorization","routeSlug":"/docs/api/shift4-gateway/charges/incrementalauthorization","metadata":{"seo":{"title":"Increment an authorization","description":"Increments the amount of a pre-authorized charge. To be able to increment an authorization, the charge must be created with captured=false and options.authorizationType=pre."}},"httpPath":"/charges/{chargeId}/incremental-authorization"}]},{"type":"group","label":"Refunds","link":"/docs/api/shift4-gateway/refunds","routeSlug":"/docs/api/shift4-gateway/refunds","items":[{"label":"Refund a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/createrefund","routeSlug":"/docs/api/shift4-gateway/refunds/createrefund","metadata":{"seo":{"title":"Refund a charge","description":"Refund an existing charge, which will result in funds being returned to the previously charged credit or debit card."}},"httpPath":"/refunds"},{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/listrefunds","routeSlug":"/docs/api/shift4-gateway/refunds/listrefunds","metadata":{"seo":{"title":"List refunds","description":"List refund objects for a given charge. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/refunds"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/getrefund","routeSlug":"/docs/api/shift4-gateway/refunds/getrefund","metadata":{"seo":{"title":"Retrieve a refund","description":"Retrieves an existing refund object."}},"httpPath":"/refunds/{refundId}"},{"label":"Update a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/updaterefund","routeSlug":"/docs/api/shift4-gateway/refunds/updaterefund","metadata":{"seo":{"title":"Update a refund","description":"Updates an existing refund object. Any parameters not provided are left unchanged."}},"httpPath":"/refunds/{refundId}"}]},{"type":"group","label":"Customers","link":"/docs/api/shift4-gateway/customers","routeSlug":"/docs/api/shift4-gateway/customers","items":[{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/createcustomer","routeSlug":"/docs/api/shift4-gateway/customers/createcustomer","metadata":{"seo":{"title":"Create a customer","description":"Creates a new customer object. You can attach a card to the customer so it can be reused for recurring charges."}},"httpPath":"/customers"},{"label":"List customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/listcustomers","routeSlug":"/docs/api/shift4-gateway/customers/listcustomers","metadata":{"seo":{"title":"List customers","description":"Returns a list of customers. The customers are returned in sorted order, with the most recently created appearing first."}},"httpPath":"/customers"},{"label":"Retrieve a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/getcustomer","routeSlug":"/docs/api/shift4-gateway/customers/getcustomer","metadata":{"seo":{"title":"Retrieve a customer","description":"Retrieves the details of an existing customer."}},"httpPath":"/customers/{customerId}"},{"label":"Update a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/updatecustomer","routeSlug":"/docs/api/shift4-gateway/customers/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged."}},"httpPath":"/customers/{customerId}"},{"label":"Delete a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/deletecustomer","routeSlug":"/docs/api/shift4-gateway/customers/deletecustomer","metadata":{"seo":{"title":"Delete a customer","description":"Deletes an existing customer object."}},"httpPath":"/customers/{customerId}"}]},{"type":"group","label":"Cards","link":"/docs/api/shift4-gateway/cards","routeSlug":"/docs/api/shift4-gateway/cards","items":[{"label":"Create a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/createcard","routeSlug":"/docs/api/shift4-gateway/cards/createcard","metadata":{"seo":{"title":"Create a card","description":"Adds a new card to an existing customer."}},"httpPath":"/customers/{customerId}/cards"},{"label":"List cards for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/listcards","routeSlug":"/docs/api/shift4-gateway/cards/listcards","metadata":{"seo":{"title":"List cards for a customer","description":"Returns a list of cards belonging to a customer. The cards are returned in sorted order, with the most recently created appearing first."}},"httpPath":"/customers/{customerId}/cards"},{"label":"Retrieve a card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/getcard","routeSlug":"/docs/api/shift4-gateway/cards/getcard","metadata":{"seo":{"title":"Retrieve a card","description":"Retrieves the details of a card that belongs to a customer."}},"httpPath":"/customers/{customerId}/cards/{cardId}"},{"label":"Update a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/updatecard","routeSlug":"/docs/api/shift4-gateway/cards/updatecard","metadata":{"seo":{"title":"Update a card","description":"Updates the specified card. Any parameters not provided are left unchanged."}},"httpPath":"/customers/{customerId}/cards/{cardId}"},{"label":"Delete a card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/deletecard","routeSlug":"/docs/api/shift4-gateway/cards/deletecard","metadata":{"seo":{"title":"Delete a card","description":"Deletes an existing card object."}},"httpPath":"/customers/{customerId}/cards/{cardId}"}]},{"type":"group","label":"Payment Methods","link":"/docs/api/shift4-gateway/payment-methods","routeSlug":"/docs/api/shift4-gateway/payment-methods","items":[{"label":"Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod","metadata":{"seo":{"title":"Create a payment method","description":"Creates a new payment method for alternative payment types."}},"httpPath":"/payment-methods"},{"label":"List payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/listpaymentmethods","routeSlug":"/docs/api/shift4-gateway/payment-methods/listpaymentmethods","metadata":{"seo":{"title":"List payment methods","description":"List payment methods"}},"httpPath":"/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieve a payment method"}},"httpPath":"/payment-methods/{paymentMethodId}"},{"label":"Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/deletepaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/deletepaymentmethod","metadata":{"seo":{"title":"Delete a payment method","description":"Delete a payment method"}},"httpPath":"/payment-methods/{paymentMethodId}"}]},{"type":"group","label":"Subscriptions","link":"/docs/api/shift4-gateway/subscriptions","routeSlug":"/docs/api/shift4-gateway/subscriptions","items":[{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/createsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Creates a new subscription object. The subscription is billed to the customer's current default card."}},"httpPath":"/subscriptions"},{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/listsubscriptions","routeSlug":"/docs/api/shift4-gateway/subscriptions/listsubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Lists subscription objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/getsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/getsubscription","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieves an existing subscription object."}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/updatesubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update a subscription","description":"Updates an existing subscription object. Any parameters not provided are left unchanged."}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/cancelsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels an existing subscription."}},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"List subscription charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/listsubscriptioncharges","routeSlug":"/docs/api/shift4-gateway/subscriptions/listsubscriptioncharges","metadata":{"seo":{"title":"List subscription charges","description":"Lists the charge attempts made by a subscription, including automatic renewals (rebills) and failed attempts. Results are sorted with the most recent records first."}},"httpPath":"/subscriptions/{subscriptionId}/charges"}]},{"type":"group","label":"Plans","link":"/docs/api/shift4-gateway/plans","routeSlug":"/docs/api/shift4-gateway/plans","items":[{"label":"Create a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/createplan","routeSlug":"/docs/api/shift4-gateway/plans/createplan","metadata":{"seo":{"title":"Create a plan","description":"Creates a new plan object."}},"httpPath":"/plans"},{"label":"List plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/listplans","routeSlug":"/docs/api/shift4-gateway/plans/listplans","metadata":{"seo":{"title":"List plans","description":"Lists plan objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/plans"},{"label":"Retrieve a plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/getplan","routeSlug":"/docs/api/shift4-gateway/plans/getplan","metadata":{"seo":{"title":"Retrieve a plan","description":"Retrieves an existing plan object."}},"httpPath":"/plans/{planId}"},{"label":"Update a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/updateplan","routeSlug":"/docs/api/shift4-gateway/plans/updateplan","metadata":{"seo":{"title":"Update a plan","description":"Updates an existing plan object. Any parameters not provided are left unchanged."}},"httpPath":"/plans/{planId}"},{"label":"Delete a plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/deleteplan","routeSlug":"/docs/api/shift4-gateway/plans/deleteplan","metadata":{"seo":{"title":"Delete a plan","description":"Deletes an existing plan object."}},"httpPath":"/plans/{planId}"}]},{"type":"group","label":"Events","link":"/docs/api/shift4-gateway/events","routeSlug":"/docs/api/shift4-gateway/events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/events/listevents","routeSlug":"/docs/api/shift4-gateway/events/listevents","metadata":{"seo":{"title":"List events","description":"List event objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/events"},{"label":"Retrieve an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/events/getevent","routeSlug":"/docs/api/shift4-gateway/events/getevent","metadata":{"seo":{"title":"Retrieve an event","description":"Retrieves an existing event object."}},"httpPath":"/events/{eventId}"}]},{"type":"group","label":"Tokens","link":"/docs/api/shift4-gateway/tokens","routeSlug":"/docs/api/shift4-gateway/tokens","items":[{"label":"Create a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/createtoken","routeSlug":"/docs/api/shift4-gateway/tokens/createtoken","metadata":{"seo":{"title":"Create a token","description":"Creates a new token object. This method can be called with either your API public key or your API secret key."}},"httpPath":"/tokens"},{"label":"Retrieve a token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/gettoken","routeSlug":"/docs/api/shift4-gateway/tokens/gettoken","metadata":{"seo":{"title":"Retrieve a token","description":"Retrieves an existing token object."}},"httpPath":"/tokens/{tokenId}"},{"label":"Initialize 3D Secure process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/initializethreedsecure","routeSlug":"/docs/api/shift4-gateway/tokens/initializethreedsecure","metadata":{"seo":{"title":"Initialize 3D Secure process","description":"Initializes a new 3D Secure authentication process."}},"httpPath":"/3d-secure"}]},{"type":"group","label":"Blacklist","link":"/docs/api/shift4-gateway/blacklist","routeSlug":"/docs/api/shift4-gateway/blacklist","items":[{"label":"Create a blacklist rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/createblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/createblacklistrule","metadata":{"seo":{"title":"Create a blacklist rule","description":"Creates a new blacklist rule object."}},"httpPath":"/blacklist"},{"label":"List blacklist rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/listblacklistrules","routeSlug":"/docs/api/shift4-gateway/blacklist/listblacklistrules","metadata":{"seo":{"title":"List blacklist rules","description":"Lists blacklist rule objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/blacklist"},{"label":"Retrieve a blacklist rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/getblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/getblacklistrule","metadata":{"seo":{"title":"Retrieve a blacklist rule","description":"Retrieves an existing blacklist rule object."}},"httpPath":"/blacklist/{blacklistRuleId}"},{"label":"Delete a blacklist rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/deleteblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/deleteblacklistrule","metadata":{"seo":{"title":"Delete a blacklist rule","description":"Deletes an existing blacklist rule object."}},"httpPath":"/blacklist/{blacklistRuleId}"}]},{"type":"group","label":"Credits","link":"/docs/api/shift4-gateway/credits","routeSlug":"/docs/api/shift4-gateway/credits","items":[{"label":"Create a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/createcredit","routeSlug":"/docs/api/shift4-gateway/credits/createcredit","metadata":{"seo":{"title":"Create a credit","description":"Creates a new credit object. A credit represents funds transferred to a card. Either customerId or card must be provided."}},"httpPath":"/credits"},{"label":"List credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/listcredits","routeSlug":"/docs/api/shift4-gateway/credits/listcredits","metadata":{"seo":{"title":"List credits","description":"List credit objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/credits"},{"label":"Retrieve a credit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/getcredit","routeSlug":"/docs/api/shift4-gateway/credits/getcredit","metadata":{"seo":{"title":"Retrieve a credit","description":"Retrieves an existing credit object."}},"httpPath":"/credits/{creditId}"},{"label":"Update a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/updatecredit","routeSlug":"/docs/api/shift4-gateway/credits/updatecredit","metadata":{"seo":{"title":"Update a credit","description":"Updates an existing credit object. Any parameters not provided are left unchanged."}},"httpPath":"/credits/{creditId}"}]},{"type":"group","label":"Disputes","link":"/docs/api/shift4-gateway/disputes","routeSlug":"/docs/api/shift4-gateway/disputes","items":[{"label":"List disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/listdisputes","routeSlug":"/docs/api/shift4-gateway/disputes/listdisputes","metadata":{"seo":{"title":"List disputes","description":"Lists dispute objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/disputes"},{"label":"Retrieve a dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/getdispute","routeSlug":"/docs/api/shift4-gateway/disputes/getdispute","metadata":{"seo":{"title":"Retrieve a dispute","description":"Retrieves an existing dispute object."}},"httpPath":"/disputes/{disputeId}"},{"label":"Update a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/updatedispute","routeSlug":"/docs/api/shift4-gateway/disputes/updatedispute","metadata":{"seo":{"title":"Update a dispute","description":"Updates an existing dispute object. Any parameters not provided are left unchanged."}},"httpPath":"/disputes/{disputeId}"},{"label":"Close a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/closedispute","routeSlug":"/docs/api/shift4-gateway/disputes/closedispute","metadata":{"seo":{"title":"Close a dispute","description":"Closing the dispute indicates that you do not want to submit any further evidence and acknowledge it as lost."}},"httpPath":"/disputes/{disputeId}/close"}]},{"type":"group","label":"File Uploads","link":"/docs/api/shift4-gateway/file-uploads","routeSlug":"/docs/api/shift4-gateway/file-uploads","items":[{"label":"Create a file upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/createfileupload","routeSlug":"/docs/api/shift4-gateway/file-uploads/createfileupload","metadata":{"seo":{"title":"Create a file upload","description":"Creates a new file upload object. A successful request returns a file upload object that represents the uploaded file."}},"httpPath":"/files"},{"label":"List file uploads","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/listfileuploads","routeSlug":"/docs/api/shift4-gateway/file-uploads/listfileuploads","metadata":{"seo":{"title":"List file uploads","description":"Lists file upload objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/files"},{"label":"Retrieve a file upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/getfileupload","routeSlug":"/docs/api/shift4-gateway/file-uploads/getfileupload","metadata":{"seo":{"title":"Retrieve a file upload","description":"Retrieves an existing file upload object."}},"httpPath":"/files/{fileUploadId}"}]},{"type":"group","label":"Fraud Warnings","link":"/docs/api/shift4-gateway/fraud-warnings","routeSlug":"/docs/api/shift4-gateway/fraud-warnings","items":[{"label":"List fraud warnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/fraud-warnings/listfraudwarnings","routeSlug":"/docs/api/shift4-gateway/fraud-warnings/listfraudwarnings","metadata":{"seo":{"title":"List fraud warnings","description":"Lists fraud warning objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/fraud-warnings"},{"label":"Retrieve a fraud warning","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning","routeSlug":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning","metadata":{"seo":{"title":"Retrieve a fraud warning","description":"Retrieves an existing fraud warning object."}},"httpPath":"/fraud-warnings/{fraudWarningId}"}]},{"type":"group","label":"Payouts","link":"/docs/api/shift4-gateway/payouts","routeSlug":"/docs/api/shift4-gateway/payouts","items":[{"label":"List payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/listpayouts","routeSlug":"/docs/api/shift4-gateway/payouts/listpayouts","metadata":{"seo":{"title":"List payouts","description":"Lists payout objects. Results are sorted by payout date, with the most recent objects first."}},"httpPath":"/payouts"},{"label":"Create a test payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/createtestpayout","routeSlug":"/docs/api/shift4-gateway/payouts/createtestpayout","metadata":{"seo":{"title":"Create a test payout","description":"Creates a test payout based on test mode charges, refunds, chargebacks and credits. This endpoint takes no parameters and is only available when using a test API key."}},"httpPath":"/payouts"},{"label":"Retrieve a payout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/getpayout","routeSlug":"/docs/api/shift4-gateway/payouts/getpayout","metadata":{"seo":{"title":"Retrieve a payout","description":"Retrieves an existing payout object."}},"httpPath":"/payouts/{payoutId}"},{"label":"List payout transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/listpayouttransactions","routeSlug":"/docs/api/shift4-gateway/payouts/listpayouttransactions","metadata":{"seo":{"title":"List payout transactions","description":"Lists payout transaction objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/payout-transactions"}]},{"type":"group","label":"Checkout","link":"/docs/api/shift4-gateway/checkout","routeSlug":"/docs/api/shift4-gateway/checkout","items":[{"label":"Create a checkout session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/createcheckoutsession","routeSlug":"/docs/api/shift4-gateway/checkout/createcheckoutsession","metadata":{"seo":{"title":"Create a checkout session","description":"Creates a new checkout session. Sessions must be created using a secret API key. Pass the returned clientSecret to the checkout.js script to render the payment form, or use the returned url for the Checkout redirect flow."}},"httpPath":"/checkout-sessions"},{"label":"List checkout sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/listcheckoutsessions","routeSlug":"/docs/api/shift4-gateway/checkout/listcheckoutsessions","metadata":{"seo":{"title":"List checkout sessions","description":"Lists checkout session objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/checkout-sessions"},{"label":"Retrieve a checkout session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/getcheckoutsession","routeSlug":"/docs/api/shift4-gateway/checkout/getcheckoutsession","metadata":{"seo":{"title":"Retrieve a checkout session","description":"Retrieves an existing checkout session object."}},"httpPath":"/checkout-sessions/{checkoutSessionId}"}]},{"type":"group","label":"Payment Links","link":"/docs/api/shift4-gateway/payment-links","routeSlug":"/docs/api/shift4-gateway/payment-links","items":[{"label":"Create a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/createpaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/createpaymentlink","metadata":{"seo":{"title":"Create a payment link","description":"Creates a new payment link. Every new payment link is active by default. An optional failed-payment limit can be set only at creation."}},"httpPath":"/payment-links"},{"label":"List payment links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/listpaymentlinks","routeSlug":"/docs/api/shift4-gateway/payment-links/listpaymentlinks","metadata":{"seo":{"title":"List payment links","description":"Lists payment link objects. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/payment-links"},{"label":"Retrieve a payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/getpaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/getpaymentlink","metadata":{"seo":{"title":"Retrieve a payment link","description":"Retrieves an existing payment link object."}},"httpPath":"/payment-links/{paymentLinkId}"},{"label":"Update a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/updatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/updatepaymentlink","metadata":{"seo":{"title":"Update a payment link","description":"Updates an existing payment link. Attributes not provided in the request are left unchanged."}},"httpPath":"/payment-links/{paymentLinkId}"},{"label":"Deactivate a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/deactivatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/deactivatepaymentlink","metadata":{"seo":{"title":"Deactivate a payment link","description":"Deactivates an existing payment link. Every new payment link is active by default. Payment links with a limited number of charges are deactivated automatically the moment the limit is reached."}},"httpPath":"/payment-links/{paymentLinkId}/deactivate"},{"label":"Reactivate a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/reactivatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/reactivatepaymentlink","metadata":{"seo":{"title":"Reactivate a payment link","description":"Reactivates a deactivated payment link. A payment link cannot be reactivated once its limit of successful charges or failed payment attempts has been reached."}},"httpPath":"/payment-links/{paymentLinkId}/reactivate"},{"label":"List charges related to a payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/listpaymentlinkcharges","routeSlug":"/docs/api/shift4-gateway/payment-links/listpaymentlinkcharges","metadata":{"seo":{"title":"List charges related to a payment link","description":"Lists the charges made through a given payment link. Results are sorted by creation date, with the most recent objects first."}},"httpPath":"/payment-links/{paymentLinkId}/charges"}]},{"type":"group","label":"Testing","link":"/docs/api/shift4-gateway/testing","routeSlug":"/docs/api/shift4-gateway/testing","items":[{"label":"Resolve status of a pending charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/testing/resolvechargestatus","routeSlug":"/docs/api/shift4-gateway/testing/resolvechargestatus","metadata":{"seo":{"title":"Resolve status of a pending charge","description":"Resolves the status of a pending charge programmatically."}},"httpPath":"/charges/{clientChargeId}"}]}]}