README

Definition of technical specification of the product; Zenkipay is a gateway cryptocurrency payment system that allows merchant's to receive payments on their e-commerce portals. Unlike other platforms, Zenkipay ensures customer satisfaction through its payment process. guarantee deposit (delivered product and expected quality) to settle payment to the merchant, thus avoiding the loss of client assets due to online scams.

For more information, please visit https://www.zenki.fi/.

Installation & Usage

Build date: Thu Feb 23 23:45:43 UTC 2023

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/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:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Zenkipay\Api\AuthenticationAndAuthorizationApi(
    // 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()
);
$content_type = application/json; // string | Tipo de contenido aceptado.
$accept = application/json; // string | Formatos aceptados.
$request_token_o_auth2 = new \Zenkipay\Model\RequestTokenOAuth2(); // \Zenkipay\Model\RequestTokenOAuth2 | Parameters for OAuth 2 token creation.

try {
    $result = $apiInstance->createToken($content_type, $accept, $request_token_o_auth2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationAndAuthorizationApi->createToken: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.zenki.fi

Class	Method	HTTP request	Description
AuthenticationAndAuthorizationApi	createToken	POST /v1/oauth/tokens	Create an authentication token in Zenki
EscrowApi	updateEscrow	PATCH /v1/pay/escrow/{zenkiOrderId}/fulfillments	Escrow update
MerchantsApi	getMerchantInfo	GET /v1/pay/me	Merchant information
OrdersApi	createOrder	POST /v1/pay/orders	Payment order registration
OrdersApi	getOrder	GET /v1/pay/orders/{zenkiOrderId}	Order information
OrdersApi	updateOrder	PATCH /v1/pay/orders/{zenkiOrderId}	Order update for payment
RefundsApi	getRefundOrder	GET /v1/pay/orders/{zenkiOrderId}/refunds/{zenkiRefundId}	Request refunds for an order
RefundsApi	registerRefundOrder	POST /v1/pay/orders/{zenkiOrderId}/refunds	Register of refunds for an order
TrackingApi	addEventTracking	PATCH /v1/pay/orders/{zenkiOrderId}/tracking/{zenkiTrackId}	Shipping Status Update
TrackingApi	registerTrackingOrders	POST /v1/pay/orders/{zenkiOrderId}/tracking	Registration number for tracking
WebhooksApi	sendEvent	POST /URL_MERCHANT	Event notifications for merchant

Models

Authorization

JWTAuth

Type: Bearer authentication (ACCESS_TOKEN)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@zenki.fi

About this package

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

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

zenki / zenkipay-api-client

Maintainers

Details