README

Complete Pine Labs Payment Gateway API for accepting payments, managing orders, refunds, subscriptions, payouts, and more.

Authentication

All endpoints (except /api/auth/v1/token) require a Bearer token in the Authorization header. Generate a token using your client_id and client_secret via the Authentication endpoint.

Base URLs

Production: https://api.pluralpay.in
Sandbox: https://pluraluat.v2.pinepg.in

For more information, please visit https://developers.pluralonline.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/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/Pinelabs/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Pinelabs\Api\AuthenticationApi(
    // 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()
);
$client_id = 'client_id_example'; // string | Your merchant client ID from the Pine Labs dashboard.
$client_secret = 'client_secret_example'; // string | Your merchant client secret. Keep this confidential.
$grant_type = 'grant_type_example'; // string | Must be \\\"client_credentials\\\".

try {
    $result = $apiInstance->generateToken($client_id, $client_secret, $grant_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->generateToken: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.pluralpay.in

Class	Method	HTTP request	Description
AuthenticationApi	generateToken	POST /api/auth/v1/token	Generate Access Token
CheckoutLinksApi	createPaymentLink	POST /api/pay/v1/payment-links	Create Payment Link
CustomersApi	createCustomer	POST /api/pay/v1/customers	Create Customer
CustomersApi	getCustomer	GET /api/pay/v1/customers/{customer_id}	Get Customer
CustomersApi	updateCustomer	PUT /api/pay/v1/customers/{customer_id}	Update Customer
OffersEMIApi	discoverOffers	POST /api/pay/v1/offers/discover	Discover Offers
OffersEMIApi	validateOffer	POST /api/pay/v1/offers/validate	Validate Offer
OrdersApi	cancelOrder	POST /api/pay/v1/orders/{order_id}/cancel	Cancel Order
OrdersApi	captureOrder	POST /api/pay/v1/orders/{order_id}/capture	Capture Order
OrdersApi	createOrder	POST /api/pay/v1/orders	Create Order
OrdersApi	getOrder	GET /api/pay/v1/orders/{order_id}	Get Order
OrdersApi	getOrderByRef	GET /api/pay/v1/orders	Get Order by Merchant Ref
PaymentsApi	createPayment	POST /api/pay/v1/orders/{order_id}/payments	Process Payment
PaymentsApi	verifyVPA	POST /api/pay/v1/orders/{order_id}/payments/verify-vpa	Verify VPA
PayoutsApi	bulkPayout	POST /api/pay/v1/payouts/bulk	Bulk Payouts
PayoutsApi	createPayout	POST /api/pay/v1/payouts	Create Payout
PayoutsApi	getPayout	GET /api/pay/v1/payouts/{payout_id}	Get Payout
PayoutsApi	getPayoutBalance	GET /api/pay/v1/payouts/balance	Account Balance
RefundsApi	createRefund	POST /api/pay/v1/orders/{order_id}/refunds	Create Refund
RefundsApi	getRefunds	GET /api/pay/v1/orders/{order_id}/refunds	Get Refunds
SettlementsApi	getSettlementByUTR	GET /api/pay/v1/settlements/{utr}	Get Settlement by UTR
SettlementsApi	getSettlements	GET /api/pay/v1/settlements	Get Settlements
SplitSettlementsApi	cancelSplit	POST /api/pay/v1/splits/{split_id}/cancel	Cancel Split
SplitSettlementsApi	createSplit	POST /api/pay/v1/splits	Create Split
SplitSettlementsApi	releaseSplit	POST /api/pay/v1/splits/{split_id}/release	Release Split
SubscriptionsApi	cancelSubscription	POST /api/pay/v1/subscriptions/{subscription_id}/cancel	Cancel Subscription
SubscriptionsApi	createPlan	POST /api/pay/v1/plans	Create Plan
SubscriptionsApi	createSubscription	POST /api/pay/v1/subscriptions	Create Subscription
SubscriptionsApi	deletePlan	DELETE /api/pay/v1/plans/{plan_id}	Delete Plan
SubscriptionsApi	getPlan	GET /api/pay/v1/plans/{plan_id}	Get Plan
SubscriptionsApi	getPlans	GET /api/pay/v1/plans	Get Plans
SubscriptionsApi	getSubscription	GET /api/pay/v1/subscriptions/{subscription_id}	Get Subscription
SubscriptionsApi	getSubscriptions	GET /api/pay/v1/subscriptions	Get Subscriptions
SubscriptionsApi	pauseSubscription	POST /api/pay/v1/subscriptions/{subscription_id}/pause	Pause Subscription
SubscriptionsApi	resumeSubscription	POST /api/pay/v1/subscriptions/{subscription_id}/resume	Resume Subscription
SubscriptionsApi	updatePlan	PUT /api/pay/v1/plans/{plan_id}	Update Plan

Models

Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

developer.support@pinelabs.com

About this package

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

API version: 1.0.0
- Package version: 0.0.0
- Generator version: 7.22.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

plural-pinelabs/pinelabs-php

包简介

关键字：

README 文档