Skip to content
Payouts
/
/
Initiates a payout to a p...

Theropay APIs

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.

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server

https://docs.theropay.co/_mock/theropay/docs/reference/api/

Production server

https://api.theropay.com/

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.

Operations

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.

Operations

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.

Operations

Initiates a payout to a payee.

Request

The payout is processed asynchronously. Use GET /v1/payouts/{id} to check its status.
Required fields: PayeeId, Amount, Currency.
Optional field: Description. MerchantId is automatically obtained from the authenticated user.

Security
Bearer
Body

Details of the payout to be created.

payeeIdstringnon-emptyrequired
payoutAccountIdstringnon-emptyrequired
amountnumberrequired
currencyCodestringnon-emptyrequired
descriptionstring or null
curl -i -X POST \
  https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/payouts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payeeId": "string",
    "payoutAccountId": "string",
    "amount": 0,
    "currencyCode": "string",
    "description": "string"
  }'

Responses

Payout created successfully.

Body
statestring or null
payoutIdstring or null
createdAtstring(date-time)

Timestamp when the payout was created

Response
No response example

Retrieves a list of payouts for a specific payee.

Request

Security
Bearer
Query
payeeIdstring

Payee ID to filter payouts.

curl -i -X GET \
  'https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/payouts?payeeId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of payouts retrieved successfully.

Body
Array [
statestring or null
payoutIdstring or null
createdAtstring(date-time)

Timestamp when the payout was created

]
Response
No response example

Retrieves details of a specific payout by unique reference.

Request

Security
Bearer
Path
PayoutUniqueReferencestringrequired

Unique identifier of the payout.

curl -i -X GET \
  'https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/payouts/{PayoutUniqueReference}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Payout retrieved successfully.

Body
statestring or null
payoutIdstring or null
createdAtstring(date-time)

Timestamp when the payout was created

Response
No response example

Requests cancellation of a pending payout.

Request

Only payouts not yet processed can be cancelled.
Completed or failed payouts cannot be cancelled.

Security
Bearer
Path
PayoutUniqueReferencestringrequired

Unique identifier of the payout to cancel.

curl -i -X POST \
  'https://docs.theropay.co/_mock/theropay/docs/reference/api/v1/payouts/{PayoutUniqueReference}/cancel' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Cancellation request accepted.

Body
payoutUniqueReferencestring or null
messagestring or null
Response
No response example

Webhook

Operations