CityPay Integration

CityPay Integration

Credit card and debit card payments can be processed in Medibooks via the CityPay Virtual Terminal.

CityPay Settings

The virtual terminal settings can be found in the Virtual Terminal section of the Settings dialog.


The Paylink Merchant ID and Paylink Licence Key fields need to be entered into the Settings dialog. Click on the [Test Settings] button to see if the field values are correct and a connection can be established with CityPay from within Medibooks.


If the test is successful, click on the [Save] or [Apply] buttons at the bottom of the Settings dialog.

Processing Payments

When a payment is processed via the Payment screen and Credit Card or Debit Card is chosen as the Payment Method, a CityPay payment form will be displayed after the [Post to Account] button is clicked.



Enter the information required in the Card Details section. The other sections are optional. Click on the [Process] button at the bottom of the form once the required information is completed.


    • Related Articles

    • CityPay Card Payments Failing

      When taking card payments using the Virtual Terminal an error message may be shown. ThIS often due to missing or incorrect configuration settings. Examples of error messages where this is likely the case are: Paylink request failed: Forbidden Paylink ...
    • Medicus Integration

      Syncing To sync MediBooks with Medicus, select the patient you would like to sync and select "Administrative Record" using the menu on the left. Open the "Billing" option at the top of the page and select "View account" to open the account overview ...
    • Posting Payment Requests

      Posting Payment Requests individually Payment requests can be posted on an ad hoc basis (for example when a customer has come into the surgery having already paid some of their outstanding balance. To do this, with the customer already selected open ...
    • Bill Payment Service Troubleshooting

      Posting Payment Requests If while attempting to post a payment request an error saying: "Client Side: Failed to send payment request. Payment Request failed, { ...." please contact CityPay for more help. Setting up the Bill Payment Service If when ...
    • Changing the content of Payment Request Emails/SMS

      The functionality described in this article will be available from v7.38 of MediBooks The content of the SMS/emails sent by the Bill Payment Service is controlled using templates. These are created and managed by CityPay, please contact their if your ...