README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

API version: v1
Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cpaymentconnector/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



$apiInstance = new CpaymentConnector\Api\CardApi(
    // 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()
);
$auth_token = 'auth_token_example'; // string | Gets or sets the authentication token.
$request = new \CpaymentConnector\Model\CardPaymentCreditHolderRequest(); // \CpaymentConnector\Model\CardPaymentCreditHolderRequest | 

try {
    $result = $apiInstance->v1CardCreditHolderPost($auth_token, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->v1CardCreditHolderPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CardApi	v1CardCreditHolderPost	POST /v1/card/creditHolder	Credit a card payment
Card3DsPaymentApi	v1PaymentsCard3dsPaymentPost	POST /v1/payments/card3ds-payment	Achieve a 3DS payment (CheckEnrollment)
Card3DsPaymentApi	v1PaymentsCard3dsPaymentPut	PUT /v1/payments/card3ds-payment	Finish the 3DS payment. Reuse the order references and the paymentRequestId (returned from the POST).
CardPaymentApi	v1PaymentsCardPaymentPost	POST /v1/payments/card-payment	Achieve a payment with a card without 3DSecure. To achieve a 3DS payment (CheckEnrollment), see the /payment/card3ds-payment resource.
DuplicatePaymentApi	v1PaymentsDuplicatePaymentBatchPost	POST /v1/payments/duplicate-payment/batch	Achieve a batch of payments by copy of previously processed payments, with the same payment method.
DuplicatePaymentApi	v1PaymentsDuplicatePaymentPost	POST /v1/payments/duplicate-payment	Achieve a payment by copy of a previously processed payment, with the same payment method.
PaymentOptionsApi	v1PaymentOptionsMerchantsByMerchantIdSitesByMerchantSiteIdGet	GET /v1/payment-options/merchants/{merchantId}/sites/{merchantSiteId}	Gets the payment options for a specified site.
PaymentOptionsApi	v1PaymentOptionsPost	POST /v1/payment-options	Gets the payment options for a specified context.
PaymentOptionsApi	v1PaymentOptionsValidateEligibilityPost	POST /v1/payment-options/validateEligibility	Validates the eligibility of the given payment option, according to context.
PaymentSessionApi	v1PaymentSessionsByPaymentSessionIdPaymentResultGet	GET /v1/payment-sessions/{paymentSessionId}/paymentResult	Gets the payment result from its session id.
PaymentSessionApi	v1PaymentSessionsPost	POST /v1/payment-sessions	Creates a payment session.
PaymentsApi	v1PaymentsAllByOrderRefMerchantsByMerchantIdSitesByMerchantSiteIdGet	GET /v1/payments/all/{orderRef}/merchants/{merchantId}/sites/{merchantSiteId}	Gets ALL the details for a specified OrderRef.
PaymentsApi	v1PaymentsByOrderRefMerchantsByMerchantIdSitesByMerchantSiteIdByOrderTagGet	GET /v1/payments/{orderRef}/merchants/{merchantId}/sites/{merchantSiteId}/{orderTag}	Gets the details for a specified couple of OrderRef/OrderTag.
PaymentsApi	v1PaymentsByOrderRefMerchantsByMerchantIdSitesByMerchantSiteIdGet	GET /v1/payments/{orderRef}/merchants/{merchantId}/sites/{merchantSiteId}	Gets the details for a specified OrderRef.
PaymentsApi	v1PaymentsByOrderRefOperationsCancelOrRefundPut	PUT /v1/payments/{orderRef}/operations/cancelOrRefund	Executes a cancel or refund operation on the specified OrderRef.
PaymentsApi	v1PaymentsByOrderRefOperationsCapturePut	PUT /v1/payments/{orderRef}/operations/capture	Executes a capture operation on the specified OrderRef.
PaymentsApi	v1PaymentsByOrderRefOperationsRecomputePut	PUT /v1/payments/{orderRef}/operations/recompute	Executes a recompute operation on the specified OrderRef.
SecurityTokenApi	v1AuthTokenGet	GET /v1/auth/token	Get the token provided by the Security Token Service (STS). The authentication token is mandatory for the others api calls. It's expire after 48h by default.
StoredPaymentMethodsApi	v1StoredPaymentMethodsMerchantsByMerchantIdSitesByMerchantSiteIdCustomerRefByCustomerRefGet	GET /v1/stored-payment-methods/merchants/{merchantId}/sites/{merchantSiteId}/customerRef/{customerRef}	Gets the stored payment methods by customer reference.
StoredPaymentMethodsApi	v1StoredPaymentMethodsMerchantsByMerchantIdSitesByMerchantSiteIdStoredPaymentMethodIdByStoredPaymentMethodIdDelete	DELETE /v1/stored-payment-methods/merchants/{merchantId}/sites/{merchantSiteId}/storedPaymentMethodId/{storedPaymentMethodId}	Deletes the specified stored payment method.
StoredPaymentMethodsApi	v1StoredPaymentMethodsMerchantsByMerchantIdSitesByMerchantSiteIdStoredPaymentMethodIdByStoredPaymentMethodIdGet	GET /v1/stored-payment-methods/merchants/{merchantId}/sites/{merchantSiteId}/storedPaymentMethodId/{storedPaymentMethodId}	Gets the stored payment method by identifier.
StoredPaymentMethodsApi	v1StoredPaymentMethodsPost	POST /v1/stored-payment-methods	Creates the specified stored payment method.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

cpayment / connector

Maintainers

Details