vCita Payments API
The Payments API from vCita — 7 operation(s) for payments.
The Payments API from vCita — 7 operation(s) for payments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/vcita:vcita-payments-api"
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.
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: 3.2.0
info:
title: Vcita Payments API
version: '3.0'
x-refined-note:
- x-generated differs across the merged source definitions and was not carried
description: 'Operations tagged Payments 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: Payments
paths:
/client/payments/v1/payments:
get:
description: '## Overview
Show list of payments.
## Authentication
**Available for Client Tokens only.**'
parameters:
- description: relevant matter_uid to fetch payments 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, payment_status_uid. example: filter[state][in]=paid&filter[payment_status_uid][in]=123.'
in: query
name: filter
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
payments:
- amount: 50
amount_refunded: '0.0'
assignable: null
business_uid: fc766c51080b64b7
created_at: '2025-08-05T06:55:31Z'
currency: USD
fees: null
is_deposit: null
mapping_metadata: {}
marked_as_online: false
matter_uid: h330nmo78dot1jc6
other_payment_method: null
paid_online: false
payment_method: Cash
payment_request_uid: null
payment_time: '2025-08-05T06:55:31Z'
provider_state: null
provider_transaction_id: null
reference: null
refunded_at: null
scheduled_payments_rule_uid: null
state: paid
tips: null
title: Cookie
uid: n8byn15vnj2jb4bs
updated_at: '2025-08-05T06:55:31Z'
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Show Payments List
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///client/payments/v1/payments
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getClientPaymentsV1Payments
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/platform/v1/clients/{client_id}/payments:
get:
description: '## Overview
Gets a list of payments for a client.
## Authentication
**Available for Staff, App, and Directory Tokens.**'
parameters:
- description: client's id
in: path
name: client_id
required: true
schema:
type: string
- description: "Available filters: state: filter[state][in]=paid,pending,failed,refunded,cancelled,archived,incompleted.\n created_at: filter[created_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00.\n updated_at: filter[updated_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00."
in: query
name: filter
required: false
schema:
type: string
- description: "Sort by one of the following: created_at, updated_at.\n Available operators: asc, desc.\n Example: sort=created_at:asc,updated_at:desc"
in: query
name: sort
required: false
schema:
type: string
- description: Page offset
in: query
name: page
required: false
schema:
type: string
- description: Page size
in: query
name: per_page
required: false
schema:
type: string
responses:
'201':
description: Payments Returned
content:
application/json:
example:
data:
payments:
- amount: 300
charged_at: 23/4/2019 09:00:00
client_id: '12344'
conversation_id: '1234'
currency: USD
fees:
- amount: 13
name: Taylor Swift Fee
id: '1234'
note: Payment Note
offline: true
other_payment_method: bit
payment_method: cash/check
payment_requests:
- id: '1246'
reference: '123'
state: paid/refunded
tips:
- amount: 100
title: Payment Title
status: OK
'422':
description: Unauthorized - User does not have permission to access this client's payments
content:
application/json:
example:
status: Error
error: Unauthorized
summary: Get Payments of Client
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
requestParameters:
integration.request.path.client_id: method.request.path.client_id
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients/{client_id}/payments
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getPlatformV1ClientsByClientIdPayments
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/business/payments/v1/payments:
get:
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
responses:
'200':
description: Payments Returned
content:
application/json:
example:
data:
data:
payments:
- amount: 550
business_uid: 6bms9hebq9uv6ptm
created_at: '2023-03-29T17:07:11Z'
currency: ILS
marked_as_online: false
matter_uid: aso2xnyeg1zytb4w
net_total: 500
other_payment_method: null
paid_online: false
payment_method: Cash
payment_request_uid: oic742ep8r7oxkl5
payment_time: '2023-03-29T17:06:59Z'
provider_state: null
provider_transaction_id: null
reference: null
state: paid
taxes:
- name: TTT
rate: 10
tax_total: 50
title: 'INVOICE #0000011'
uid: 49trm2x2vj43gita
updated_at: '2023-03-29T17:07:13Z'
success: true
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: missing
message: Not Found
success: false
summary: List Payments
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///business/payments/v1/payments
x-auth-type: Application & Application User
description: '## Overview
List Payments. Available for **Staff Tokens**.'
security:
- Bearer: []
operationId: getBusinessPaymentsV1Payments
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/business/payments/v1/payments/{payment_uid}:
get:
parameters:
- description: payment id
in: path
name: payment_uid
required: true
schema:
type: string
responses:
'200':
description: Payment found
content:
application/json:
example:
data:
data:
payment:
amount: 550
business_uid: 6bms9hebq9uv6ptm
created_at: '2023-03-29T17:07:11Z'
currency: ILS
marked_as_online: false
matter_uid: aso2xnyeg1zytb4w
net_total: 500
other_payment_method: null
paid_online: false
payment_method: Cash
payment_request_uid: oic742ep8r7oxkl5
payment_time: '2023-03-29T17:06:59Z'
provider_state: null
provider_transaction_id: null
reference: null
state: paid
taxes:
- name: TTT
rate: 10
tax_total: 50
title: 'INVOICE #0000011'
uid: 49trm2x2vj43gita
updated_at: '2023-03-29T17:07:13Z'
success: true
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: missing
field: payment_uid
message: Not Found
success: false
summary: Get Payment
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
requestParameters:
integration.request.path.payment_uid: method.request.path.payment_uid
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///business/payments/v1/payments/{payment_uid}
x-auth-type: Application & Application User
description: '## Overview
Get Payment. Available for **Staff Tokens**.'
security:
- Bearer: []
operationId: getBusinessPaymentsV1PaymentsByPaymentUid
x-operation-id-source: derived
put:
parameters:
- description: If the payment's internal uid is known, use it. Otherwise, set it to be the transaction_id and set use_external_id to be true
in: path
name: payment_uid
required: true
schema:
type: string
responses:
'200':
description: Payment Updated
content:
application/json:
example:
data:
payment:
amount: 550
business_uid: 6bms9hebq9uv6ptm
created_at: '2023-03-29T17:07:11Z'
currency: ILS
marked_as_online: false
matter_uid: aso2xnyeg1zytb4w
net_total: 500
other_payment_method: null
paid_online: false
payment_method: Cash
payment_request_uid: oic742ep8r7oxkl5
payment_time: '2023-03-29T17:06:59Z'
provider_state: null
provider_transaction_id: m73jkvg4bf2z71b2
reference: null
state: paid
taxes:
- name: TTT
rate: 10
tax_total: 50
title: 'INVOICE #0000011'
uid: 49trm2x2vj43gita
updated_at: '2023-03-29T17:07:13Z'
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Update Payment
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: PUT
requestParameters:
integration.request.path.payment_uid: method.request.path.payment_uid
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///business/payments/v1/payments/{payment_uid}
x-auth-type: Application & Application User
description: '## Overview
Update Payment Available for **Staff, App, and Directory tokens**.'
requestBody:
content:
application/json:
schema:
properties:
payment:
properties:
error_data:
properties:
message:
description: Error message for a failed payment
type: string
type: object
provider_state:
description: Custom state set by gateway provider
type: string
state:
description: 'The updated state of a payment. For ''pending'' payment, it can be either ''paid'' or ''failed''. For ''paid'' payment, it can be either ''cancelled'' or ''refunded'' '
type: string
type: object
use_external_id:
description: Set it to true if payment_uid is the transaction_id. Otherwise, ignore this parameter.
type: boolean
required:
- payment
type: object
security:
- Bearer: []
operationId: putBusinessPaymentsV1PaymentsByPaymentUid
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/platform/v1/payments:
get:
parameters:
- description: A unique identifer of the business. Can be the Business UID or nickname\external ID
in: header
name: X-On-Behalf-Of
schema:
type: string
- description: Page offset
in: query
name: page
required: false
schema:
type: string
- description: Page size
in: query
name: per_page
required: false
schema:
type: string
- description: "Available filters: state: filter[state][in]=paid,pending,failed,refunded,cancelled,archived,incompleted.\n created_at: filter[created_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00.\n updated_at: filter[updated_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00.\n client_id: filter[client_id][eq]=client_id.\n invoice_id: filter[invoice_id][eq]=invoice_id."
in: query
name: filter
required: false
schema:
type: string
- description: "Sort by one of the following: created_at, updated_at.\n Available operators: asc, desc.\n Example: sort=created_at:asc,updated_at:desc"
in: query
name: sort
required: false
schema:
type: string
responses:
'201':
description: Payments Returned
content:
application/json:
example:
data:
payments:
- amount: 300
charged_at: 23/4/2019 09:00:00
client_id: '12344'
conversation_id: '1234'
currency: USD
fees:
- amount: 13
name: Taylor Swift Fee
id: '1234'
note: Payment Note
offline: true
other_payment_method: bit
payment_method: cash/check
payment_requests:
- id: '1246'
reference: '123'
state: paid/refunded
tips:
- amount: 100
title: Payment Title
status: OK
summary: Get Payments List
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/payments
x-auth-type: Application & Application User
description: '## Overview
Get Payments List. Available for **Staff Tokens**.
## Prerequisites
The business must have the `payments_module` feature enabled.'
security:
- Bearer: []
operationId: getPlatformV1Payments
x-operation-id-source: derived
post:
parameters:
- description: A unique identifer of the business. Can be the Business UID or nickname\external ID
in: header
name: X-On-Behalf-Of
schema:
type: string
responses:
'201':
description: Payment Created
content:
application/json:
example:
data:
payment:
amount: 150
client_id: aaabbbccc112233
conversation_id: aaabbbccc112233
created_at: '2019-10-16T13:05:43Z'
currency: USD
fees:
- amount: 13
name: Taylor Swift Fee
marked_as_online: false
other_payment_method: bit
paid_at: '2019-10-15T13:05:43Z'
paid_offline: true
pay_key: '123456'
payment_action: record_payment
payment_id: aaabbbccc112233
payment_method: credit_card
reference: '123'
send_receipt: true
staff_id: aaabbbccc112233
state: paid
tips:
- amount: 100
title: Payment Title
status: OK
summary: Create New Payment
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/payments
x-auth-type: Application & Application User
description: '## Overview
Create New Payment. Available for **Staff, App, and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header.
## Prerequisites
The business must have the `payments_module` feature enabled to use this endpoint.'
requestBody:
content:
application/json:
schema:
properties:
amount:
description: amount
type: number
client_id:
description: client ID
type: string
x-reference-to: clients.contact
currency:
description: USD, ILS etc.
type: string
fees:
description: Array of fees (Max 1 fee)
items:
properties:
amount:
description: Fee amount
type: number
name:
description: Fee name (Max 35 chars)
type: string
required:
- name
- amount
type: object
type: array
mark_as_online:
description: Enable online refund. Default is disabled
type: boolean
other_payment_method:
description: Max 24 chars
type: string
paid_at:
description: default is now
type: string
pay_key:
description: Max 64 chars
type: string
payment_method:
description: 'Payment method. IMPORTANT: When state is ''pending'', the only allowed value is ''Bank Transfer''. For completed (paid) payments (when state is omitted), any value is accepted.'
type: string
enum:
- PayPal
- Other
- Cash
- Credit Card
- Bank Transfer
- Cheque
payment_subject_id:
description: The ID of the entity for which the payment has been made
type: string
payment_subject_type:
description: 'The type of entity for which the payment has been made. Available types: ''Meeting'', ''EventAttendance'', ''Invoice'', ''ClientBookingPackage'', ''ProductOrder''.'
type: string
reference:
description: Max 24 chars
type: string
send_receipt:
description: true, false. default true
type: boolean
staff_id:
description: Default is set to the staff that performed the API call. Business owner is allowed to send staff_id
type: string
x-reference-to: access_control.staff
state:
description: Optional. When provided, the ONLY accepted value is 'pending' (creates a pending/unpaid payment that requires Bank Transfer as payment_method). If this field is omitted entirely, the payment is created as completed/paid by default. Do NOT pass 'paid' — it will be rejected.
type: string
enum:
- pending
tips:
description: Array of tips (Max 1 tip)
items:
properties:
amount:
description: Tip amount
type: number
required:
- amount
type: object
type: array
title:
description: paid for service or product
type: string
required:
- client_id
- payment_method
- currency
- amount
- title
type: object
security:
- Bearer: []
operationId: postPlatformV1Payments
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/platform/v1/payments/{payment_uid}:
get:
parameters:
- description: Payment UID
in: path
name: payment_uid
required: true
schema:
type: string
responses:
'201':
description: Payment Returned
content:
application/json:
example:
data:
payment:
- amount: 300
charged_at: 23/4/2019 09:00:00
client_id: '12344'
conversation_id: '1234'
currency: USD
fees:
- amount: 13
name: Taylor Swift Fee
id: '1234'
note: Payment Note
offline: true
other_payment_method: bit
payment_method: cash/check
payment_requests:
- id: '1246'
reference: '123'
state: paid/refunded
tips:
- amount: 100
title: Payment Title
status: OK
summary: Get Payment by ID
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
requestParameters:
integration.request.path.payment_id: method.request.path.payment_id
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/payments/{payment_uid}
x-auth-type: Application & Application User
description: '## Overview
Get Payment by ID. Available for **Staff Tokens**.
## Prerequisites
The business must have the `payments_module` feature enabled.'
security:
- Bearer: []
operationId: getPlatformV1PaymentsByPaymentUid
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/platform/v1/payments/{payment_uid}/match:
post:
parameters:
- description: relevant payment UID
in: path
name: payment_uid
required: true
schema:
type: string
responses:
'201':
description: Payment Matched
content:
application/json:
example:
data:
payment:
amount: 1
client_id: jfcomkyykiz0mqkw
conversation_id: lzxxiv5euh8z18qw
created_at: '2022-01-19T12:26:15Z'
currency: ILS
marked_as_online: false
other_payment_method: bit
paid_at: '2022-01-19T12:26:05Z'
paid_offline: true
payment_action: record_payment
payment_id: 2ulfclwzu8yksj9u
payment_method: Cash
reference: '123'
send_receipt: true
source_data:
campaign: '1'
channel: '1'
name: initiated_by_staff
website_url: '1'
state: paid
status: OK
summary: Match Payment
tags:
- Payments
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/payments
x-auth-type: Application & Application User
description: '## Overview
Match Payment Available for **Staff, App, and Directory tokens**.'
requestBody:
content:
application/json:
schema:
properties:
matter_uid:
description: 'The matter uid of the relevant payment. **Important**: The matter_uid must match the conversation_id of the specified payment. The payment must have been created within the context of this matter. If mismatched, the API will return ''Payment does not belong to matter'' error.'
type: string
x-reference-to: clients.matter
payment_status_uid:
description: The uid of the relevant payment request to match
type: string
x-reference-to: sales.payment_status
required:
- matter_uid
- payment_status_uid
type: object
security:
- Bearer: []
operationId: postPlatformV1PaymentsByPaymentUidMatch
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