Commit Payment

Processes and commits citizen payment information for the specified payment transaction ID. The Commit Payment API allows a third-party payment vendor to send payment information to Automation. The Commit Payment API processes the payment information, logs merchant account audit information, triggers the EMSE events ConvertToRealCAPBefore and PaymentReceiveBefore, creates a transaction record, triggers the EMSE event ConvertToRealCAPAfter, finishes the Automation payment, triggers the EMSE event PaymentReceiveAfter, and appoves the transaction.

Note: An agency Construct administrator controls which apps can call Commit Payment. By default, Commit Payment is disabled. To allow an app to call Commit Payment, an agency administrator must go to the {Agency}:Apps page on the Construct Admin Portal, and enable the Payment Enabled property for the app.

Resource Information

Scope	payments Deprecated scope name: confirm_payment
App Type	Citizen
Authorization Type	Access token
URI	/V4/payments/{id}?fields={fields}&lang={lang}
HTTP Method	PUT
Automation Version(s)	7.3.3.4

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
amount	double	Yes	�	The payment amount.	7.3.3.4
comments	string	No	�	Comments related to the payment transaction.	7.3.3.4
convenienceFee	double	Yes	�	The payment convenience fee to be applied. Set to 0 if none.	7.3.3.4
creditCard	creditCard{}	No	�	The credit card information.	7.3.3.4
creditCard.billingAddress	creditCard.billingAddress{}	No	�	The credit card address.	7.3.3.4
creditCard.billingAddress.addressLine1	string	No	�	The first line of the address.	7.3.3.4
creditCard.billingAddress.addressLine2	string	No	�	The second line of the address.	7.3.3.4
creditCard.billingAddress.addressLine3	string	No	Get All Address Unit Types	The current status of the address record.	7.3.3.4
creditCard.billingAddress.city	string	No	�	The name of the city.	7.3.3.4
creditCard.billingAddress.countryCode	string	No	Get All Address Countries	The name of the country. Required if billing address is provided.	7.3.3.4
creditCard.billingAddress.postalCode	string	No	�	The name of the county.	7.3.3.4
creditCard.billingAddress.state	string	No	Get All Address States	The state corresponding to the address on record.	7.3.3.4
creditCard.businessName	string	No	�	A secondary business name for the applicable individual.	7.3.3.4
creditCard.cardNumberLastDigits	string	No	�	The last 4 digits of the credit card number.	7.3.3.4
creditCard.cardType	string	Yes	�	The credit card type. For example, Visa, American Express, or Discover.	7.3.3.4
creditCard.holderName	string	No	�	The check holder's name.	7.3.3.4
merchantAccountId	string	No	�	The account ID of the merchant receiving the payment.	7.3.3.4
payeePhone	string	No	�	The area code and phone number of the payee.	7.3.3.4
paymentMethod	string	Yes	Credit Card \| Check	The method of payment, either Credit Card or Check.	7.3.3.4
paymentSystemTransactionId	string	Yes	�	The third party payment system's payment transaction ID.	7.3.3.4
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.3.4
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.4
lang	String	No	�	Indicates the language applied.	7.3.3.4

Example

Sample Request Head

PUT  https://apis.accela.com/v4/payments/322931

Sample Request Body

{
  "amount": "100.50",
  "convenienceFee": "0",
  "payeePhone": "4067615677",
  "paymentMethod": "Credit Card",
  "paymentSystemTransactionId": "d1f63549-8fd1-4be5-abf8-e624897044be",
  "creditCard": {
    "cardType": "VISA",
    "cardNumberLastDigits": "*4219",
    "holderName": "Jane Johnston"
  }
}

Notes

This example commits payment information for a third-party payment transaction id #322931.

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.3.4
result.completePayments	result.completePayments{}	An array containing the completed payment transaction.	7.3.3.5.0
result.completePayments.paymentId	string	The payment id.	7.3.3.5.0
result.completePayments.paymentStatus	string	The payment status (currently, this field always returns "PAID").	7.3.3.5.0
result.completePayments.receiptId	string	The payment receipt id.	7.3.3.5.0
result.completePayments.recordId	result.completePayments.recordId{}	The record id the payment is applied to.	7.3.3.5.0
result.completePayments.serviceProviderCode	string	The unique agency identifier.	7.3.3.5.0
result.message	string	Response message for the payment transaction.	7.3.3.4
status	integer	The record status.	7.3.3.4

Example

Sample Response Body

{
  "result": {
    "completePayments": [
      {
        "receiptId": "198284",
        "serviceProviderCode": "TACOMA",
        "recordId": "TACOMA-03HST-00000-002UD",
        "customId": "BLD2003-01115",
        "paymentId": 3166539,
        "paymentStatus": "Paid"
      }
    ]
  },
  "status": 200
}