API for Creditors
Add and list accounts (contracts), and list payments and settlements from your own systems. Access is enabled per creditor account on request.
https://fixpayment.org/api/v1/Send your API key in one of these headers for all endpoints:
X-API-Key: your-secret-keyAuthorization: Bearer your-secret-key
API access must be enabled for your creditor account. Go to fixpayment.org/creditor, sign in, click Profile in the top menu, then open API Access. Or contact Support@fixpayment.org to request access.
Endpoint
POST https://fixpayment.org/api/v1/accounts.php
Creates a new account (contract). Request body: JSON (see below).
Endpoint
GET https://fixpayment.org/api/v1/accounts.php
Query parameters
status(optional) – Filter byaccount_status(e.g. active, settled, paid)limit(optional) – Max results, 1–100 (default 50)offset(optional) – Pagination offset (default 0)
Response
{
"accounts": [
{
"account_id": 1,
"account_number": "ACC-001",
"debtor_name": "Marcus Washington",
"current_balance": "1500.00",
"account_status": "active",
"business_model": "pay_per_hour"
}
],
"total": 123,
"limit": 50,
"offset": 0
}
Endpoint
GET https://fixpayment.org/api/v1/accounts.php?account_id=123
Returns a single account if it belongs to your creditor. 404 if not found.
Response
{
"account": {
"account_id": 123,
"account_number": "ACC-001",
"original_creditor": "Acme Corp",
"debtor_name": "Marcus Washington",
"debtor_phone": "555-123-4567",
"original_balance": "5000.00",
"current_balance": "3500.00",
"account_status": "active",
"business_model": "pay_per_hour",
"created_at": "2024-01-15 10:00:00"
}
}
Endpoint
PATCH https://fixpayment.org/api/v1/accounts.php?account_id=123
Updates an account that belongs to your creditor. Send JSON. account_id can be in the query or the body.
Fee model
business_model is ai (No Recovery, No Fee), pay_per_hour, success_fee, or disputed_buyout. The account stays on its current model until you send a new one. A change follows the same rules as the portal: generally the same or a higher-touch model. No Recovery, No Fee requires the expected payment date within the last 30 days. Disputed Contract Buyout requires the account to have been live for 3 months and buyout_no_contact_ack: true.
curl -X PATCH "https://fixpayment.org/api/v1/accounts.php?account_id=123" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{"business_model": "success_fee"}'
Response
{
"success": true,
"business_model": "success_fee",
"previous_business_model": "pay_per_hour",
"changed": true,
"message": "Fee model updated to Success Fee Model (18%).",
"account": { "account_id": 123, "business_model": "success_fee" }
}
Endpoint
GET https://fixpayment.org/api/v1/payments.php
Query parameters
limit(optional) – Max results, 1–100 (default 50)offset(optional) – Pagination offset (default 0)
Response
{
"payments": [
{
"payment_id": 1,
"account_id": 10,
"account_number": "ACC-001",
"debtor_name": "Marcus Washington",
"payment_date": "2024-02-01 14:30:00",
"payment_amount": "250.00",
"payment_status": "completed",
"payment_method": "card",
"transaction_id": "txn_abc123"
}
],
"total": 45,
"limit": 50,
"offset": 0
}
Endpoint
GET https://fixpayment.org/api/v1/settlements.php
Query parameters
limit(optional) – Max results, 1–100 (default 50)offset(optional) – Pagination offset (default 0)
Response
{
"settlements": [
{
"settlement_id": 1,
"account_id": 10,
"account_number": "ACC-001",
"debtor_name": "Marcus Washington",
"original_balance": "5000.00",
"offer_amount": "2500.00",
"savings_amount": "2500.00",
"approval_status": "approved",
"offer_date": "2024-01-20 09:00:00"
}
],
"total": 12,
"limit": 50,
"offset": 0
}
Endpoint
GET https://fixpayment.org/api/v1/liens.php
List filings, or pass lien_id for one. Optional account_id, status, limit, offset.
POST https://fixpayment.org/api/v1/liens.php
Create a draft (account_id required, plus UCC/debtor fields). Or {"action":"submit","lien_id":1} (locks the packet and requires the filing fee), {"action":"checkout","lien_id":1} (returns a Stripe Checkout URL), or {"action":"withdraw","lien_id":1}.
PATCH https://fixpayment.org/api/v1/liens.php?lien_id=1
Update a draft. Submit requires commercial/B2B, exact-name, and security-agreement attestations, then the filing fee (Stripe Checkout). A UCC-1 perfects a security interest; it does not create one. FixPayment files the packet manually after payment.
curl -X POST https://fixpayment.org/api/v1/liens.php \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"account_id": 10,
"lien_type": "ucc1",
"filing_jurisdiction": "TX",
"debtor_name": "Acme Corp",
"secured_party_name": "Your Company LLC",
"collateral_description": "All accounts receivable and proceeds thereof.",
"commercial_b2b_attested": true,
"security_agreement_attested": true,
"exact_name_attested": true
}'
Endpoint
POST https://fixpayment.org/api/v1/risk_score.php
Scores a business. Same API key as the other endpoints. A live report is metered, and the response billing object includes the price for your account.
Required JSON fields
business_namebusiness_address
Response
{
"fp_risk_score": 72,
"risk_score_1_10": 4,
"risk_label": "Good",
"interpretation": "Moderate",
"reason": "...",
"business_name": "ABC Logistics LLC",
"business_address": "480 Oak Ave, Dallas, TX 75201",
"risk_factors": [],
"recommendations": [],
"billing": {
"model": "pay_as_you_go",
"unit_price_usd": "4.99"
}
}
MCP
fp_risk_score— same report.modeislive(default, metered) orsample(free fixture).get_fp_risk_score_usage— lifetime live reports, unbilled count, and unbilled balance.
For POST https://fixpayment.org/api/v1/accounts.php only.
Required fields
| Field | Type | Description |
|---|---|---|
account_number | string | Unique account or reference number |
debtor_name | string | Full name of debtor |
debtor_phone | string | Phone number |
original_balance | number | Original balance (must be > 0) |
current_balance | number | Current balance (must be > 0) |
date_delinquent | string | Date payment was expected (YYYY-MM-DD). No Recovery, No Fee applies only when this date is within the last 30 days. Days past due is calculated from it. |
Optional fields
| Field | Type | Description |
|---|---|---|
original_creditor | string | Original creditor name |
debtor_email | string | Valid email address |
debtor_dob | string | Date of birth (YYYY-MM-DD) |
debtor_address | string | Street address |
debtor_city | string | City |
debtor_state | string | State (e.g. CA) |
debtor_zip | string | ZIP code |
interest_rate | number | Interest rate |
date_opened | string | YYYY-MM-DD |
notes | string | Free-text notes |
debtor_ssn | string | SSN (XXX-XX-XXXX); stored encrypted |
business_model | string | ai, pay_per_hour, success_fee, or disputed_buyout. Omit it to use the preferred fee model on Profile, or Pay-Per-Hour if none is set. No Recovery, No Fee only applies when the expected payment date is within 30 days. Buyout only applies after the account has been live for 3 months. |
List accounts (GET)
curl -H "X-API-Key: YOUR_API_KEY" "https://fixpayment.org/api/v1/accounts.php?limit=10"
Add account (POST)
curl -X POST https://fixpayment.org/api/v1/accounts.php \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"account_number": "CONTRACT-2024-001",
"debtor_name": "Acme Corp",
"debtor_phone": "555-123-4567",
"original_balance": 10000,
"current_balance": 8500,
"date_delinquent": "2026-11-01",
"debtor_email": "billing@acme.com",
"notes": "Added via API"
}'
Success (201) for POST
{
"success": true,
"account_id": 123,
"account_number": "CONTRACT-2024-001",
"business_model": "pay_per_hour"
}
All errors return JSON: { "error": "message" }. Validation errors may also include an errors array.
- 400 – Invalid or missing required fields (POST)
- 401 – Missing API key
- 403 – Invalid API key or API not enabled for your account
- 404 – Account not found (GET single account)
- 405 – Method not allowed
- 409 – An account with this
account_numberalready exists (POST) - 500 – Server error