Documentation
Build payouts into your own software.
Guides for every concept, a reference for every call, and code in curl, JavaScript, C# and Python. Switch between Test and Live in the sidebar and every example follows.
IntroductionWhat the API does and how answers look.QuickstartA test payout in four steps, with fake money.AuthenticationOAuth 2.0 client credentials and scopes.WebhooksSigned events, retries and verification code.
Every call
Download OpenAPI (JSON)- POST
/oauth/tokenGet an access token - GET
/api/v1/balanceGet the balance - GET
/api/v1/beneficiariesList people - GET
/api/v1/beneficiaries/{id}Get a person - POST
/api/v1/beneficiariesAdd a person - GET
/api/v1/payout-batchesList payout batches - GET
/api/v1/payout-batches/{id}Get a payout batch - POST
/api/v1/payout-batchesCreate a payout batch - POST
/api/v1/payout-batches/{id}/submitSubmit a batch - POST
/api/v1/payout-batches/{id}/cancelCancel a batch - POST
/api/v1/sandbox/fundAdd test money