README

Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments.

Compliance and Security Overview

Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council.

Key Compliance and Security Measures

TLS Encryption: All data transmissions must utilise TLS version 1.2 or higher, employing strong cryptography. Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities.
Data Storage Prohibitions: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden.
Data Masking: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation.
Network Scans: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence.
PCI Compliance: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website https://www.pcisecuritystandards.org/.
Request Validation: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.

Getting Started

Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.

For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.

Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.

For more information, please visit https://www.citypay.com/contacts/.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/citypay/citypay-api-client-php.git"
    }
  ],
  "require": {
    "citypay/citypay-api-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/CityPay/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: cp-api-key
$config = CityPay\Configuration::getDefaultConfiguration()->setApiKey(cp-api-key, $apiKey = ApiKey::newKey($clientId, $licenceKey);
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CityPay\Configuration::getDefaultConfiguration()->setApiKey(cp-api-key, $apiKey = ApiKey::newKey($clientId, $licenceKey);


$apiInstance = new CityPay\Api\AuthorisationAndPaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$auth_request = new \CityPay\Model\AuthRequest(); // \CityPay\Model\AuthRequest

try {
    $result = $apiInstance->authorisationRequest($auth_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorisationAndPaymentApi->authorisationRequest: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.citypay.com

Class	Method	HTTP request	Description
AuthorisationAndPaymentApi	authorisationRequest	POST /v6/authorise	Authorisation
AuthorisationAndPaymentApi	binRangeLookupRequest	POST /v6/bin	Bin Lookup
AuthorisationAndPaymentApi	cResRequest	POST /v6/cres	CRes
AuthorisationAndPaymentApi	captureRequest	POST /v6/capture	Capture
AuthorisationAndPaymentApi	createPaymentIntent	POST /v6/intent/create	Create a Payment Intent
AuthorisationAndPaymentApi	paResRequest	POST /v6/pares	PaRes
AuthorisationAndPaymentApi	refundRequest	POST /v6/refund	Refund
AuthorisationAndPaymentApi	retrievalRequest	POST /v6/retrieve	Retrieval
AuthorisationAndPaymentApi	voidRequest	POST /v6/void	Void
BatchProcessingApi	batchProcessRequest	POST /v6/batch/process	Batch Process Request
BatchProcessingApi	batchRetrieveRequest	POST /v6/batch/retrieve	Batch Retrieve Request
BatchProcessingApi	checkBatchStatusRequest	POST /v6/batch/status	Check Batch Status
CardHolderAccountApi	accountCardDeleteRequest	DELETE /v6/account/{accountid}/card/{cardId}	Card Deletion
CardHolderAccountApi	accountCardRegisterRequest	POST /v6/account/{accountid}/register	Card Registration
CardHolderAccountApi	accountCardStatusRequest	POST /v6/account/{accountid}/card/{cardId}/status	Card Status
CardHolderAccountApi	accountChangeContactRequest	POST /v6/account/{accountid}/contact	Contact Details Update
CardHolderAccountApi	accountCreate	POST /v6/account/create	Account Create
CardHolderAccountApi	accountDeleteRequest	DELETE /v6/account/{accountid}	Account Deletion
CardHolderAccountApi	accountExistsRequest	GET /v6/account-exists/{accountid}	Account Exists
CardHolderAccountApi	accountRetrieveRequest	GET /v6/account/{accountid}	Account Retrieval
CardHolderAccountApi	accountStatusRequest	POST /v6/account/{accountid}/status	Account Status
CardHolderAccountApi	chargeRequest	POST /v6/charge	Charge
DirectPostApi	directCResAuthRequest	POST /direct/cres/auth/{uuid}	Handles a CRes response from ACS, returning back the result of authorisation
DirectPostApi	directCResTokeniseRequest	POST /direct/cres/tokenise/{uuid}	Handles a CRes response from ACS, returning back a token for future authorisation
DirectPostApi	directPostAuthRequest	POST /direct/auth	Direct Post Auth Request
DirectPostApi	directPostTokeniseRequest	POST /direct/tokenise	Direct Post Tokenise Request
DirectPostApi	tokenRequest	POST /direct/token	Direct Post Token Request
OperationalFunctionsApi	aclCheckRequest	POST /v6/acl/check	ACL Check Request
OperationalFunctionsApi	domainKeyCheckRequest	POST /dk/check	Domain Key Check Request
OperationalFunctionsApi	domainKeyGenRequest	POST /dk/gen	Domain Key Generation Request
OperationalFunctionsApi	listMerchantsRequest	GET /v6/merchants/{clientid}	List Merchants Request
OperationalFunctionsApi	pingRequest	POST /v6/ping	Ping Request
PaylinkApi	tokenAdjustmentRequest	POST /paylink/{token}/adjustment	Paylink Token Adjustment
PaylinkApi	tokenCancelRequest	PUT /paylink/{token}/cancel	Cancel a Paylink Token
PaylinkApi	tokenChangesRequest	POST /paylink/token/changes	Paylink Token Audit
PaylinkApi	tokenCloseRequest	PUT /paylink/{token}/close	Close Paylink Token
PaylinkApi	tokenCreateBillPaymentRequest	POST /paylink/bill-payment	Create Bill Payment Paylink Token
PaylinkApi	tokenCreateRequest	POST /paylink/create	Create Paylink Token
PaylinkApi	tokenPurgeAttachmentsRequest	PUT /paylink/{token}/purge-attachments	Purges any attachments for a Paylink Token
PaylinkApi	tokenReconciledRequest	PUT /paylink/{token}/reconciled	Reconcile Paylink Token
PaylinkApi	tokenReopenRequest	PUT /paylink/{token}/reopen	Reopen Paylink Token
PaylinkApi	tokenResendNotificationRequest	POST /paylink/{token}/resend-notification	Resend a notification for Paylink Token
PaylinkApi	tokenStatusRequest	GET /paylink/{token}/status	Paylink Token Status
ReportingApi	batchedTransactionReportRequest	POST /v6/merchant-batch/{merchantid}/{batch_no}/transactions	Batch Transaction Report Request
ReportingApi	merchantBatchReportRequest	POST /v6/merchant-batch/report	Merchant Batch Report Request
ReportingApi	merchantBatchRequest	GET /v6/merchant-batch/{merchantid}/{batch_no}	Merchant Batch Request
ReportingApi	remittanceRangeReport	POST /v6/remittance/report/{clientid}	Remittance Report Request
ReportingApi	remittanceReportRequest	GET /v6/remittance/report/{clientid}/{date}	Remittance Date Report Request

Models

Authorization

Authentication schemes defined for the API:

cp-api-key

Type: API key
API key parameter name: cp-api-key
Location: HTTP header

cp-domain-key

Type: API key
API key parameter name: cp-domain-key
Location: URL query string

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@citypay.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 6.6.40
- Package version: 1.1.2
- Generator version: 7.5.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

citypay / citypay-api-client-php

Maintainers

Details

README

Compliance and Security Overview

Key Compliance and Security Measures

Getting Started

Installation & Usage

Requirements

Composer

Manual Installation

Getting Started

API Endpoints

Models

Authorization

cp-api-key

cp-domain-key

Tests

Author

About this package