Skip to main content

Platly API Docs

This is the reference for the end-user API — the surface a client application uses on behalf of the person sending money. It is the same API our own web and mobile apps are built on.

It is for you if you are building your own application against Platly rather than using the apps we ship. It does not cover back-office or staff operations.

How this is organised​

  • Getting Started — the things you cannot work out from the schema: how requests are authenticated, how the API key and device binding work, what errors look like, and what the rate limits actually are. Read this first.
  • Integration Guides — one page per flow, in the order you will implement them, each with the real call sequence from registration through to a completed transfer.
  • API Reference — generated from the schema itself, so it is never out of date with what the server serves.

The endpoint​

Every operation in these docs is a POST to a single GraphQL endpoint:

POST https://<your-platly-host>/api/graphql
Content-Type: application/json

Your host is specific to your deployment and is issued to you along with your API key. Examples in these docs always show it as <your-platly-host> — there is no shared public endpoint.

Before you start​

Introspection is disabled, so GraphiQL, graphql-codegen, Apollo tooling, IDE plugins and Postman's GraphQL mode cannot read the schema from the live endpoint. Download the SDL instead — the Download SDL link in the header gives you the same schema this reference is generated from, and every one of those tools accepts a local file.