README

An unofficial simple API client for Paymongo written in PHP

Installation

composer require micahbule/phaymongo

Usage

Simply use the Phaymongo class and call the resource method to create a resource class. In the examples below, we'll be creating a payment intent.

<?php

use Paymongo\Phaymongo\Phaymongo;

function pay() {
    $client = new Phaymongo('YOUR_PUBLIC_KEY', 'YOUR_SECRET_KEY');
    $paymentIntent = $client->paymentIntent()->create(100, ['gcash', 'card']);

    // do something with the payment intent
}

By default, this returns the actual payment intent data from within the data property of the response payload.
If you want your client to return the original response payload, just pass the unwrap config with false value on the options array when you instantiate the client:

$client = new Phaymongo('YOUR_PUBLIC_KEY', 'YOUR_SECRET_KEY', ['unwrap' => false]);

The client throws an error if your request fails. You can handle this simply by wrapping it within a try-catch block.

use Paymongo\Phaymongo\Phaymongo;

function pay() {
    try {
        $client = new Phaymongo('YOUR_PUBLIC_KEY', 'YOUR_SECRET_KEY');
        $paymentIntent = $client->create(100, ['gcash', 'card']);

        // do something with the payment intent
    } catch ($e) {
        /** To get the body of a successful request but failed response, just do the following */
        $body = $e->getResponse()->json();

        // do something with the error
    }
}

Features

PSR-4 and PSR-7 Compliant
Easy, intuitive API design

Supported Paymongo Resources

API Documentation

All fields in bold are required fields whereas fields in italics are optional. Note that this library uses GuzzleHttp client set with the base Paymongo API URL so URLs below are relative.

new Phaymongo($public_key, $secret_key, $client_ops)

Parameters

public_key - Your Paymongo Public Key
secret_key - Your Paymongo Secret Key
client_ops.unwrap - This is a boolean that determines whether your client will return the resource info nested in the data property of the original response payload. Default to true.
client_ops.return_response - This is a boolean that determines if the client will return the original HTTP message object for further processing.

Methods

paymentIntent() - Returns a Payment Intent resource object
paymentMethod() - Returns a Payment Method resource object
source() - Returns a Source resource object
payment() - Returns a Payment resource object
refund() - Returns a Refund resource object
link() - Returns a Link resource object

new PaymongoClient($public_key, $secret_key, $client_ops)

Parent API client class. If for some reason you need to access resources manually, you can instantiate or extend this class and use the methods below.

Parameters

public_key - Your Paymongo Public Key
secret_key - Your Paymongo Secret Key
client_ops.unwrap - This is a boolean that determines whether your client will return the resource info nested in the data property of the original response payload. Default to true.
client_ops.return_response - This is a boolean that determines if the client will return the original HTTP message object for further processing.

Methods

createRequest($method, $url, $payload, $use_public_key)

Constructs a Request object to be sent by the HTTP client

method - The HTTP verb to use for the request
url - The path of the resource you want to send the request to (ex. /payment_intents).
payload - Any payload to be sent with the requests (ex. creating a resource)
use_public_key - A boolean value to instruct the client to use the public key to authenticate the request via headers. Default to false and uses secret key.

sendRequest($request, $request_opts)

Takes in the Request object and executes the request to the Paymongo resource endpoint

request - Request object from createRequest() method
request_opts - Any Request options, if any. Refer here for more info.

Payment Intent Resource

create($amount, $payment_method_allowed, $payment_method_options, $description, $metadata)

A function to create a Paymongo payment intent object.

amount - The transaction amount.
payment_method_allowed - An array of payment method strings allowed to use. For more information on available payment methods, check Payment Intent Resource.
payment_method_options - An object containing payment method options. Used in conjunction with Card Installments feature.
description - The description of the transaction.
metadata - a JSON object where you can store any other info that you might need for integration such as transaction reference numbers.

retrieveById($id)

A function to retrieve a Paymongo payment intent object by ID.

id - The payment intent ID

attachPaymentMethod($payment_intent_id, $payment_method_id, $payment_method_options, $return_url, $client_key)

A function to attach a Paymongo payment method to a payment intent object

payment_intent_id - The payment intent ID.
payment_method_id - The payment method ID.
payment_method_options - An object containing payment method options. Used in conjunction with Card Installments feature.
return_url - The URL where your users will be redirected to after a successful or failed payment authorization step.
client_key - Client key fromm payment intent if it is created using a public key -- usually a case if the payment intent was created from the frontend.

Payment Method Resource

