API Reference
Complete reference for the YardPay Pro API. All endpoints follow OData conventions and return JSON responses.
Base Configuration
Base URL
All API endpoints use origin-relative paths (e.g. /v1/invoice). The API is served from the same host as the UI.
Headers
Content-Type: application/json x-api-key: your_api_key
Authentication
All API requests require an API key passed via the x-api-key header. See the Authentication page for details.
Payments & Finance
Finance
Payments
Process payments, manage payment methods, funding sources, and card registration.
7 endpoints
Finance
Payment Links
Create shareable payment links, embed buttons, manage QR codes, and track conversions.
12 endpoints
Finance
Invoices
Create, retrieve, and manage invoices with line items, QR codes, and payment tracking.
5 endpoints
Finance
Transactions
View transaction history, analytics, daily trends, and period comparisons.
6 endpoints
Finance
Transfers
Initiate and manage fund transfers including bank transfers, CBDC, and payouts.
8 endpoints
Finance
Accounts
Manage user accounts, balances, account types, and funding sources.
6 endpoints
Commerce
Subscriptions
Manage subscription plans, products, inventory items, and recurring billing.
10 endpoints