Provider guide

CityPay

Integration notes, required parameters, test details and example requests for integrating CityPay with the Revo PCI platform.

Test integration Provider support

At a glance

Supported transaction type

Supported modes

SALE

Important

CityPay require that all payments sent to them always have a unique id, if you try to make a payment with the same identifier it will get rejected.

Testing

Test card details

Card Number:

4111111111111111

Expiry Date:

0431

CVV:

123

Overview

Integration requirements

Required parameters

transactionType

Currently only 'SALE' is supported which will take a payment from the requested card, more options can be added on request.

merchantId

This is provided by Citypay.

licenseKey

This is provided by Citypay.

amount

Always has to be a whole number, for example £2 is 200.

identifier

Unique identifier for this payment. We always recommend using a GUID / UUID for payment references, you can see an example here.

Optional parameters

CityPay may support other parameters not currently integrated into the PCI platform, more information can be found here, if you would like any integrated please contact us.

Reference

Example request

cURL exampleAPI request

curl --location 'https://api.revopci.co.uk/' \
            --header 'X-Session;' \
            --header 'X-Auth;' \
            --header 'Content-Type: application/json' \
            --data '{
            "provider": "citypay",
            "mode": "test",
            "method": "payment",
            "parameters":
            {
            "transactionType": "SALE",
            "merchantId": "",
            "licenseKey": "",
            "amount": "200",
            "identifier": "00000000-0000-0000-0000-000000000000"
            }
            }'