API Reference

Create Scheduled Payment Rule

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

Overview

Creates a Scheduled Payment Rule Available for Staff, App, and Directory tokens.

Prerequisites

  1. Business must have the scheduled_payments feature enabled.
  2. Business must have a payment gateway configured that supports recurring payments. Supported gateways: Stripe, vcitaPayments, Square. PayPal is not supported.
  3. The card specified in payment_method.uid must be active, belong to the matter client, and use the same payment provider as the business payment gateway.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
scheduled_payments_rule
object
required
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