Partner API
Guides
Reference
llms.txt
Full text
OpenAPI
☾
Guides
1
Getting started
2
Payment lifecycle
3
Accepting a payment
4
Sending a payout
API reference →
Guides
Read in order. Every field is in the
API reference
.
1
Getting started
The basics every other guide assumes: environments, authentication, money format, idempotency and errors.
2
Payment lifecycle
Every state a collection or payout passes through, which ones are final, and which send a webhook.
3
Accepting a payment
A collection moves money from your customer into your balance: create it, show the next action, learn the result.
4
Sending a payout
A payout moves money from your account to a saved beneficiary. Its amount plus fee is set aside the moment you create it.