# SynchPay

- [SynchPay Overview](https://apidocs.synchpay.dev/introduction.md): Get started with the new way to pay
- [Quickstart](https://apidocs.synchpay.dev/quickstart.md): Accept payments for 80% less than credit cards in under ten minutes.
- [API Usage Flows](https://apidocs.synchpay.dev/synchpay/api-flows.md): Learn about the flows for integrating with our API as a partner.
- [Authorization](https://apidocs.synchpay.dev/synchpay/auth.md): Learn how to authorize with the SynchPay API using client credentials.
- [Environment Configuration](https://apidocs.synchpay.dev/synchpay/api-environments.md): Learn about the different environments provided by SynchPay for development and production.
- [Registering a Company in SynchPay](https://apidocs.synchpay.dev/synchpay/register-company.md): Follow these steps to register a company in SynchPay
- [Listing companies](https://apidocs.synchpay.dev/synchpay/list-companies.md): Retrieve all companies registered under your integration using the SynchPay API.
- [Managing Company Locations](https://apidocs.synchpay.dev/synchpay/company-locations.md): Add locations to a company and retrieve the location IDs used by payment endpoints.
- [Linking bank accounts](https://apidocs.synchpay.dev/synchpay/company-external-auth-link.md): Learn how to generate an external authentication link for a company’s mobile number using the SynchPay API.
- [Registering a User in SynchPay](https://apidocs.synchpay.dev/synchpay/register-user.md): Follow these steps to register a user in SynchPay
- [Creating a Payment Request](https://apidocs.synchpay.dev/synchpay/make-payment.md): Follow these steps to request money from a registered user using the SynchPay API.
- [Canceling a Payment Request](https://apidocs.synchpay.dev/synchpay/cancel-payment.md): Cancel an outstanding payment request before it is paid.
- [Card payments](https://apidocs.synchpay.dev/synchpay/card-payment.md): Register external card transactions.
- [Authorizing a Card](https://apidocs.synchpay.dev/synchpay/authorize-card.md): Create a hosted card authorization flow for a payer.
- [Listing Saved Card Payment Methods](https://apidocs.synchpay.dev/synchpay/saved-card-payment-methods.md): Retrieve saved card payment methods for a registered SynchPay user.
- [Charging a Saved Card](https://apidocs.synchpay.dev/synchpay/charge-saved-card.md): Create and charge a payment request using a saved card payment method.
- [Checking Payment Request Status](https://apidocs.synchpay.dev/synchpay/payment-status.md): Retrieve the current status and details for a SynchPay payment request.
- [Creating a Recurring Payment](https://apidocs.synchpay.dev/synchpay/create-recurring-payment.md): Create a recurring payment plan for a registered user or phone number.
- [Issuing a Payment Refund](https://apidocs.synchpay.dev/synchpay/refund-payment.md): Learn how to initiate a refund for a previously completed payment using the SynchPay API.
- [Managing Debit Authorization](https://apidocs.synchpay.dev/synchpay/payment-debit-auth.md): Enable and manage autopay limits through the SynchPay API using the Debit Auth endpoints.
- [Transaction Report](https://apidocs.synchpay.dev/synchpay/report-transactions.md): Retrieve a paginated report of past transactions with optional filters by date and status.
- [Introduction](https://apidocs.synchpay.dev/synchpay/webhooks/intro.md): Receive real-time updates from SynchPay for events.
- [Payment Request Status](https://apidocs.synchpay.dev/synchpay/webhooks/payment-status.md): This webhook notifies you whenever the status of a payment request changes.
- [Company Verification](https://apidocs.synchpay.dev/synchpay/webhooks/company-verification.md): SynchPay provides a webhook to notify you when the Know-Your-Business (KYB) verification process is completed. This allows you to automatically respond to changes in a company's verification status without the need to continuously poll the status endpoint.
- [Demo Videos](https://apidocs.synchpay.dev/synchpay/demoVids.md)
- [Changelog](https://apidocs.synchpay.dev/synchpay/changelog/changelog.md): SynchPay's changelog, announcements, and new API features.
- [Authenticate](https://apidocs.synchpay.dev/api-reference/authentication/authenticate.md): Creates a JWT token used for authentication from client credentials.
- [Authenticate](https://apidocs.synchpay.dev/api-reference/authentication/authenticate-1.md): Creates a JWT token used for authentication from client credentials.
- [Register card payment](https://apidocs.synchpay.dev/api-reference/payment/register-card-payment.md): Registers a new card payment for a given company
- [Create a payment](https://apidocs.synchpay.dev/api-reference/payment/create-a-payment.md): Creates a new payment for a given user
- [Authorize a card](https://apidocs.synchpay.dev/api-reference/payment/authorize-a-card.md): Authorizes a card for a given user.
- [Create a recurring payment](https://apidocs.synchpay.dev/api-reference/payment/create-a-recurring-payment.md): Creates a new recurring payment plan for one of the partner's companies
- [Cancel a payment](https://apidocs.synchpay.dev/api-reference/payment/cancel-a-payment.md): Cancels a payment request created for one of the partner's companies
- [Create a payment refund](https://apidocs.synchpay.dev/api-reference/payment/create-a-payment-refund.md): Creates a refund for previous payment
- [Get payment status](https://apidocs.synchpay.dev/api-reference/payment/get-payment-status.md)
- [List saved card payment methods](https://apidocs.synchpay.dev/api-reference/payment/list-saved-card-payment-methods.md): Returns saved card payment methods for a registered customer
- [Charge a saved card](https://apidocs.synchpay.dev/api-reference/payment/charge-a-saved-card.md): Creates a payment request for a registered customer and charges a saved card payment method
- [Create a Company](https://apidocs.synchpay.dev/api-reference/company/create-a-company.md): Creates a new Company from the provided details
- [Check company status](https://apidocs.synchpay.dev/api-reference/company/check-company-status.md): Checks the company status
- [Create company account link](https://apidocs.synchpay.dev/api-reference/company/create-company-account-link.md): Prepares a link for company to link new accounts
- [List Company Locations](https://apidocs.synchpay.dev/api-reference/company/list-company-locations.md): Returns all Locations for the Company
- [Add a Company Location](https://apidocs.synchpay.dev/api-reference/company/add-a-company-location.md): Adds a new Location to the Company
- [List all companies](https://apidocs.synchpay.dev/api-reference/company/list-all-companies.md): Returns all companies for current integration
- [Register a new user](https://apidocs.synchpay.dev/api-reference/user/register-a-new-user.md): Prepares system for a new user onboarding
- [Check user status](https://apidocs.synchpay.dev/api-reference/user/check-user-status.md): Returns the status of user onboarding process
- [Get user's debit authorization](https://apidocs.synchpay.dev/api-reference/user/get-users-debit-authorization.md): Returns user's debit authorization with amount and status
- [Request new debit authorization](https://apidocs.synchpay.dev/api-reference/user/request-new-debit-authorization.md): Sends a new request to user for enabling debit authorization
- [Overview of Integrations](https://apidocs.synchpay.dev/integrations/index.md): SynchPay's integrations and how to get started
- [Dental Integrations](https://apidocs.synchpay.dev/integrations/dentalPlatforms.md): We integrate with several of the leading dental software platforms.
- [Integrating with Mindbody](https://apidocs.synchpay.dev/integrations/mindbody.md): Reach out to the SynchPay team directly to get started with Mindbody
- [Changelog](https://apidocs.synchpay.dev/synchpay/changelog/changelog.md): SynchPay's changelog, announcements, and new API features.

## OpenAPI Specs

- [package-lock](/package-lock.json)
- [package](/package.json)
- [swagger](/swagger.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.