API Guide
Log In
API Guide

Checkout

Calling Checkout with a valid pay run ID will return a URL that the user should be redirected to in order to initiate the payment process for the given pay run.

When calling this endpoint you are expected to provide completeUrl and incompleteUrl query parameters which will be used to redirect the user back to your system following the checkout process depending on whether all batch processing is complete or not. Regardless of the URL used webhooks and/or status endpoints should always be used to obtain most accurate status information.

Calling /checkout with a valid pay run ID will return a 302 redirect to the UI to allow a user to checkout

Supplying a completeURL and incompleteUrl

When calling this endpoint you are expected to provide completeUrl and incompleteUrl
query parameters which will be used to redirect the user back to your system following the checkout process depending on whether all batch processing is complete or not. Regardless of the URL used webhooks and/or status endpoints should always be used to obtain most accurate status information.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!