Quick Start

Step by step

Follow these steps and you will have a working payment link in minutes:

1

Generate an API Key

Log in to the Partner Dashboard and go to Team Preferences > API Keys. Create a new key to identify your integration.

API Key

2

Authenticate via OAuth 2.0

Use the API Key to obtain an access token using the client credentials grant type.

OAuth Authentication

3

Create a payment request

Use your access token to create a new payment request with the desired amount, currency, and redirect URL.

Create a payment request

4

Check payment status

Poll the API to retrieve the current status of the payment.

Retrieve a Payment Request


🧰 Environments & Base URLs

Environment
Base URL

Production (default)

https://public-api.alternativepayments.io

Demo

https://public-api.demo.alternativepayments.io

All examples in this guide use production URLs. Switch to the demo when you test. Tokens and requests are isolated per environment.

Caution

API Versioning

Last updated

Was this helpful?