API Reference

Get Scheduled Payment Rule

get
https://api.vcita.biz/business/payments/v1/scheduled_payments_rules/

Overview

Gets a Scheduled Payment Rule. Available for Staff Tokens.

Prerequisites

Scheduled payments require complex pre-configuration:

  1. Payment Gateway: Business must have a payment gateway configured that supports recurring payments (Stripe, vcitaPayments, Square). PayPal is not supported.
  2. Payment Cards on File: Clients must have active payment cards saved on file.
  3. Feature Enabled: The scheduled_payments feature must be enabled for the business.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Scheduled Payment Rule UID

Responses

Updated 2 months ago

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

Updated 2 months ago