Request Payment

The following command block is an example of how to request a payment from the clients on the case:

--incase-cmd
{types:REQUEST_PAYMENT}
{caseReference:ABC123-1}
{title:Payment on Account}
{reference:ABC123-1/POA001}
{paymentDescription:Payment on Account}
{amount:123.45}
--incase-cmd-end

Request Payment Parameter Definitions

The following table describes the parameters that can be used in the request payment command block:

Parameter	Type	Required	Default	Repeatable	Description
brackets	Enum: {, [, <	No	{	No	The encapsulating brackets to use
notifySuccess	Email Address	No		No	Who to notify upon successful completion
notifyError	Email Address	No	Email Return Address	No	Who to notify of processing errors, if not specified then the email return address will be used
quietMode	True, False	No	False	No	If true then turn off all notifications
types	REQUEST_PAYMENT	Yes		No	The type of command to be performed
caseReference	String	Yes		No	The case reference, a unique identifier you use to identify the case
title	String	Yes		No	A brief description of the payment
paymentDescription	String	Yes		No	The description of what the payment is regarding, for the client
reference	String	Yes		No	Your reference for the payment so that you can match it when it is authorised
amount	Decimal	Yes		No	The amount that is required to be paid
currency	Enum: GBP	No	GBP	No	The currency to take payment in, currently supports GBP
sendPushNotification	Boolean	No	True	No	Whether to send a notification to the users devices
bundleIdentifier	String	No		No	The bundle identifier to associate to or create an event bundle that this payment is attached to, refer to the event bundle documentation for more information
bundleRecipients	Email Addresses (comma separated)	No		No	The bundle recipients, comma separated email addresses, who will receive a notification when the event bundle has been completed
bundleReminder	Reminder String	No		Yes	An event bundle reminder, to be sent when the event bundle has not been completed, please refer to the event bundle documentation
credentialsId	Integer	No		No	Only to be used when specifically requested to do so, when multiple payment accounts have been configured

02 July 2026