The Unlimit API uses HTTP verbs and a RESTful endpoint structure. Request and response payloads are formatted as JSON.
- API version: 3.0
- PHP SDK version: 3.89.16
For more information, please visit https://integration.cardpay.com
- PHP 5.6 or later
- curl, json, openssl extensions
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/cardpay/php-sdk-v3.git"
}
],
"require": {
"cardpay/php-sdk-v3": "*@dev"
}
}
Then run composer install
Download the files, run composer install and include autoload.php:
require_once('./vendor/autoload.php');SDK will automatically use the proxy if the HTTPS_PROXY or HTTP_PROXY environment variable is set.
Important: please note that current implementation is using temporary files storage (see FileTokensStorageApi), to save, read and delete (if needed) the API tokens. You may implement another tokens storage (session, database, Memcached, Redis, etc) by implementing TokensStorageApi interface.
In order to obtain the API tokens please use AuthApiClient. It requires API terminal code and password, provided by Unlimit.
Please follow the installation procedure and then run the following:
<?php
use Cardpay\api\AuthApiClient;
use Cardpay\api\FileTokensStorageApi;
$fileTokensStorageApi = new FileTokensStorageApi($host, $terminalCode);
$authApiClient = new AuthApiClient($host, $terminalCode, $password, $fileTokensStorageApi);
/** @var ApiTokens $apiTokens */
$apiTokens = $authApiClient->obtainApiTokens();
$accessToken = $apiTokens->getAccessToken();
$refreshToken = $apiTokens->getRefreshToken();
$tokenType = $apiTokens->getTokenType();Open ./test/Config.php and set terminal code, password and terminal currency.
To run the unit tests:
composer install
./vendor/bin/phpunit --configuration ./phpunit.xml
- AccountDetailsRequest
- ApiError
- ApiTokens
- AuthDataRequest
- AuthenticationCreateResponse
- AuthenticationCustomer
- AuthenticationData
- AuthenticationDataRequest
- AuthenticationDataResponse
- AuthenticationError
- AuthenticationPatchRequest
- AuthenticationUpdateResponse
- BadRequestError
- BankCardPayoutData
- BillingAddress
- BrowserInfo
- CardInfoRequest
- CardInfoResponse
- ChangeSubscriptionStatusClaimResponse
- ChangedPlanData
- ClaimResponseSubscriptionData
- Confirm3dsRequest
- Device
- DisputeList
- DisputeResponse
- DisputeResponseCard
- DisputeResponseCardAccount
- DisputeResponseCustomer
- DisputeResponseDisputeData
- DisputeResponseMerchantOrder
- DisputeResponsePaymentData
- EwalletAccount
- FilingRecurringData
- FilingRequest
- FilingRequestMerchantOrder
- FilingRequestSubscriptionData
- FilterParameters
- Flight
- Flights
- InstallmentData
- InvoiceCreationDataResponse
- InvoiceCreationResponse
- InvoiceCustomer
- InvoiceData
- InvoiceGetDataResponse
- InvoiceGetResponse
- InvoiceItem
- InvoiceMerchantOrder
- InvoiceRequest
- Item
- LimitInfoResponse
- MapOfstringAndstring
- MobileTokenRequest
- MobileTokenResponse
- NextSubscriptionPayment
- NotFoundError
- OAuthError
- OneclickData
- PaymentCallback
- PaymentData
- PaymentGatewayCreationResponse
- PaymentGatewayResponsePaymentData
- PaymentMethodsResponse
- PaymentPatchRequest
- PaymentRequest
- PaymentRequestCard
- PaymentRequestCardAccount
- PaymentRequestCryptocurrencyAccount
- PaymentRequestCustomer
- PaymentRequestEWalletAccount
- PaymentRequestLivingAddress
- PaymentRequestMerchantOrder
- PaymentRequestPaymentData
- PaymentResponse
- PaymentResponseCardAccount
- PaymentResponseCryptocurrencyAccount
- PaymentResponseCustomer
- PaymentResponsePaymentData
- PaymentUpdateResponse
- PaymentUpdateTransactionData
- PaymentsList
- PayoutCallback
- PayoutCreationResponse
- PayoutPaymentData
- PayoutRequest
- PayoutRequestCard
- PayoutRequestCardAccount
- PayoutRequestCryptocurrencyAccount
- PayoutRequestCustomer
- PayoutRequestEWalletAccount
- PayoutRequestLivingAddress
- PayoutRequestMerchantOrder
- PayoutRequestPayoutData
- PayoutResponse
- PayoutResponseCardAccount
- PayoutResponseCryptocurrencyAccount
- PayoutResponseCustomer
- PayoutResponseEWalletAccount
- PayoutResponsePayoutData
- PayoutUpdateRequest
- PayoutUpdateResponse
- PayoutsList
- PixAccountDetailsResponse
- Plan
- PlanDataList
- PlanQuantity
- PlanRetry
- PlanRetryResponse
- PlanSubscriptionDeclineLogic
- PlanUpdateRequest
- PlanUpdateRequestPlanData
- PlanUpdateResponse
- RecurringCallback
- RecurringCreationRequest
- RecurringCustomer
- RecurringData
- RecurringFilterParameters
- RecurringGatewayCreationResponse
- RecurringGatewayResponseRecurringData
- RecurringPatchRequest
- RecurringPlanRequest
- RecurringPlanRequestPlanData
- RecurringPlanResponse
- RecurringRequestFiling
- RecurringRequestRecurringData
- RecurringResponse
- RecurringResponseFiling
- RecurringResponseMerchantOrder
- RecurringResponseRecurringData
- RecurringUpdateResponse
- RecurringsList
- RedirectUrlResponse
- RefundCallback
- RefundRequest
- RefundRequestCustomer
- RefundRequestEWalletAccount
- RefundRequestMerchantOrder
- RefundRequestPaymentData
- RefundRequestRefundData
- RefundResponse
- RefundResponseCardAccount
- RefundResponseCustomer
- RefundResponseEWalletAccount
- RefundResponsePaymentData
- RefundResponseRefundData
- RefundUpdateRequest
- RefundUpdateResponse
- RefundsList
- RenamedPlanData
- Report
- ReportsData
- ReportsRequest
- ReportsResponse
- Request
- RequestUpdatedTransactionData
- ResponsePlanData
- ResponseUpdatedTransactionData
- ReturnUrls
- ScheduledByMerchantData
- ScheduledData
- ShippingAddress
- Subscription
- SubscriptionCustomer
- SubscriptionFilterParameters
- SubscriptionGetResponse
- SubscriptionGetResponsePlan
- SubscriptionList
- SubscriptionPendingPlanUpdate
- SubscriptionUpdateRequest
- SubscriptionUpdateRequestSubscriptionData
- SubscriptionUpdateResponse
- SupportedPaymentMethod
- ThreeDSecureData
- ThreeDSecureResponse
- TransactionMethodsList
- TransactionRequest
- TransactionResponseEWalletAccount
- TransactionResponseMerchantOrder
- TransactionUpdateRequest
- UpdatedPlanData
- UpdatedSubscriptionData
- UpdatedSubscriptionRecurringData
- AuthenticationConfirm3dsRequest
- PaymentConfirm3dsRequest
- PaymentExecuteRequest
- PaymentIncrementRequest
- PaymentUpdateRequest
- RecurringConfirm3dsRequest
- RecurringExecuteRequest
- RecurringIncrementRequest
- RecurringUpdateRequest