Download the PHP package citypay/citypay-api-client-php without Composer

On this page you can find all versions of the php package citypay/citypay-api-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of citypay/citypay-api-client-php

Informations about the package citypay-api-client-php

CityPay

PHP PHPUnit Tests

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

<aside class=\"notice\"> 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

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:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

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

cp-domain-key

Tests

To run the tests, use:

Author

[email protected]

About this package

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

All versions of citypay-api-client-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package citypay/citypay-api-client-php contains the following files

Loading the files please wait ....