vCita Payment Requests API

The Payment Requests API from vCita — 5 operation(s) for payment requests.

GitHub OpenAPI

Operations 6

GET /client/payments/v1/payment_requests Get Payment Requests List #
GET /client/payments/v1/payment_requests/{payment_request_uid}/checkout Get Checkout Session #
GET /business/payments/v1/payment_requests GET Payment Requests List #
GET /business/payments/v1/payment_requests/{payment_request_uid} GET Payment Request #
PUT /business/payments/v1/payment_requests/{payment_request_uid} update #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-payment-requests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-payment-requests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Vcita Payment Requests API
  version: '3.0'
  x-refined-note:
  - x-generated differs across the merged source definitions and was not carried
  description: 'Operations tagged Payment Requests across 2 of this provider''s published API definitions: vcita-clients-api-openapi.yml, vcita-sales-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Payment Requests
paths:
  /client/payments/v1/payment_requests:
    get:
      description: '## Overview

        Show list of payment requests.


        ## Authentication

        **Available for Client Tokens only.**


        ## Required Parameters

        - `matter_uid` (required): The matter UID to fetch payment requests for.'
      parameters:
      - description: relevant matter_uid to fetch payment requests for
        in: query
        name: matter_uid
        required: true
        schema:
          type: string
      - description: 'Page offset (default: 1)'
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: 'Page size (default: 25)'
        in: query
        name: per_page
        required: false
        schema:
          type: string
      - description: 'Available filters: state, uid, entity_type, enitity_uid. example: filter[state][in]=paid&filter[uid][in]=123&filter[entity_type][in]=Invoice.'
        in: query
        name: filter
        required: false
        schema:
          type: string
      - description: 'Sort by one of the following: created_at, updated_at. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc'
        in: query
        name: sort
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  payment_requests:
                  - amount: '20.0'
                    amount_before_coupon: null
                    amount_paid: 0
                    amount_pending: null
                    created_at: '2025-08-05T01:55:27.581-05:00'
                    currency: USD
                    display: true
                    due_date: '2025-08-04T19:00:00.000-05:00'
                    fees_amount: 0
                    matter_uid: ci0ippxguwzmvcia
                    net_amount: '20.0'
                    paid_at: null
                    pait_at: null
                    payable_type: Invoice
                    payable_uid: gsu536shmo37ig6e
                    sellable_name: 'INVOICE #0000001'
                    staff_uid: 1bc6b627e589e0d4
                    state: pending
                    tax_mode: exclude
                    taxes: []
                    tips_amount: 0
                    uid: cv03mnjcgqfg7vt6
                    updated_at: '2025-08-05T01:55:27.581-05:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Get Payment Requests List
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///client/payments/v1/payment_requests
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getClientPaymentsV1PaymentRequests
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /client/payments/v1/payment_requests/{payment_request_uid}/checkout:
    get:
      description: '## Overview

        Get the checkout session of a given payment request. Available for **Client tokens**.


        ## Authentication

        This endpoint is designed for client checkout flows and may also work without authentication for public checkout scenarios.


        ## Coupon Functionality

        The optional `coupon_code` parameter applies a discount to the payment request. **Note:** Business must have `rollout.payments.coupons_checkout_v2` feature enabled and active coupons available. Returns 422 error if business is not eligible for coupon functionality.'
      parameters:
      - description: Payment Request UID
        in: path
        name: payment_request_uid
        required: true
        schema:
          type: string
      - description: Optional coupon code to apply discount to the payment request
        in: query
        name: coupon_code
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  checkout_session:
                    amount_left_to_pay: 20
                    amount_total: 20
                    checkout_options: null
                    coupon_discount: 0
                    currency: USD
                    discount: 0
                    is_allowed_coupons: true
                    is_cart_coupon: false
                    items:
                    - description:
                        issue_date: '2025-08-05'
                      discount: 0
                      entity_type: Invoice
                      entity_uid: gsu536shmo37ig6e
                      price_after_discount: 20
                      price_before_discount: 20
                      taxes: []
                      title: 'Invoice #001'
                    net_amount_left_to_pay: 20
                    net_total_amount: 20
                    payable_type: Invoice
                    payable_uid: gsu536shmo37ig6e
                    payment_status_uid: cv03mnjcgqfg7vt6
                    state: due
                    tax_mode: exclude
                    taxes: []
                    title: 'Invoice #001'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Get Checkout Session
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///client/payments/v1/payment_requests/{payment_request_uid}/checkout
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getClientPaymentsV1PaymentRequestsByPaymentRequestUidCheckout
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /business/payments/v1/payment_requests:
    get:
      description: '## Overview

        GET Payment Requests List. Available for **Staff, App, and Directory tokens**.'
      parameters:
      - description: 'Page offset (default: 1)'
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: 'Page size (default: 25)'
        in: query
        name: per_page
        required: false
        schema:
          type: string
      - description: 'Sort by one of the following: created_at, updated_at, due_date, state, entity_type.  available operators: asc, desc. example: sort=created_at:asc,updated_at:desc'
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: "Available filters: client_uid: filter[client_uid][eq]=123. \n                                                                                           matter_uid: filter[matter_uid][eq]=123.\n                                                                                           state: filter[state][in]=DUE/OVERDUE/NOT_YET_DUE/PAID/CANCELLED. \n                                                                                           created_at: filter[created_at][eq/lt/lte/gt/gte]=2019-01-01.\n                                                                                           updated_at: filter[updated_at][eq/lt/lte/gt/gte]=2019-01-01.\n                                                                                           due_date: filter[due_date][eq/lt/lte/gt/gte]=2019-01-01.\n                                                                                           entity_type: filter[entity_type][in]=Cart,Invoice,Meeting,EventAttendance,ProductOrder,ClientBookingPackage,Payou,PendingBooking,PendingClientBookingPackage.\n                                                                                           entity_uid: allowed only with one matching entity_type. for example: filter[entity_uid][eq]=123&filter[entity_type][in]=Meeting\n                                                                                           amount_pending: filter[amount_pending][eq/lt/lte/gt/gte]=100.\n                                                                                           amount_paid: filter[amount_paid][eq/lt/lte/gt/gte]=100."
        in: query
        name: filter
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  payment_requests:
                  - amount: '100.0'
                    amount_before_coupon: null
                    amount_paid: 0
                    amount_pending: null
                    created_at: '2025-08-05T09:54:24.230+03:00'
                    currency: USD
                    display: true
                    due_date: '2025-08-05T00:00:00.000+03:00'
                    fees_amount: 0
                    matter_uid: jhtunvqcadvvqiwu
                    net_amount: '100.0'
                    paid_at: null
                    pait_at: null
                    payable_type: ProductOrder
                    payable_uid: 667yhdpqpielqq7s
                    sellable_name: Shampoo
                    staff_uid: 05a2a75fc9b4f022
                    state: pending
                    tax_mode: exclude
                    taxes: []
                    tips_amount: 0
                    uid: 05ivcq2c5o62vebm
                    updated_at: '2025-08-05T09:54:24.230+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: GET Payment Requests List
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/payment_requests
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1PaymentRequests
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /business/payments/v1/payment_requests/{payment_request_uid}:
    get:
      description: '## Overview

        GET Payment Request. Available for **Staff Tokens**.'
      parameters:
      - description: Payment Request UID
        in: path
        name: payment_request_uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  payment_request:
                    amount: '100.0'
                    amount_before_coupon: null
                    amount_paid: 0
                    amount_pending: null
                    created_at: '2025-08-05T09:54:24.230+03:00'
                    currency: USD
                    display: true
                    due_date: '2025-08-05T00:00:00.000+03:00'
                    fees_amount: 0
                    matter_uid: jhtunvqcadvvqiwu
                    net_amount: '100.0'
                    paid_at: null
                    pait_at: null
                    payable_type: ProductOrder
                    payable_uid: 667yhdpqpielqq7s
                    sellable_name: Shampoo
                    staff_uid: 05a2a75fc9b4f022
                    state: pending
                    tax_mode: exclude
                    taxes: []
                    tips_amount: 0
                    uid: 05ivcq2c5o62vebm
                    updated_at: '2025-08-05T09:54:24.230+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: GET Payment Request
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/payment_requests/{payment_request_uid}
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1PaymentRequestsByPaymentRequestUid
      x-operation-id-source: derived
    put:
      description: '## Overview

        update an existing payment request Available for **Staff, App, and Directory tokens**.'
      parameters:
      - description: Payment request uid
        in: path
        name: payment_request_uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  payment_request:
                    amount: '100.0'
                    amount_before_coupon: null
                    amount_paid: 0
                    amount_pending: null
                    created_at: '2025-08-05T09:54:24.230+03:00'
                    currency: USD
                    display: true
                    due_date: '2025-08-05T00:00:00.000+03:00'
                    fees_amount: 0
                    matter_uid: jhtunvqcadvvqiwu
                    net_amount: '100.0'
                    paid_at: null
                    pait_at: null
                    payable_type: ProductOrder
                    sellable_name: Shampoo
                    staff_uid: 05a2a75fc9b4f022
                    state: pending
                    tax_mode: exclude
                    taxes: []
                    tips_amount: 0
                    uid: 05ivcq2c5o62vebm
                    updated_at: '2025-08-05T09:54:24.230+03:00'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: update
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: PUT
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/payment_requests/{payment_request_uid}
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                payment_request:
                  properties:
                    currency:
                      description: The currency of the payment request
                      type: string
                    net_price:
                      description: net price of the payment request
                      type: number
                    price:
                      description: total price of the payment request
                      type: number
                    price_before_coupon:
                      description: The price before coupon. if the payment request contain taxes, then this field value is depended on the tax_mode. if taxes are included inside the value, then the price_before_coupon value should include taxes. otherwise, it should not include taxes.
                      type: number
                    tax_uids:
                      description: Array of tax_uids (strings)
                      items:
                        type: string
                      type: array
                  type: object
              required:
              - payment_request
              type: object
      security:
      - Bearer: []
      operationId: putBusinessPaymentsV1PaymentRequestsByPaymentRequestUid
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
  /business/payments/v1/payment_requests/{payment_request_uid}/send_link:
    post:
      description: '## Overview

        Send payment request link Available for **Staff tokens**.'
      parameters:
      - description: Payment Request UID
        in: path
        name: payment_request_uid
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                data: {}
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Send payment request link
      tags:
      - Payment Requests
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: '201'
        type: http_proxy
        uri: https:///business/payments/v1/payment_requests/{payment_request_uid}/send_link
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                channel:
                  description: Delivery channel. Use `email` or `sms`.
                  type: string
                channel_value:
                  description: Email address or phone number to send the link to (e.g., "test@example.com" or "+12125551234").
                  type: string
                alpha2:
                  description: ISO 3166-1 alpha-2 country code for SMS delivery (e.g., "US").
                  type: string
                amount:
                  description: Optional partial amount to request (e.g., 25.5).
                  type: number
              required:
              - channel
              type: object
      security:
      - Bearer: []
      operationId: postBusinessPaymentsV1PaymentRequestsByPaymentRequestUidSendLink
      x-operation-id-source: derived
    servers:
    - url: https://api.vcita.biz
      description: Unified API Gateway server
components:
  securitySchemes:
    ActivitySources:
      type: http
      scheme: bearer
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
    Notes:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
    ClientMessaging:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid client bearer token in the Authorization header. Example: ''Authorization: Bearer {client_token}'''
    ClientPaymentCards:
      type: http
      scheme: bearer
      description: Provide a valid bearer token in the Authorization header.
    PaymentPlans:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
x-refined-from:
- vcita-clients-api-openapi.yml
- vcita-sales-api-openapi.yml