CoBrand+ payment adapter

Configure convenience fee

1. Make sure convenience fee is not configured at the payment gateway (CoBrand+ ) account level. If it is, the fee will be charged twice after configuration.

2. Configure Standard Choice CONV_FEE with these values (as necessary):

   Standard Choice Value	Value Desc
   [Payment Type]_[Module] Examples: Check, Check_Building, Check_Licenses, Credit Card, Credit Card_Building, Credit Card_Licenses	PERCENTAGE_x.xx - For a percentage of the total. Example: PERCENTAGE_0.05 for 5%. FIXED_x.x - For a fixed rate as the fee. Example: FIXED_3.5 for $3.50.

3. Configure Standard Choice EPaymentAdapter with this value:

   Standard Choice Value	Value Desc
   ACAAdapterType	OPCoBrandPlust_Test

4. Update the XPOLICY for the payment adapter. Add this information to the data3 column with this script for Oracle:

   update xpolicy set 
                           data3='RequestParameterMap=productId:
                           $$ProductId$$,address1:$$Address1$$,
                           cde-NotiNumb-0:$$CAPID$$,cde-UniqID-1:
                           $$UNIQUEID$$,ityName:$$City$$,
                           email:$$Email$$,firstName:$$FirstName$$,
                           lastName:$$LastName$$,middleName:
                           $$MiddleName$$,paymentAmount:
                           $$PaymentAmount$$,phoneNum:$$PhoneNum$$,
                           postalCd:$$Zip$$,provinceCd:$$State$$,
                           cde-Numbof-2:$$NUMBERITEMS$$,
                           returnUrl:$$ReturnUrl$$,postbackUrl:
                           returnUrl:$$ReturnUrl$$,postbackUrl:
                           $$PostbackUrl$$,payBy:$$PayBy$$;
                           PostbackParameterMap=uid:$$UNIQUEID$$,
                           account_type:$$AccountType$$,address1:
                           $$Address1$$,address2:$$Address2$$,address3:
                           $$Address3$$,confirmation:$$Confirmation$$,
                           email:$$Email$$,first_name:$$FirstName$$,
                           last_name:$$LastName$$,middle_name:
                           $$MiddleName$$,suffix:$$Suffix$$,telephone:
                           $$PhoneNum$$'
                           
                           commit;

   Or this code for MSSQL:

   update xpolicy set 
                           data3='RequestParameterMap=productId:
                           $$ProductId$$,address1:$$Address1$$,
                           cde-NotiNumb-0:$$CAPID$$,cde-UniqID-1:
                           $$UNIQUEID$$,ityName:$$City$$,
                           email:$$Email$$,firstName:$$FirstName$$,
                           lastName:$$LastName$$,middleName:
                           $$MiddleName$$,paymentAmount:
                           $$PaymentAmount$$,phoneNum:$$PhoneNum$$,
                           postalCd:$$Zip$$,provinceCd:$$State$$,
                           cde-Numbof-2:$$NUMBERITEMS$$,
                           returnUrl:$$ReturnUrl$$,postbackUrl:
                           $$PostbackUrl$$,payBy:$$PayBy$$;
                           PostbackParameterMap=uid:$$UNIQUEID$$,
                           account_type:$$AccountType$$,address1:
                           $$Address1$$,address2:$$Address2$$,address3:
                           $$Address3$$,confirmation:$$Confirmation$$,
                           email:$$Email$$,first_name:$$FirstName$$,
                           last_name:$$LastName$$,middle_name:
                           $$MiddleName$$,suffix:$$Suffix$$,telephone:
                           $$PhoneNum$$'
                           
                           go

   PayBy is added as new request parameter, which is used to restrict the selection the payment method on the Accela page only before the redirect to the payment gateway.

Convenience fee in Citizen Access

In Citizen Access, when a new application is started, the payment screen should now display the convenience fee options.

Submitting payment redirects to the official payment gateway with the total amount including the convenience fee. The payment can be completed as normal.

Verify receipt of a convenience fee

1. Log into Civic Platform
2. Search for and open a record with a completed payment.
3. Click the Payment tab.

4. Click the Transaction Code. The fee should display in the Convenience Fee field.