create($type, $details, $billing, $metadata)

A function to create a Paymongo payment method object.

type - The type of payment method. For more information on available payment methods, check Payment Method Resource.
details - Only required for card type transactions. Contains details of the credit card itself. Check Payment Method Resource for more details.
billing - Contains the billing details of the user. Check Payment Method Resource for more details.
metadata - a JSON object where you can store any other info that you might need for integration such as transaction reference numbers.

retrieveById($id)

A function to retrieve a Paymongo payment method object by ID

id - The payment method ID.

Source Resource

create($amount, $type, $success_url, $failed_url, $billing, $metadata)

A function to create a Paymongo source object.

amount - The amount of the transaction.
type - The type of source. Currently only supports the values gcash and grab_pay.
success_url - This is where the user gets redirected after successful payment authorization and processing.
failed_Url - This is where the user gets redirected after unsuccessful payment authorization and processing.
billing - Contains the billing details of the user. Check Source Resource for more details.
metadata - a JSON object where you can store any other info that you might need for integration such as transaction reference numbers.

retrieveById($id)

A function to retrieve a Paymongo source object by ID.

id - The payment method ID.

Payment Resource

Currently only used in conjunction with Sources for E-wallet payment methods such as GCash or GrabPay

create($amount, $source_id, $description, $statement_descriptor, $metadata)

A function to create a Paymongo payment object.

amount - The amount of the payment. Should be equal to the amount of the source as partial payments are not allowed yet.
source_id - The source ID to be paid
description - The description of the payment.
statement_descriptor - This is what would appear on your users' statement of accounts as the description of the transaction.
metadata - a JSON object where you can store any other info that you might need for integration such as transaction reference numbers.

retrieveById(id)

A function to retrieve a Paymongo payment object by ID.

id - The payment ID.

retrieveAll($before, $after, $limit)

A function to retrieve multiple Paymongo payment objects

before - A cursor to use in pagination. For more details, check Payment Resource.
after - A cursor to use in pagination. For more details, check Payment Resource.
limit - For limiting the result set of your query. 10 is the default value.

Refund Resource

create($amount, $payment_id, $reason, $notes, $metadata)

A function to create a Paymongo refund object.

amount - The amount to be refunded.
payment_id - The payment ID to process the refund for.
reason - The reason of the refund. Check Payment Resource for all available reasons.
notes - Internal notes where you can put remarks about the refund.
metadata - a JSON object where you can store any other info that you might need for integration such as transaction reference numbers.

retrieveById($id)

A function to retrieve a Paymongo refund object by ID.

id - The payment ID.

Link Resource

create($amount, $description, $remarks)

A function to create a Paymongo link resource.

amount - The amount of the transaction.
description - The description of the transaction.
remarks - For internal notes. This value is not displayed on the checkout page that the user will see upon clicking the generated link.

retrieveById($id)

id - The link ID.

retrieveByReferenceNumber($refNum)

refNum - The reference number.

archive($id)

id - The link ID.

unarchive($id)

id - The link ID.

Why?

First, why not? Second, we needed to standardize libraries between several products including:

Payments via Paymongo for WooCommerce
Paymongo Payments -- to be updated

Plus, it's dev community contribution.

Why Phaymongo? It's PHP + Paymongo. :)

micahbule / phaymongo

Maintainers

Details

README

Installation

Usage

Features

Supported Paymongo Resources

API Documentation

new Phaymongo($public_key, $secret_key, $client_ops)

Parameters

Methods

new PaymongoClient($public_key, $secret_key, $client_ops)

Parameters

Methods

createRequest($method, $url, $payload, $use_public_key)

sendRequest($request, $request_opts)

Payment Intent Resource

create($amount, $payment_method_allowed, $payment_method_options, $description, $metadata)

retrieveById($id)

attachPaymentMethod($payment_intent_id, $payment_method_id, $payment_method_options, $return_url, $client_key)

Payment Method Resource

create($type, $details, $billing, $metadata)

retrieveById($id)

Source Resource

create($amount, $type, $success_url, $failed_url, $billing, $metadata)

retrieveById($id)

Payment Resource

create($amount, $source_id, $description, $statement_descriptor, $metadata)

retrieveById(id)

retrieveAll($before, $after, $limit)

Refund Resource

create($amount, $payment_id, $reason, $notes, $metadata)

retrieveById($id)

Link Resource

create($amount, $description, $remarks)

retrieveById($id)

retrieveByReferenceNumber($refNum)

archive($id)

unarchive($id)

Why?