Git Product home page Git Product logo

skippay-payments-php-sdk's Introduction

skippay-php-sdk composer php

  • PHP client for API documentation for Skip Pay partners.

  • API version: 1.0

For more information, please visit our developer portal

Installation

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/skip-pay/skippay-payments-php-sdk"
    }
  ],
  "require": {
    "skippay/skippay-payments-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/skippay-payments-php-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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

$config = SkipPay\Configuration::getDefaultConfiguration();

$authApi = new SkipPay\Api\SecurityApi(
  new GuzzleHttp\Client(),
  $config,
);

// Example, store this securely
$username = 'USER_NAME';
$password = 'PASSWORD';

// Obtain access token
$authResponse = $authApi->loginpartner([
  'username' => $username, 
  'password' => $password
]);

// Configure access token
$config->setAccessToken($authResponse['accessToken']);

$sdk = new SkipPay\Sdk(
    // 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
);
$applicationId = 11b00a1ef1; // string | applicationId
$applicationCancelRequest = new \SkipPay\Model\ApplicationCancelRequest(); // \SkipPay\Model\ApplicationCancelRequest

try {
    $result = $sdk->ApplicationOperationsApi()->cancelapplication($applicationId, $applicationCancelRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationOperationsApi()->cancelapplication(): ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.partner.skippay.cz

Class Method HTTP request Description
ApplicationOperationsApi cancelapplication PUT /financing/v1/applications/{applicationId}/cancel Cancel application
ApplicationOperationsApi changeapplicationorder PUT /financing/v1/applications/{applicationId}/order Change application order
ApplicationOperationsApi createapplication POST /financing/v1/applications Create application
ApplicationOperationsApi createapplicationfromrecurrence POST /financing/v1/recurrences/{recurrenceId}/applications Create application from recurrence
ApplicationOperationsApi getapplicationdetail GET /financing/v1/applications/{applicationId} Get application detail
ApplicationOperationsApi getorder GET /financing/v1/orders Get order
ApplicationOperationsApi getpaymentsonspecificapplication GET /financing/v1/applications/{applicationId}/payments Get payments on specific application
ApplicationOperationsApi getrecurrence GET /financing/v1/recurrences/{recurrenceId} Get recurrence
ApplicationOperationsApi markorderitemsascancelled PUT /financing/v1/applications/{applicationId}/order/cancel Mark order items as cancelled
ApplicationOperationsApi markorderitemsasdelivered PUT /financing/v1/applications/{applicationId}/order/deliver Mark order items as delivered
ApplicationOperationsApi markorderitemsasreturned PUT /financing/v1/applications/{applicationId}/order/return Mark order items as returned
ApplicationOperationsApi markorderitemsassent PUT /financing/v1/applications/{applicationId}/order/send Mark order items as sent
ApplicationOperationsApi updaterecurrence PATCH /financing/v1/recurrences/{recurrenceId} Update recurrence
HealthCheckApi aPIhealthcheck GET /v1/health API health check
PrecheckOperationsApi precheck POST /financing/v1/precheck Precheck
SecurityApi loginpartner POST /authentication/v1/partner Login partner

Models

Authorization

httpBearer

  • Type: Bearer authentication

Author

[email protected]

skippay-payments-php-sdk's People

Contributors

janricica avatar skippaydevelopers avatar

Stargazers

Jiri Melcak avatar

Watchers

Petr Olah avatar Ondřej Kulatý avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.