Payment Request Creation & Completion

Demo Videos

SynchPay

SynchPay Overview

Learn about the flows for integrating with our API as a partner.

API Usage Flows

Learn about the different environments provided by SynchPay for development and production.

Environments

Environment Configuration

Learn how to authorize with the SynchPay API using client credentials.

Authorize Your API Requests

Authorization

Follow these steps to register a company in SynchPay

Registering a Company in SynchPay

Learn how to generate an external authentication link for a company’s mobile number using the SynchPay API.

Linking bank accounts

Follow these steps to register a user in SynchPay

Registering a User in SynchPay

Follow these steps to request money from a registered user using the SynchPay API.

Payment Request

Creating a Payment Request

Learn how to initiate a refund for a previously completed payment using the SynchPay API.

Payment Refund

Issuing a Payment Refund

Enable and manage autopay limits through the SynchPay API using the Debit Auth endpoints.

Debit Auth

Managing Debit Authorization

Retrieve a paginated report of past transactions with optional filters by date and status.

Transaction Report

Receive real-time updates from SynchPay for events.

Introduction

This webhook notifies you whenever the status of a payment request changes.

Payment Request Status

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.

Company Verification

A simplified overview of how the money moves

Flow of Funds

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Quickstart

Preview changes locally to update your docs

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

Get Started

Authorization

Companies

Users & Payments

Transactions

Webhooks

About Us

Demo Videos

Payment Request Creation & Completion

Get Started

Authorization

Companies

Users & Payments

Transactions

Webhooks

About Us

​Payment Request Creation & Completion

Payment Request Creation & Completion