README

Create and manage your Payments

For more information, please visit https://pensopay.com.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

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

Then run composer install

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: default
$config = Pensopay\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pensopay\Client\Api\AccountApi(
    // 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
);

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

API Endpoints

All URIs are relative to https://api.pensopay.com/v2

Class	Method	HTTP request	Description
AccountApi	getAccount	GET /account	Get account details
HealthcheckApi	pingGet	GET /ping	Healthcheck
HealthcheckApi	pingPost	POST /ping	Healthcheck
MethodsApi	getMethods	GET /methods	Get methods for account
MethodsApi	getMobilepayLogo	GET /methods/mobilepay/logo	Get account logo
MethodsApi	putMobilepayLogo	PUT /methods/mobilepay/logo	Upload account logo
PaymentsApi	anonymizePayment	POST /payments/{id}/anonymize	Anonymize payment
PaymentsApi	cancelPayment	POST /payments/{id}/cancel	Cancel payment
PaymentsApi	capturePayment	POST /payments/{id}/capture	Capture payment
PaymentsApi	createPayment	POST /payments	Create new payment
PaymentsApi	getPayment	GET /payments/{id}	Get single payment
PaymentsApi	getPaymentEvents	GET /payments/{id}/events	Get events for a given payment
PaymentsApi	getPayments	GET /payments	Get payments
PaymentsApi	refundPayment	POST /payments/{id}/refund	Refund payment
PaymentsApi	updatePayment	PATCH /payments/{id}	Update Payment
RulesApi	createRule	POST /rules
RulesApi	deleteRule	DELETE /rules/{id}
RulesApi	getRules	GET /rules
RulesApi	updateRule	PATCH /rules/{id}
SettlementApi	getSettlement	GET /settlements/{settlementId}	Get Settlement
SettlementApi	getSettlements	GET /settlements	Get settlements
SettlementApi	getTransactionsBySettlement	GET /settlements/{settlementId}/transactions	Get Settlement Transactions
SubscriptionsApi	cancelSubscription	POST /subscriptions/{subscription}/cancel	Cancel subscription
SubscriptionsApi	createANewMandate	POST /subscriptions/{subscription}/mandates	Create a new mandate
SubscriptionsApi	createANewSubscription	POST /subscriptions	Create a new subscription
SubscriptionsApi	createPayment1	POST /subscriptions/{subscription}/payments	Create payment
SubscriptionsApi	getAListOfMandates	GET /subscriptions/{subscription}/mandates	Get a list of mandates
SubscriptionsApi	getAListOfPayments	GET /subscriptions/{subscription}/payments	Get payments
SubscriptionsApi	getAListOfSubscriptions	GET /subscriptions	Get a list of subscriptions
SubscriptionsApi	getSingleMandate	GET /subscriptions/{subscription}/mandates/{mandate}	Get single mandate
SubscriptionsApi	getSingleSubscription	GET /subscriptions/{subscription}	Get single subscription
SubscriptionsApi	revokeAMandate	POST /subscriptions/{subscription}/mandates/{mandate}/revoke	Revoke a mandate
SubscriptionsApi	updateASubscription	PATCH /subscriptions/{subscription}	Update a subscription
SurchargeApi	createANewRule	POST /surcharge	Create a new rule
SurchargeApi	deleteARule	DELETE /surcharge/{rule}	Delete a rule
SurchargeApi	getAListOfRules	GET /surcharge	Get surcharge configuration for account
SurchargeApi	getARule	GET /surcharge/{rule}	Get a single rule
SurchargeApi	testRules	POST /surcharge/test	Test surcharge for account
SurchargeApi	updateARule	PATCH /surcharge/{rule}	Update a rule

Models

Authorization

Authentication schemes defined for the API:

default

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

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

API version: 2.0.0
- Generator version: 7.16.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

pensopay / pensopay-php

Maintainers

Details