kstmostofa/dingconnect-api-php

A PHP Client for the DingConnect Mobile Top-Up API.

v1.0.0 2023-10-03 18:39 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: 3.34.0
• phpunit/phpunit: ^8.5.29
• squizlabs/php_codesniffer: 3.7.2

MIT

• Md. Mostafijur Rahman

• php
• api
• sdk
• swagger
• dingconnect

README

This PHP package was generated using the Swagger Codegen project:

• API version: V1
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

• PHP 5.5 and later

Installation

Composer

composer require Kstmostofa/dingconnect-api-php

Usage

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

$apiInstance = new Kstmostofa\DingConnect\Api\V1Api(
    // 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()
);
$cancellation_requests = array(new \Kstmostofa\DingConnect\Model\CancellationRequest()); // \Kstmostofa\DingConnect\Model\CancellationRequest[] | An explicit list of records to cancel.

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

?>

Documentation for API Endpoints

All URIs are relative to https://api.dingconnect.com

Class	Method	HTTP request	Description
V1Api	cancelTransfers	POST /api/V1/CancelTransfers	Attempt to cancel transfers with the submitted TransferIds
V1Api	estimatePrices	POST /api/V1/EstimatePrices	Estimate prices for send or receive values
V1Api	getAccountLookup	GET /api/V1/GetAccountLookup	Get providers and product information for a specific account number
V1Api	getBalance	GET /api/V1/GetBalance	Get the current agent balance
V1Api	getCountries	GET /api/V1/GetCountries	Get a list of supported countries
V1Api	getCurrencies	GET /api/V1/GetCurrencies	Get a list of supported currencies
V1Api	getErrorCodeDescriptions	GET /api/V1/GetErrorCodeDescriptions	Get a list of error code descriptions
V1Api	getProductDescriptions	GET /api/V1/GetProductDescriptions	Get localized strings for products
V1Api	getProducts	GET /api/V1/GetProducts	Get a list of products that can be used in SendTransfer
V1Api	getPromotionDescriptions	GET /api/V1/GetPromotionDescriptions	Get localized strings for promotions
V1Api	getPromotions	GET /api/V1/GetPromotions	Get a list of promotions
V1Api	getProviderStatus	GET /api/V1/GetProviderStatus	Get the current status of product providers
V1Api	getProviders	GET /api/V1/GetProviders	Get a list of product providers available to the agent
V1Api	getRegions	GET /api/V1/GetRegions	Get a list of regions on the system
V1Api	listTransferRecords	POST /api/V1/ListTransferRecords	Query transfers that were submitted to the system
V1Api	sendTransfer	POST /api/V1/SendTransfer	Send a transfer to an account

Documentation For Models

• AccountLookup
• CancelTransfersResponse
• CancellationRequest
• Country
• Currency
• Error
• ErrorDescription
• EstimatePricesResponse
• EstimatedPrice
• EstimationRequest
• GetAccountLookupResponse
• GetBalanceResponse
• GetCountriesResponse
• GetCurrenciesResponse
• GetErrorCodeDescriptionsResponse
• GetProductDescriptionsResponse
• GetProductsResponse
• GetPromotionDescriptionsResponse
• GetPromotionsResponse
• GetProviderStatusResponse
• GetProvidersResponse
• GetRegionsResponse
• IApiResponse
• InternationalDialingInfo
• ListTransferRecordsRequest
• ListTransferRecordsResponse
• LocalizedProductDescription
• LocalizedPromotionDescription
• Price
• Product
• Promotion
• Provider
• ProviderStatus
• Region
• SendTransferRequest
• SendTransferResponse
• Setting
• SettingDefinition
• TransferId
• TransferRecord
• TransferRecordWithErrorCodes
• TransferWithState

Documentation For Authorization

APIKeyHeader

• Type: API key
• API key parameter name: api_key
• Location: HTTP header