Create New Payment

post

https://api.vcita.biz/platform/v1/payments

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

required

amount

client_id

string

required

client ID

currency

string

required

USD, ILS etc.

fees

array of objects

Array of fees (Max 1 fee)

fees

mark_as_online

boolean

Enable online refund. Default is disabled

other_payment_method

string

Max 24 chars

paid_at

string

default is now

pay_key

string

Max 64 chars

payment_method

string

required

'PayPal', 'Other', 'Cash', 'Credit Card', 'Bank Transfer', 'Cheque'

payment_subject_id

string

The ID of the entity for which the payment has been made

payment_subject_type

string

The type of entity for which the payment has been made. Available types: 'Meeting', 'EventAttendance', 'Invoice', 'ClientBookingPackage', 'ProductOrder'.

reference

string

Max 24 chars

send_receipt

boolean

true, false. default true

staff_id

string

Default is set to the staff that performed the API call. Business owner is allowed to send staff_id

state

string

The current payment state. This field can be used only for creating a pending payment. Value can be only 'pending'

tips

array of objects

Array of tips (Max 1 tip)

tips

title

string

required

paid for service or product

Headers

X-On-Behalf-Of

string

A unique identifer of the business. Can be the Business UID or nickname\external ID

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment Created