myPOS Checkout API Overview
These are the actions your system can initiate:
API Requests
| API Call | Description |
|---|---|
| Purchase | Standard checkout. Can store card data. Uses myPOS Checkout page (customer interaction required). |
| In-App Purchase | Accept payments directly inside apps/websites. No redirection. |
| In-App StoreCard | Store card data directly from app (non-redirect flow). |
| In-App Stored Card Update | Update previously stored card details. |
| Refund | Refund a customer. No customer interaction needed. |
| Request Money | Pull funds from a myPOS account. No customer interaction. |
| Mandate Management | Manage mandates for recurring Request Money actions. |
| Get Payment Status | Retrieve status of a payment. |
| Send Money | Send funds to another myPOS account. |
| PreAuthorization | Reserve funds via myPOS Checkout (customer interaction). |
| In-App PreAuthorization | Reserve funds directly via app (non-redirect). |
| PreAuth Completion | Capture funds from pre-authorization. |
| PreAuth Cancellation | Cancel a pre-authorization. |
| PreAuth Status | Check the status of a pre-authorization. |
| Authorization | Authorize an amount using a stored card. |
| Authorization Capture | Capture authorized funds. |
| Authorization Reverse | Release (void) authorized funds. |
| Authorization List | View uncaptured/active authorizations. |
API Callbacks
| API Call | Description |
|---|---|
| Purchase Notify | Server-to-server notify callback after successful purchase. Sent to URL_Notify. |
| Purchase OK | Redirects customer to URL_OK on success. |
| Purchase Cancel | Redirects customer to URL_Cancel if purchase is canceled. |
| Purchase Rollback | Notifies you of a reversal when notify callback fails. |
| PreAuthorization Notify | Server-to-server notification after a successful pre-authorization. Sent to your endpoint. |
| PreAuthorization OK | Redirects the customer to your success URL after pre-authorization. |
| PreAuthorization Cancel | Redirects the customer to your cancel URL if pre-authorization is canceled. |