Download the PHP package openpay/sdk without Composer

PHP client for Openpay API services (version 3.0.0)

This is a client implementing the payment services for Openpay at openpay.mx

Compatibility

PHP 5.2 or later

Requirements

PHP 5.2 or later cURL extension for PHP JSON extension for PHP Multibyte String extension for PHP

Installation

Agregar en la documentación lo siguiente:

• composer 1 : versión php 2.1.*
• composer 2: versión 2.2.* || version 3.0.0

Composer

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.

Once composer is installed, execute the following command in your project root to install this library:

Finally, be sure to include the autoloader:

Manual installation

To install, just:

• Clone the repository or download the library and copy/create a folder named 'Openpay' inside your project folder structure. If you downloaded the client library as a compressed file, uncompress it and create the proper folder structure.
• At the top of the PHP script in which the client library will be used (or in the section you include other libraries), add the client's library main script:

NOTE: In the example above, the library is located in the directory named Openpay, located inside the same directory that the PHP file which is including the cliente. Make sure to adjust the paths inside your project, otherwise the library will not work.

Implementation

Configuration

Before use the library will be necessary to set up your Merchant ID and Private key. There are three options:

• Use the methods *Openpay::setId(), Openpay::setApiKey() and Openpay::setCountry() . Just pass the proper parameters to each function:

• The PublicIp parameter refers to the IP of the customer who makes the purchase. This parameter is added for security reasons. It can be IPv4 and IPv6.

• Pass Merchant ID, Private Key, country code and public ip as parameters to the method Openpay::getInstance(), which is the instance generator:

• Configure the Marchant ID, the Private Key and country code as well, as environment variables. This method has its own advantages as this sensitive data is not exposed directly in any script.

NOTE: please, refer to PHP documentation for further information about this method.

Sandbox/Production Mode

By convenience and security, the sandbox mode is activated by default in the client library. This allows you to test your own code when implementing Openpay, before charging any credit card in production environment. Once you have finished your integration, use the method OpenPay::setProductionMode(FLAG) which will allow you to active/inactivate the sandbox mode.

` Also you can use environment variables for this purpose:

If its necessary, you can use the method Openpay::getProductionMode() to determine anytime, which is the sandbox mode status:

``

PHP client library intro

Once configured the library, you can use it to interact with Openpay API services. The first step is get an instance with the generator:

``

In this example $openpay will be an instance of a merchant (root), wich will be used to call any derived child resource. According to the current version of the Openpay API, these resources are:

• customers
• cards
• charges
• payouts
• fees
• plans

You can access all of these resources as public variables of the root instance, so, if you want to add a new customer you will be able to do it as follows:

``

Every call to any resource will return an instance of that resource. In the example above, calling the method add() in the resource customers will return an instance of Customer, calling the method add() in the resource cards will return an instance of Card, and so on. The only exception occurs when you retrieve a list of resources using the method getList(), in which case an array of instances will be returned:

`

On the other hand, the resources derived from Customer, according to Openpay API documentation, are:

• cards
• bankaccounts
• charges
• transfers
• payouts
• suscriptions

Parameters

Those methods which receive more than one parameter (for example, when trying to add a new customer or a new customer's card), must be passed as associatives arrays:

``

NOTE: Please refer to Openpay API docuemntation to determine wich parameters are accepted, wich required and which of those are optional, in every case.

Error handling

The Openpay API generates several types of errors depending on the situation, to handle this, the PHP client has implemented five type of exceptions:

• OpenpayApiTransactionError. This category includes those errors ocurred when the transaction does not complete successfully: declined card, insufficient funds, inactive destination account, etc.
• OpenpayApiRequestError. It refers to errors generated when a request to the API fail. Examples: invalid format in data request, incorrect parameters in the request, Openpay internal servers errors, etc.
• OpenpayApiConnectionError. These exceptions are generated when the library try to connect to the API but fails in the attempt. For example: timeouts, domain name servers, etc.
• OpenpayApiAuthError. Errors which are generated when the authentication data are specified in an invalid format or, if are not fully validated on the Openpay server (Merchant ID or Private Key).
• OpenpayApiError. This category includes all generic errors when processing with the client library.

All these error exceptions make available all the information returned by the Openpay API, with the following methods:

• getDescription(): Error description generated by Openpay server.
• getErrorCode(): Error code generated by Openpay server. When the error is generated before the request, this value is equal to zero.
• getCategory(): Error category generated and determined by Openpay server. When the error is generated before or during the request, this value is an empty string.
• getHttpCode(): HTTP error code generated when request the Openpay server. When the error is generated before or during the request, this value is equal to zero.
• getRequestId(): ID generated by the Openpay server when process a request. When the error is generated before the request, this value is an empty string.

The following is an more complete example of error catching:

``

Examples

Customers

Add a new customer to a merchant: ``

Get a customer: ``

Get the list of customers: ``

Update a customer: ``

Delete a customer: ``

Cards

On a merchant:

Add a card: ``

Get a card: ``

Get the list of cards: ``

Delete a card: ``

On a customer:

Add a card: ``

Get a card: ``

Get the list of cards: ``

Delete a card ``

Bank Accounts

Add a bank account to a customer: ``

Get a banck account ``

Get the list of bank accounts: ``

Delete a bank account: ``

Charges

On a Merchant:

Make a charge on a merchant: ``

Get a charge: ``

Get list of charges: ``

Make a capture: ``

Make a refund: ``

On a Customer:

Make a charge on a customer: ``

Get a charge: ``

Get list of charges: ``

Make a capture: ``

Make a refund: ``

Transfers

Make a transfer: ``

Get a transfer: ``

Get list of transfers: ``

Payouts

On a Merchant:

Make a payout on a merchant: ``

Get a payout: ``

Get list of payouts: ``

On a Customer:

Make a payout on a customer: ``

Get a payout: ``

Get list pf payouts: ``

Fees

Make a fee charge ``

Get list of fees charged: ``

Plans

Add a plan: ``

Get a plan: ``

Get list of plans: ``

Update a plan: ``

Delete a plan: ``

Get list of subscriptors of a plan: ``

Subscriptions

Add a subscription: `` See documetation for more detail, creating subscriptions.

Get a subscription: ``

Get list of subscriptions: ``

Update a subscription: ``

Delete a subscription: ``