Moncash Rest Api With PHP: Documentation

This document provides instructions for integrating the MonCash REST API into a PHP project using Composer or direct download. It explains how to install the SDK with Composer or direct download, make an initial payment request call, and capture payment details by transaction ID or order ID. Code examples are provided to create a payment, get transaction details by ID, and view returned values. The full code example is available on GitHub.

Uploaded by

Wood

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

178 views

Moncash Rest Api With PHP: Documentation

Uploaded by

Wood

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 4

MonCash REST API WITH

PHP

Documentation

INTRODUCTION 2

INSTALLATION WITH COMPOSER 2

INSTALLATION DIRECT DOWNLOAD 2

MAKING FIRST CALL 2

COMPLETE CODE 4

1
Introduction
Moncash REST API is a simple way of integrating the payment gateway into your site to
take payments. In this article we're going to look at a simple example that will use
Moncash SDK to take payments using PHP.

Installation with composer

Composer is the recommended way to install the SDK. Alternatively, if you prefer not to use Composer, but
want to install our SDK, you can do so by doing a direct download https://github.com/ecelestin/ecelestin-
Moncash-sdk-php.

Currently, Moncash PHP Rest API SDK is available at github https://github.com/ecelestin/ecelestin-Moncash-

sdk-php.git . To use it in your project, you need to include it as a dependency in your project composer.json
file.

1. Download Composer if not already installed

2. Go to your project directory. If you dont have one, just create a directory and cd in.
$ mkdir project
$ cd project

3. Execute composer require DGCGroup/MonCash-PHP-SDK on command line.

Installation Direct Download

If you don’t want to use composer, you can grab the SDK zip that contains Moncash PHP Rest API SDK with all
its dependencies with it.

1. Download the Moncash-PHP-SDK https://github.com/ecelestin/ecelestin-Moncash-sdk-php

2. Go to your project directory. If you do not have one, just create a directory and cd in.
$ mkdir project
$ cd project

3. Unzip, and copy directory to your project location

Making First Call

After the installation, so that we can benefit from using the namespaces of the SDK classes to import
them into our scripts we want to make sure we include Composer's autoload in our codebase. For our
example code, we will include it at the top of the file that will be required by our request and response
scripts.

2
1. Auto load the SDK Package. This will include all the files and classes to your
autoloader. Please note, if you downloaded the SDK directly, replace vendor by
the complete path to the autoloader from the package.

<?php

require DIR . '/vendor/autoload.php';

use DGCGroup\MonCashPHPSDK\Credentials;
use DGCGroup\MonCashPHPSDK\Configuration;
use DGCGroup\MonCashPHPSDK\PaymentMaker;
use DGCGroup\MonCashPHPSDK\Order;
use DGCGroup\MonCashPHPSDK\TransactionCaller;
use DGCGroup\MonCashPHPSDK\TransactionDetails;
use DGCGroup\MonCashPHPSDK\TransactionPayment;

2. Provide the ClientId and Secret before make request

...
$client = "client id";
$secret = "client secret";
$configArray = Configuration::getSandboxConfigs(); // Configuration::getProdConfigs()
for live
$credential = new Credentials($client, $secret, $configArray);

3. Let’s try to create a new moncash Payment

// Create payment
$amount = 201;//amount in HTG
$orderId = "979879799798";; //may be your cart Id
$theOrder = new Order( $orderId, $amount );
$paymentObj = PaymentMaker::makePaymentRequest($theOrder, $credential,
$configArray);
//This method return the payment gateway url
echo $paymentObj->getRedirect();

3
4. Capture payment using the transactionId

// Capture the payment

$transactionDetails =
TransactionCaller::getTransactionDetailsByTransactionIdRequest( $theOrder,
$credential, $configArray );

echo $transactionDetails->getPayment()->getReference();
echo $transactionDetails->getPayment()->getTransactionId();
echo $transactionDetails->getPayment()->getCost();
echo $transactionDetails->getPayment()->getMessage();
echo $transactionDetails->getPayment()->getPayer();
echo date('D M d Y', $transactionDetails->getTimestamp()/1000);

5. Capture payment using the orderId

// Capture the payment

$transactionDetails = TransactionCaller::getTransactionDetailsByOrderIdRequest(
$theOrder, $credential, $configArray );

Complete code

The complete example code for the integration described in this post can be found on GitHub. Check it out,
download and play with it. Hopefully this really simple example will get you started with integrating Moncash
into your site.