Documentation Index
Fetch the complete documentation index at: https://apidocs.synchpay.dev/llms.txt
Use this file to discover all available pages before exploring further.
API Changes
Webhook signatures, redesigned onboarding, and card payment polish
New features
- Signed webhooks — SynchPay now signs webhook payloads with an HMAC-SHA256 signature when a secret is configured for your endpoint. Each delivery includes an
X-HMAC-Signatureheader in the formsha256=<hex>so your backend can verify that the request came from SynchPay and was not tampered with. Contact support to enable a signing secret for your webhook endpoint. - Redesigned mobile onboarding — New users opening the SynchPay mobile app now see a refreshed introduction with four slides explaining one-tap payments, bank-to-bank transfers, medical bill reimbursement, and fast settlement, followed by a new boot splash. The change applies to both iOS and Android.
Updates
- Smoother in-app card payments — After completing an in-app card payment in the browser, payers are now routed back to the SynchPay mobile app’s success screen automatically. The action button on the card payment screen is also relabeled from “Open browser again” to “Continue to card payment” for clarity.
Card payment processing and API update
Updates
- New card payment processor — In-app card payments are now powered by a new payment processor, improving reliability and checkout speed. The payer experience is unchanged — card payments still appear as a payment method alongside bank transfers when enabled for a company. See card payments for details.
- External card payment API change — The register external card payment endpoint (
POST /cardpayment) now uses aMerchantIdfield to identify the merchant. The previousCompanyIdandCompanyReferenceIdfields have been removed. Update your integration to passMerchantIdinstead.
In-app card payments and invoice fix
New features
- In-app credit card payments — Payers can now choose to pay with a credit card directly in the SynchPay mobile app. When a payment request supports card payments, payers see a payment method selection screen with options to pay by credit card or bank account. Card transactions are marked with a card icon in the transaction list. See card payments for details.
Bug fixes
- Fixed an issue where invoice payments could fail due to an unnecessary account balance check.
Card payment registration
New features
- Card payment endpoint — You can now register external card payments in SynchPay using the new
POST /cardpaymentendpoint. This lets you record card transactions processed by an external terminal or POS system so they appear alongside your account-to-account payments. Payers receive an SMS (and optional email) confirmation when a card payment is registered.
Deep links, iPad support, and payment API improvements
New features
- Recurring payment deep links — Payers can now open recurring payment consent requests directly from a shared link, making it easier to accept or decline a recurring payment plan without navigating through the app.
- iPad support — The SynchPay mobile app is now available on iPad.
- CompanyReferenceId on payments — The create payment endpoint now accepts an optional
CompanyReferenceIdfield as an alternative toCompanyId, so you can identify the target company using your own external reference. - Attachment URL support — You can now pass an attachment URL when creating a payment request. SynchPay automatically downloads and stores the file with the payment.
Bug fixes
- Fixed an issue where pull-to-refresh could trigger unexpectedly when switching between tabs in the mobile app.
API validation and new fields
New features
- Company reference ID — The company registration endpoint now requires a
CompanyReferenceIdfield, letting you assign your own external identifier to each company at creation time. - Company website — You can now optionally provide a
WebsiteUrlwhen registering a company. - ForProfit company type —
ForProfitis now an accepted value for theCompanyTypefield during company registration. - Debit auth on payments — The create payment endpoint now supports
EnableDebitAuthandDebitAuthLimitfields as alternatives toEnableAutoPay/AutoPayLimit.
Improvements
- Stricter input validation across all company registration fields, including email format, phone number format, ZIP code pattern, and state abbreviation checks. Invalid requests now return clear error messages.
- Owner and employee email addresses are validated for uniqueness during company creation.
Recurring payments in the mobile app
Payers can now view, accept, and cancel recurring payment plans directly in the SynchPay mobile app. The Payments tab shows upcoming recurring payments alongside unpaid requests, and payers can manage all active plans from their Profile screen. A new frequency filter helps payers distinguish between one-time, irregular, and subscription payments. See payer experience in the mobile app for details.Unified consent decline action
The decline consent endpoint now handles both pending and accepted consents. When a payer declines aPending consent, it moves to Declined as before. When a payer declines an Accepted consent, it now moves to Revoked automatically — no separate revoke action is needed.Status field in consent list and filtered results
The list consents endpoint now includes aStatus field in each consent object, so you can see whether a consent is Pending or Accepted without fetching each one individually. The endpoint also now filters out consents that are no longer actionable — only Pending and Accepted consents are returned.Company details in consent response
The get payment plan consent endpoint now returns aRecipientCompany object with full company details (name, contact number, email, website, and address) instead of just the company name. This gives payers more context about the company they are authorizing recurring payments for.Recurring payment plans API
Recurring payment plans are now fully available through the API.New features
- Payment plans API — You can now create, activate, pause, and cancel recurring payment plans entirely through the API. Define the amount, frequency, and start date, then SynchPay automatically generates and processes payments on schedule.
- Payer consent flow — When you add a payer to a plan, they receive a notification and can accept or decline through the app. You can track consent status and manage multiple payers per plan.
Bug fixes
- Fixed an issue that could prevent recurring payment plans from processing correctly.
NexHealth integration, invoicing, and more
We’ve shipped several new features and improvements over the past few months.New features
- NexHealth integration — SynchPay has deepened its integration with NexHealth, allowing dental practices to sync patient payments directly from their practice management software.
- Automated invoicing — Businesses can now generate invoices with PDF documents and automate money movement for invoice billing.
- Payment reminders — You can now send manual payment reminder notifications via SMS, giving you more control over follow-ups on outstanding payment requests.
- Same-day autopay — Scheduled payments set for today are now automatically processed via autopay, reducing delays for due-date payments.
- Recurring payment intervals — A new recurrence interval field lets you configure flexible recurring payment schedules.
Updates
- Richer notification content with more payment context for end users.
- Account number masking is now included in additional API responses for improved security.
- Enhanced login security with additional OTP verification protections.
Bug fixes
- Fixed typos and grammatical errors across user-facing text in the mobile app.
- Resolved an issue with charity donation messaging and receipts.
Minor Improvements
We’ve made some subtle improvements to our overall documentation with minimal functional changes.- Documented the
AccountNumberMaskedparameter in the Payment Request Status webhook.
New, Faster Money Movement
We’ve upgraded our money movement partner for faster, more certain, and more secure movement. There is one minor breaking change to the API in the Company Creation process.Launching Debit Auth
We’re launching our Debit Auth API. This allows you to check, set, and update the user’s authorized debit limit.This allows you to effectively mimic a card-on-file experience, as well as implement recurring payments.Take a look at our Debit Auth API Reference for more details.Other Fixes
- Clarified the Register Company API endpoint.
- Added Transaction Report functionality to help with your reconciliation.