Send a Recurring Payment

Send a recurring payment to a customer based on customer parameters.

Creating a Subscription with Paynote

Learn how to effortlessly set up recurring billing for your customers using the Paynote API with this integration guide.

Step 1: Prerequisites
Before you get started, ensure you have the following:

An active account with Paynote.
Your API credentials at hand (API key and secret).
Step 2: Configuring Your Requests
Incorporate your API key into the headers of your requests for authentication purposes.

Step 3: (Optional)
Creating a New Customer:
If the customer isn't already added, you can create one using the provided endpoint. This step will also provide you with the necessary user_id for subscription setup.

Step 4: Setting Up the Subscription
Utilize the subscription endpoint to establish a subscription for your customer. You'll need to specify:

User_id (or email) of the customer.
Start date for the subscription.
Billing cycle details.
Subscription amount.
Follow these straightforward steps to automate your recurring billing processes.


📘

Before using any endpoint, you need to set the environment:

Click on Environment in the Base URL and enter the appropriate option:
api (Production) for the live environment.
sandbox (Sandbox) for testing.

Body Params
string
required

Email or id of recipient

string
required

Name of recipient

string
required

Payment amount

string
required

Description or memo for payment

string

Your unique label

string
enum
required

'month' or 'week' or 'bi-weekly' or 'day'

Allowed:
string
required

Number of payments

string

Start date (YYYY-MM-DD)

string

Payment number

string

Credit account id for funds (if recipient has multiple bank account).

string

Base64 encoded PDF attachment for sender

Response

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json