Theropay offers a set of powerful APIs that help merchants manage their payment processes. These APIs allow you to handle everything from managing payees and setting up payout accounts to tracking and initiating payments.
Theropay APIs
Payee
The Payees API allows you to manage your payees easily. You can create new payees, update their information, list all payees, or deactivate them when needed. Each payee can be an individual or a business. This API helps keep track of all your payees in one place. Think of it as your digital address book for payments. It ensures that every transaction is sent to the correct and verified recipient, simplifying the payout process for your application.
Payee Accounts
The Payee Accounts API allows merchants to manage the bank or payout accounts linked to their payees. It enables creating, updating, and retrieving payout account details securely. Each payee can have one or more accounts associated for receiving funds. Use these endpoints to validate account information and ensure smooth disbursements. This API acts as the secure layer between your system and the banks, handling sensitive financial data.
Payouts
The Payouts API allows merchants to send money to their payees securely and efficiently. You can create new payouts, check their status, and cancel them if needed before processing. Each payout is linked to a registered payee and a payout account. The API supports listing all payouts with optional filters like status. Responses include detailed information about the payout, such as amount, currency, and current status. Use this API to manage your outgoing payments in a reliable and predictable way.
Webhooks are automatic messages sent from our system to your server whenever something important happens with a payout.
Think of them like notifications — they instantly let you know when the status of a payout changes.Your server must be able to accept HTTPS POST requests and respond with standard HTTP status codes.
Each webhook payload is delivered in JSON format.
{
"payout_request_id": "PR123456789",
"amount": "100.00",
"currency": "EUR",
"timestamp": "2025-01-09T10:40:00Z",
"state": "completed"
}{
"payout_request_id": "PR123456789",
"amount": "100.00",
"currency": "EUR",
"timestamp": "2025-01-09T10:45:00Z",
"state": "failed"
}{
"payout_request_id": "PR123456789",
"amount": "100.00",
"currency": "EUR",
"timestamp": "2025-01-09T10:50:00Z",
"state": "cancelled"
}- application/json
- text/json
- application/*+json
Webhook registration details including URL, environment, and events.
- Mock server
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks
- Production server
https://api.theropay.com/v1/webhooks
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"url": "string"
}'No response example- Mock server
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks
- Production server
https://api.theropay.com/v1/webhooks
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'No response example- Mock server
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks
- Production server
https://api.theropay.com/v1/webhooks
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/webhooks \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'