Aptean Pay integration guide¶
Everything you need to connect an application to Aptean Pay: what to decide before you write any code, how to call the API safely, and step-by-step guides for each way of taking money.
Aptean Pay has a GraphQL API for server-side work and a JavaScript SDK that collects card and bank details in the browser, so those details never touch your servers.
-
New to Aptean Pay?
Start with what to decide before you build, then get credentials and make your first call.
-
Take a payment in your own UI
Mount the Aptean Pay iFrame, get a token, then charge the card or bank account.
-
Send the customer an invoice
Raise a payment request. Aptean Pay emails or texts a link and the payer settles it.
-
Use an Aptean-hosted page
Create a checkout session and redirect. Aptean hosts the whole payment form.
How this guide is organised¶
| Section | Read it when |
|---|---|
| Getting started | Before you write code. Planning, choosing features, onboarding, environments and authentication. |
| Working with the API | Before you go live. Request and response shapes, idempotency, retries, and errors. |
| Payments | You hold the payment method: tokenise it, charge it, capture, void or refund it. |
| Payment requests | The payer holds the payment method: invoice them and let them pay. |
| Hosted checkout | You want no payment UI of your own. |
| Testing | You need card and bank numbers that work in staging. |
Three things worth knowing up front¶
Amounts are in minor units. An amount of 1250 is $12.50, not $1,250.00. This is the most
common integration mistake.
A successful call is not a successful payment. code: "SUCCESS" means Aptean Pay accepted
the instruction. Read payment.status to learn what happened to the money. See
Payment status.
There are no webhooks. Aptean Pay does not call your system when something changes. You read the state you care about. See Resilience and retries.