Setting up the Bill Payment Service

Setting up the Bill Payment Service

To use the CityPay Bill Payment Service, please get in touch with CityPay using: support@citypay.com.

Requirements

Before setting up the Bill Payment Service in MediBooks please ensure that you have received your payment request details from CityPay. You will need the following information to proceed:
  1. Client ID
  2. License Ley
  3. Merchant ID (MID)
In addition please ensure that CityPay have whitelisted your IP address, CityPay will request this when they send though the credentials. You can find your IP on websites such as www.whatismyip.com.

The whitelist is a list of IP addresses that are allowed to complete certain actions relating to Payment Requests, the service will not be able to connect with MediBooks until this has been completed. It is like only allowing telephone calls from people with specific phone numbers. 

Setting up the Billing Payment Service

First open the System Setup page on MediBooks. To open this page click on the Blue Plus (+) at the top left of the page, then select [Settings], then finally click on [System Setup].


Click on [Virtual Terminal] from the menu on the left side of the window. Here you will see the Payment Request setup options, an image of this has been included below. It has been annotated to highlight the Virtual Terminal Settings.


First ensure that the "Enable" checkbox has been ticked, this will allow you to change the content in the boxes.


Copy your account details from CityPay into the relevant boxes in MediBooks.

The URL should be https://api.citypay.com

The Notifications email is used to inform your practice whenever a successful payment has been made. Any valid email can be used here.

Once the details have been entered use [Test Settings] if it is working as expected a message saying "The CityPay connection succeeded in ... seconds." will be shown. If another message is shown please read: Bill Payment Service Troubleshooting 

Click [Save].



    • Related Articles

    • 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 ...

    • 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 ...

    • Setting Payment Methods for use with the Bill Payment Service

      To mark a Payment Method as a Payment Request type, first open the Payment Methods page which is found in the System tab. Then using the grid, tick the checkboxes in the Active and Payment Request column for any Payment Methods that you want to be ...

    • Payment Requests

      From version 7.27 of MediBooks it is possible to send online payment requests to customers. Payment Requests are a service provided by CityPay, their support details can be found here: Contacts | CityPay. This article will give an overview of all ...

    • Process for setting up customers in bulk

      By using the grid filters the Customer Details report can be used to locate and enable online payment services for customers that are most likely to benefit from this service This tutorial will go through the process of enabling online bill payment ...