Getting Started

Learn the basics of using our APIs

The Asyncpay API lets you easily accept payments, send payouts, manage subscriptions, and work with different payment channels from one place. It uses a RESTful structure, with clear endpoints grouped by what they do.

Before you start

The first step to using the Asyncpay API is to create an Asyncpay account, set up a business, and connect one or more test payment channels to it through the dashboard.

Asyncpay provides test credentials for every payment channel we support. Once your test setup is complete, you can find your test secret key on the dashboard and use it to start making requests to our API.

Base URL

The base URL for all our endpoints is https://api.asyncpay.io.

Throughout the documentation, we reference endpoints with the relative URLs, so where we reference an endpoint as /v1/customers , it means in you would access it as https://api.asyncpay.io/v1/customers .

Our base URL is https://asyncpay.io

HTTP Methods

Method	Description
POST	Used to create a new resource on the server
GET	Used to fetch resources from the server
DELETE	Deletes a specified resource
PATCH	Used to modify the state of a resource, typically without any request body
PUT	Used to update an existing resource

Request and Response

The requests and responses for Asyncpay's APIs are formatted as JSON, with a few exceptions where we might expect multipart/form-data. All our responses will always be in JSON (application/json). Our responses will generally follow this format:

Response Format

{
    "status" "[string]",
    "message": "[string]",
    "data": "[object]"

}

Successful Response Structure

Field	Type	Description
status	string	Indicates the outcome of the request. You will receive either "success" or "failed".
message	string	A short summary describing what the server did in response to the request.
data	object or array	The main content of the response. This may be a single object or an array, depending on the request—such as a resource that was retrieved, created, updated, or deleted.

Errors

In the event of an error we provide additional fields in the response to help you pinpoint errors. You can read more about errors on the Errors section