The Mobile Payments API enables mobile payment solution providers to integrate with SkyTab POS systems. Retrieve checks by order number, process payment transactions, and register payments to checks seamlessly.

Getting started

The Mobile Payments API is designed for mobile payment solution providers who need to process payments through POS systems. First, retrieve checks using order numbers, then execute payment transactions using access tokens obtained through the Auth Token process. All endpoints require HMAC-SHA256 authentication.

Core concepts

Check Retrieval

Query checks by order number to find the appropriate check for payment. The API returns a list of checks matching the provided order number, including check details, items, totals, and payment status.

Payment Processing

Execute payment transactions using access tokens obtained via the Auth Token Exchange Flow. Payment transactions are processed through the i4go gateway with the merchant's payment processor.

Payment Registration

After successfully processing a payment, register the payment data to the specific check in the POS system. The API returns the payment identifier and any remaining balance due on the check.

Payment Flow

The typical mobile payment flow follows these steps:

1. Retrieve Check - Query checks by order number to find the check requiring payment
2. Process Payment - Execute a payment transaction using an access token
3. Register Payment - Associate the payment with the specific check
4. Confirm Completion - Verify payment was registered and check balance updated

Access Tokens

Mobile payment processing requires valid access tokens obtained through the Auth Token exchange process. Access tokens authenticate payment requests to the i4go gateway and associate payments with the correct merchant account.