Toggle menu

Payment - Civica Action

The deprecated Civica action attempts to make a web payment to the Civica paylink system based upon values in the submitted form.

Note: This field type requires platform specific template support which no longer exists in any of our frameworks, which now all use the Forms Service.

Properties

LabelDescriptionType Name
Back Button UrlUrl for Civica to return to if 'Back' button clickedBACKBUTTONURL
Calling Application IdThe Id of the application making the payment (mandatory)

Instructs the Civica ICON system what application is making the payment

CALLINGAPPLICATIONID
Functional classThe class and assembly that will handle the form action on successful form submissionCLASS
General Ledger codeThe general ledger codeGENERALLEDGERCODE
Payment listA series of '|' delimited payment lines

Each line has the following fields, delimited by '|'. This means that the '|' character cannot be present in any of these values

Items in payment line
FieldMax lengthRequired
Reference35Yes
Fund Code5Yes
Amount12Yes
Vat Code5No
Narrative100No
Business name50No*
Premise Number50No*
Premise Name50No*
Street50No*
Area50No*
Town50No*
County50No*
Post Code10No*
Alternative Account Ref35No
Line Based Refund Number12No*
Charge Parent12No*

Items marked with * will be made available in Civica as a possible card holder address.

PAYMENTLIST
Payment Source CodeIdentifies the payment typePAYMENTSOURCECODE
Refund Receipt NoIdentifies the original repayment for refundsREFUNDRECEIPTNO
Return UrlThe Url to return to when the payment process is complete (mandatory)

This value must be a fully qualified url. If a value is not set for this property, the action will attempt to provide this automatically based upon the context it is executed in.

RETURNURL
Stop processing on errorStop the processing of subsequent actions on failureSTOPPROCESSINGONERROR
Transaction ReferenceA reference for the payment being made (optional)TRANSACTIONREFERENCE
Civica UrlThe Url of the Civica payment applicationURL
Last modified on 20 January 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon