Developer Documentation
Everything you need to integrate YardPay Pro into your application. From no-code payment links to full API access.
Quick Start Guides
Authentication
Generate API keys and authenticate requests to the platform.
Create an Invoice
Generate and send a professional invoice via the API or dashboard.
Accept Your First Payment
Process a test payment against an invoice using the API.
Set Up Subscriptions
Create products, plans, and manage recurring billing for your customers.
Integration Methods
Choose the integration approach that fits your technical needs.
Payment Links
Generate shareable links that take customers to a hosted payment page. No code required.
Pay Buttons
Embed a payment button on your website with a simple HTML snippet.
REST API
Full programmatic control over payments, invoices, subscriptions, and more.
Plugins
Pre-built integrations for WooCommerce, WordPress, and other platforms.
Webhooks
Receive real-time notifications when events occur on your account.
SDKs
Client libraries for JavaScript, PHP, and other languages to simplify integration.
RESTful API with OData support. All endpoints require authentication via API key.
Payments
Create, capture, and manage payment transactions. Supports Visa, Mastercard, and JAM-DEX.
POST /v1/paymentGET /v1/payment/{id}POST /v1/payment/{id}/captureInvoices
Generate invoices, track payment status, and manage automated billing.
POST /v1/invoiceGET /v1/invoice/{id}POST /v1/invoice/{id}/sendSubscriptions
Manage subscription plans, products, and customer billing cycles.
POST /v1/subscriptionPlanGET /v1/subscriptionPOST /v1/subscription/{id}/cancelWallets & Accounts
Manage customer accounts, balances, and wallet-to-wallet transfers.
GET /v1/accountPOST /v1/transferGET /v1/transactionMerchants
Manage merchant profiles, locations, payment methods, and onboarding.
GET /v1/merchantPOST /v1/merchantGET /v1/merchantLocationUsers & Roles
Manage user accounts, roles, permissions, and access control.
GET /v1/userPOST /v1/roleGET /v1/scopeExample: Create a Payment
A simple example to get you started with the API.
// Install: npm install axios
const axios = require("axios");
const response = await axios.post(
"/v1/payment",
{
amount: 5000,
currency: "JMD",
paymentMethod: "card",
description: "Order #1234"
},
{
headers: {
"x-api-key": "your_api_key"
}
}
);