php-paytrail-payment-api

Paytrail Payment API

For more information, please visit https://github.com/paytrail/api-documentation/issues.

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/tuutti/php-paytrail-payments-api.git"
    }
  ],
  "require": {
    "tuutti/php-paytrail-payments-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/php-paytrail-payment-api/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Paytrail\Payment\Api\PaymentReportsApi(
    // 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()
);
$payment_report_request = new \Paytrail\Payment\Model\PaymentReportRequest(); // \Paytrail\Payment\Model\PaymentReportRequest | Payment body payload
$checkout_account = 375917; // int | Merchant ID
$checkout_algorithm = sha512; // string | HMAC algorithm
$checkout_method = POST; // string | HTTP method of the request
$checkout_timestamp = 2018-08-08T10:10:59Z; // \DateTime | Current timestamp in ISO 8601 format
$signature = 'signature_example'; // string | HMAC signature calculated over the request headers and payload

try {
    $result = $apiInstance->requestPaymentReport($payment_report_request, $checkout_account, $checkout_algorithm, $checkout_method, $checkout_timestamp, $signature);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentReportsApi->requestPaymentReport: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://services.paytrail.com

Class	Method	HTTP request	Description
PaymentReportsApi	requestPaymentReport	POST /payments/report	Request a payment report
PaymentReportsApi	requestPaymentReportBySettlementId	POST /settlements/{settlementId}/payments/report	Request a report of payments contained in a given settlement
PaymentsApi	activateInvoiceByTransactionId	POST /payments/{transactionId}/activate-invoice	Activate invoice
PaymentsApi	createPayment	POST /payments	Create a new open payment
PaymentsApi	getGroupedPaymentProviders	GET /merchants/grouped-payment-providers	List grouped merchant payment methods
PaymentsApi	getPaymentByTransactionId	GET /payments/{transactionId}	Get a payment by Checkout transaction ID
PaymentsApi	getPaymentProviders	GET /merchants/payment-providers	List merchant payment methods
PaymentsApi	refundPaymentByTransactionId	POST /payments/{transactionId}/refund	Refund a payment
ProvidersApi	getGroupedPaymentProviders	GET /merchants/grouped-payment-providers	List grouped merchant payment methods
ProvidersApi	getPaymentProviders	GET /merchants/payment-providers	List merchant payment methods
SettlementsApi	listSettlementIds	GET /settlements	List settlement IDs
TokenPaymentsApi	addCardForm	POST /tokenization/addcard-form	Request a redirect to card addition form
TokenPaymentsApi	requestTokenForTokenizationId	POST /tokenization/{checkout-tokenization-id}	Request a card token for given tokenization id
TokenPaymentsApi	tokenCitAuthorizationHold	POST /payments/token/cit/authorization-hold	Request customer initiated transaction authorization hold on token
TokenPaymentsApi	tokenCitCharge	POST /payments/token/cit/charge	Request customer initiated transaction charge on token
TokenPaymentsApi	tokenCommit	POST /payments/{transactionId}/token/commit	Request committing (charging) of previously created authorization hold on token
TokenPaymentsApi	tokenMitAuthorizationHold	POST /payments/token/mit/authorization-hold	Request merchant initiated transaction authorization hold on token
TokenPaymentsApi	tokenMitCharge	POST /payments/token/mit/charge	Request merchant initiated transaction charge on token
TokenPaymentsApi	tokenRevert	POST /payments/{transactionId}/token/revert	Revert (removal) of previously created authorization hold on token

Models

• ActivateInvoiceResponse
• AddCardFormRequest
• Address
• BasePaymentMethodProvider
• Callbacks
• Card
• Customer
• Error
• GetTokenRequest
• GroupedPaymentProvidersResponse
• Item
• ItemCommission
• Payment
• PaymentMethodGroupData
• PaymentMethodGroupDataWithProviders
• PaymentMethodGroupDataWithProvidersAllOf
• PaymentMethodProvider
• PaymentMethodProviderAllOf
• PaymentMethodProviderAllOfParameters
• PaymentReportBySettlementIdRequest
• PaymentReportCallbackJSON
• PaymentReportRequest
• PaymentReportRequestResponse
• PaymentRequest
• PaymentRequestResponse
• Refund
• RefundItem
• RefundResponse
• SettlementIdItem
• TokenCITPaymentResponse
• TokenCustomerDetails
• TokenMITPaymentResponse
• TokenPaymentRequest
• TokenizationRequestResponse

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

• API version: 2.0.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen