API Reference

Send checkout update by webhook

put
https://api.vcita.biz/platform/v1/payment/checkout/

Overview

Update a checkout process from webhook Available for Staff, Directory, and Client tokens.

Important

This is a webhook endpoint designed to be called by external payment providers (Stripe, etc.) after checkout completion. The url_key must be from an active checkout session (PaymentProcessRequest), not a payment request UID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

The charged amount (You should send this only if you are in sync_flow)

card
object

The saved card info - (You should send this only if client want to save the card)

string

the date of the payment

string

The customer unique id (You should send this only if client want to save the card)

fees
array of objects

Array of fees (Max 1 fee) (Relevant only for when sync_flow is not true)

fees
string

The payment method which was used in checkout. Available methods: 'Credit Card', 'Bank Payment - ACH'.

string

The payment status uid (You should send this only if you are in sync_flow)

string

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

boolean

You should send true in case it is a post checkout flow

tips
array of objects

Array of tips (Max 1 tip) (Relevant only for when sync_flow is not true)

tips
string

The external payment gateway transaction id

string

checkout.session.completed

string

The url_key from an active checkout session (PaymentProcessRequest). This is NOT the payment request UID - it's a unique key generated when the checkout session is created.

Response

Updated 21 days 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 21 days ago