zea/rest-library

Library to connect with the PlacetoPay Rest api

dev-main 2022-10-12 20:37 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^6.5|^7.0
• psr/log: ^1.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: 3.*
• symfony/var-dumper: ^4.3

MIT

• Andres Zea

README

With this code you will be able to quickly connect with the PlacetoPay Rest service.

In order to see more comprehensive examples of how it works, please refer to the examples and the documentation

Installation

Using composer from your project

composer require zea/rest-library

Or If you just want to run the examples contained in this project run "composer install" to load the vendor autoload

Usage

Create an object with the configuration required for that instance

$placetopay = new Zea\RestLibrary\PlacetoPay([
    'login' => 'YOUR_LOGIN', // Provided by PlacetoPay
    'tranKey' => 'YOUR_TRANSACTIONAL_KEY', // Provided by PlacetoPay
    'baseUrl' => 'https://THE_BASE_URL_TO_POINT_AT',
    'timeout' => 10, // (optional) 15 by default
]);

Creating a new payment request to get a Payment Response

Simply provide the necessary payment information and you will get a Process Response if successful, for this example, are using the MINIMUM INFORMATION that must be provided, to see the complete structure, consult the documentation or the example in examples/basic/payment.php

$reference = 'COULD_BE_THE_PAYMENT_ORDER_ID";
$request = [
    'payment' => [
        'reference' => $reference,
        'description' => 'Testing payment',
        'amount' => [
            'currency' => 'USD',
            'total' => 120,
        ],
    ],
    'instrument' => [
        'card' => [
            'number' => '36545400000008',
            'expiration' => '12/20',
            'cvv' => '123',
            'installments' => 2
        ]
    ],
    'ipAddress' => '127.0.0.1',
    'userAgent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36',
];

$response = $placetopay->process($request);
if ($response->isSuccessful()) {
    $response->toArray()['response'];
} else {
    // There was some error so check the message and log it
    $response->status()->message();
}

Obtain information about a previously made payment

$response = $placetopay->query('THE_INTERNAL_REFERENCE_TO_QUERY');

if ($response->isSuccessful()) {

    if ($response->status()->isApproved()) {
        // The payment has been approved
    }
} else {
    // There was some error with the connection so check the message
    print_r($response->status()->message() . "\n");
}