Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Discussions
v20240701
v20250401
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v20240701
Home
Guides
Recipes
API Reference
Changelog
Discussions
My Requests
Search
JUMP TO
Developer Dashboard
Getting Started
Authentication
My Requests
Docs
Authorisation
Expanding Responses
Errors
Metadata
Pagination
Versioning
Domains and IP addresses
Search
Ophelos API
Tenant Management
Retrieves my tenant
get
Updates my tenant
put
Organisation Management
List organisations
get
Create an organisation
post
Update an organisation
put
Retrieve organisation
get
Create an contact detail for an organisation
post
List all payments for an organisation
get
Customer Management
List customers
get
Add a new customer
post
Search customers
get
Retrieve a single customer
get
Update a specific customer
put
Customer created
post
Customer updated
post
Customer deleted
post
Debt Management
List Debts
get
Create a debt
post
Search debts
get
Retrieve a single debt
get
Update a specific debt
put
Withdraw a debt from Ophelos
delete
Summary of the debt
get
Ready debt for processing
post
Resume debt processing
post
Pause processing of a debt
post
Withdraw a debt from Ophelos
post
Stop debt processing as process exhausted
post
Mark a debt as disputed
post
Debt created
post
Debt updated
post
Debt deleted
post
Debt prepared
post
Debt closed
post
Debt withdrawn
post
Debt returned
post
Debt paused
post
Debt resumed
post
Debt analysing
post
Debt contacted
post
Debt contact established
post
Debt queried
post
Debt disputed
post
Debt adjusted
post
Debt defaulted
post
Debt assessing
post
Debt recovering
post
Debt process exhausted
post
Debt arranging
post
Debt paying
post
Debt follow-up required
post
Debt legal protection
post
Debt paid
post
Debt settled
post
Invoice Management
Retrieve a single invoice
get
Update a specific invoice
put
Create a new invoice for a debt
post
Search invoices attached to a debt
get
Line Item Management
List all line items for a debt
get
Create a new line item for a debt
post
Line Item created
post
Line Item updated
post
Line Item deleted
post
Webhooks
List Webhooks
get
Create a webhook endpoint
post
Retrieve a webhook endpoint
get
Update a webhook endpoint
put
Delete a webhook endpoint
delete
Webhook Events
Types of events
Payment Management
List all payments for the debt
get
Create a new payment for a debt
post
Search payments for the debt
get
Retrieve a single payment
get
Update a payment for a debt
put
Search payments for the organisation
get
List all payments
get
Search payments
get
Retrieve a single payment
get
Payment created
post
Payment updated
post
Payment deleted
post
Payment scheduled
post
Payment canceled
post
Payment preparing
post
Payment processing
post
Payment succeeded
post
Payment failed
post
Payment disputed
post
Payment refunded
post
Payment Plan Management
List all payment plans
get
Reschdule a payment plan
patch
Delay a payment plan
patch
Payout Management
List Payouts
get
Search payouts
get
Retrieve a single payout
get
Communication Management
List communications
get
Powered by
••••••a97d
Endpoint
Method
Status
User Agent
