Endpoints

We offer a range of HTTP Endpoints to create and manage Accounts, Wallets, Trades, Payments, Webhooks and other objects.

POST requests are Idempotent if the header parameter is used. These expire after 24 hours.

Generally, request bodies are JSON objects and response bodies are JSON objects that can contain single objects or collections.

When you create a new object, the response will include unique identifiers for the object and relevant nested objects.

All POST endpoints have 1 or more associated GET endpoints to retrieve specific objects via their identifiers.

When an object is created, the response body will contain the data from the request body along with standard metadata which includes:

• status
• createdAt
• updatedAt

Endpoints that can return multiple objects (e.g. an array of Accounts), implement pagination and limited filtering.

You can subscribe to a range of events using Webhooks. After the status value of an object is changed, or a transaction created,
an event is raised and will be sent the URLs you have specified. See Webhooks page for a list of all possible events
(some may not be applicable to your agreement).

We also provide a sandbox endpoint for our non-production environments which you can use to simulate production-like scenarios such as creating a PayIn.

📘

Not Seeing What You're Looking For?

We are always looking to improve our API documentation to ensure Sends systems are easy to understand and quick to build against. If you're struggling to find the answer to a question we either haven't made it easy enough to find the relevant docs or we haven't had a chance to write something up for it yet.

Either way we want to hear from you!

Head over to our Discussion Board and leave us a note. We keep a close eye on this and want to ensure we make these docs as useful as they can be so will jump on any posts quickly.