Creating a Recurring Payment

Create a recurring payment plan for a registered user or phone number.

Use POST /Payment/Recurring to create a recurring payment plan for a company location.

Endpoint

• URL: https://api.synchpay.com/Payment/Recurring
• Method: POST
• Authorization: Bearer <AccessToken>

The access token is obtained from /auth/token using your ClientId and ClientSecret.

Request Body

Parameter	Type	Description	Required
Amount	integer	Amount to charge on each recurrence, in cents.	Yes
LocationId	string	UUID of the company location that receives each payment.	Yes
StartDate	string	First recurrence date in YYYY-MM-DD format.	Yes
IntervalValue	integer	Number of units between recurring payments.	Yes
IntervalUnit	string	Recurrence unit: Day, Week, Month, Quarter, or Year.	Yes
PhoneNumber	string	Payer phone number. Use when RegistrationUserId is not provided.	No
RegistrationUserId	string	SynchPay registered user ID. Use when PhoneNumber is not provided.	No

Provide either PhoneNumber or RegistrationUserId so SynchPay can identify the payer. Use company locations to find the LocationId.

Example Request

{
  "Amount": 5000,
  "LocationId": "4d8ab11b-0322-4bf9-921f-39d753b0530c",
  "StartDate": "2026-08-01",
  "IntervalValue": 1,
  "IntervalUnit": "Month",
  "RegistrationUserId": "6e8d9257-bd5f-45cf-8f29-6d0ae8a6d991"
}

Response

Field	Type	Description
PaymentPlanId	string	Unique ID of the recurring payment plan.

{
  "PaymentPlanId": "d4e5f6a7-b8c9-0123-4567-89abcdef0123"
}

Frequency Examples

IntervalValue	IntervalUnit	Resulting schedule
1	Month	Every month
2	Week	Every two weeks
1	Quarter	Every quarter
7	Day	Every seven days