Welcome to the Shift4 API Guides! Below, you'll find a list of guides categorized to help you navigate through the different aspects of using the Shift4 API.
There are two fundamental ways that integrators can build an integration
- Option 1: SDK
- Shift4 can provide an SDK. The SDK simplifies and abstracts many of the complexities of the REST API. Currently the SDK is available using a .Net DLL. Support for additional languages are being added.
- For further information on the .Net SDK, see the following link: .Net SDK
- Shift4 can provide an SDK. The SDK simplifies and abstracts many of the complexities of the REST API. Currently the SDK is available using a .Net DLL. Support for additional languages are being added.
- Option 2: Direct integration
- You can do a direct integration to the REST API without using a library/SDK. Note that with this method, you’ll have to:
- Execute HTTP requests directly in your code
- Handle timeouts and boundary conditions that are abstracted in the SDK
- Handle logging and log masking
- You can do a direct integration to the REST API without using a library/SDK. Note that with this method, you’ll have to:
Start your journey with the Shift4 API by following our Quickstart guide. This guide will help you set up your environment and make your first request in minutes.
Explore the use of payment devices for card present transaction processing.
- UTG Controlled Devices
- Commerce Engine
- Required EMV Authorization Request Tags
- NFC/Contactless Payments
Explore the core concepts of the Shift4 Payment Platform API.
- Understanding Card Tokens
- Understading Invoices
- Capturing Sales
- Restaurant Authorization and Settlement Flow
- Using the Notes Field
- Processing Refund
- Printing Receipts
- P2PE Format
- Transaction Flow
- Understanding AVS and CSC Verification
- Timeouts and Communication Failures
- Handling Referral Responses
Once you're comfortable with the basics, dive into our advanced topics. These guides cover complex scenarios, including offline processing, split-tender transactions, partial approvals, card on file transactions, and preventing double charges.