myPOS Checkout API Overview

These are the actions your system can initiate:

API Requests

API CallDescription
PurchaseStandard checkout. Can store card data. Uses myPOS Checkout page (customer interaction required).
In-App PurchaseAccept payments directly inside apps/websites. No redirection.
In-App StoreCardStore card data directly from app (non-redirect flow).
In-App Stored Card UpdateUpdate previously stored card details.
RefundRefund a customer. No customer interaction needed.
Request MoneyPull funds from a myPOS account. No customer interaction.
Mandate ManagementManage mandates for recurring Request Money actions.
Get Payment StatusRetrieve status of a payment.
Send MoneySend funds to another myPOS account.
PreAuthorizationReserve funds via myPOS Checkout (customer interaction).
In-App PreAuthorizationReserve funds directly via app (non-redirect).
PreAuth CompletionCapture funds from pre-authorization.
PreAuth CancellationCancel a pre-authorization.
PreAuth StatusCheck the status of a pre-authorization.
AuthorizationAuthorize an amount using a stored card.
Authorization CaptureCapture authorized funds.
Authorization ReverseRelease (void) authorized funds.
Authorization ListView uncaptured/active authorizations.

API Callbacks

API CallDescription
Purchase NotifyServer-to-server notify callback after successful purchase. Sent to URL_Notify.
Purchase OKRedirects customer to URL_OK on success.
Purchase CancelRedirects customer to URL_Cancel if purchase is canceled.
Purchase RollbackNotifies you of a reversal when notify callback fails.
PreAuthorization NotifyServer-to-server notification after a successful pre-authorization. Sent to your endpoint.
PreAuthorization OKRedirects the customer to your success URL after pre-authorization.
PreAuthorization CancelRedirects the customer to your cancel URL if pre-authorization is canceled.