Get started

  1. Sign up to the Apaya Developer Portal to get access to our Sandbox environment. You'll be sent an email to verify your account.

  2. Sign in to the Developer Portal.

  3. Go to the Products area, click on Sandbox and configure your Sandbox 'subscription' .
    Note: Don't think of this as a subscription to a product or service. This is the process of configuring your access to the API.

  4. Provide a name for your Subscription, e.g. 'Sandbox connection' and click Subscribe. Don't worry, you can change the name later if needed.

  5. You'll be shown your User profile where you can access your API access key. You can always view the API key in the Profile area, and you don't need to note it down as it will always be pre-populated in the API view.

  6. Choose one of the flows below containing the flows and API calls to cater for your needs, it's that simple!

Picture

Single-purchase
Apaya Checkout

Send users to the Apaya Checkout to pay for their product/service, using a localised payment experience. Apaya manages payment and returns the end-user to your platform.

Find out more

Picture

Subscription
Apaya Checkout

Send users to the Apaya Checkout to subscribe to your service using their chosen localised payment option. Apaya will manage the billing and messaging during the user's subscription.

Find out more

Picture

User pre-authorisation
Consent Setup

Send users to the Apaya Consent Setup platform to gather the end-user's consent for future billing on your service via the Apaya API. Apaya stores consent and validates pre-billing.

Find out more.