Getting Started
How to integrate and authenticate with the Pay.so Core service.
Overview
Below is a step-by-step overview on how to register a user and complete their first crypto-to-fiat payment.
Collect user details and create the User object in Core. Have them sign the usage agreement.
Create a KYC Session and ask the user to follow and complete the onboarding URL.
Wait for a webhook to arrive confirming the user has been approved.
Collect the details of the recipient bank account and create a Payment Detail object.
Request a Quote with the desired input or output amounts to retrieve the corresponding input or output values, and deposit addresses to transfer the input crypto to.
Create Offramp objects that tell us where we should send funds to once your Quote is executed.
Execute your Quote to begin the fiat processing.
Await webhook with updates regarding the progress of each Offramp.
Base URL
The base URL is where our API is hosted. While you are developing we recommend using our sandbox (staging) domain before switching onto production. Throughout our documentation it will be referred to as {{base_url}}
Sandbox Base URL
https://core-api-staging.pay.so
Production Base URL
https://core-api.pay.so
Postman
We can offer a Postman collection bespoke to your organisation upon request. It will contain all the API requests listed in these docs along with inbuilt Authentication with your API key.
Last updated