Concepts

The building blocks of a PayProof integration.

AGENTS.md

Apps

An app is the container for products, checkouts, API keys, and webhooks. Branding fields (logo_url, brand_color, checkout_style) control the hosted pay page.

Products

FieldValuesNotes
product_typesubscription | one_timeWhat the checkout unlocks
pricing_modelfixed | dynamicdynamic only for one_time
amount_etbdecimal or nullnull when dynamic
intervalweek | month | year | day | customsubscriptions

Bank accounts

Workspace receiving accounts are shared across apps. Customers transfer here; PayProof only verifies. Manage them under Bank accounts.

Checkout statuses

StatusMeaning
pendingpending
partially_paidUnderpaid; customer can top up
verifiedverified
failedfailed
expiredexpired
canceledcanceled
manual_reviewAwaiting merchant approve/reject

Failure codes

When verification fails, failure_code may be one of: expired, duplicate_ref, network_error, receipt_not_found, unsupported_bank, account_mismatch, tampering, time_window_exceeded, underpaid, overpaid, amount_mismatch, no_retries.

Credits