Skip to main content
Make one read before you build anything. It confirms both credentials, the base URL and the version header in a single command, and it takes a second.
A 200 means everything is wired. If it is not, Authentication has the two failures you can get and what each one means. The endpoint, with every filter it accepts, is List users.

The shape of a response

Not every listing pages the same way. This one takes limit and offset and wraps the rows with a pagination object; others take a page number and put the counters at the top level. Read the shape off the response rather than assuming — Pagination has all four.

Read one back

This is Get a user. Every field it returns is listed in The user object, including the two that come back null and the ones that are simply absent depending on how far verification has got.

Your first complete payment in sandbox

The whole cycle: user, account, deposit, recipient, payout.