README

Introduction

API Security

Security is a significant consideration for payment platforms. As part of the registration process for each registered merchant account, merchants receive a security key used to authenticate communications in either direction.

Developers should consult the Boku API Signature Authentication Guide for additional details with respect to implementing security on the Boku APIs.

API Usage

When a consumer chooses to use a local payment-method (wallet), the consumer must go through an 'optin' flow to authenticate. This is accomplished using a redirect to the issuer's app or website where the consumer authenticates and completes the opt-in process.

After the consumer adds their local payment-method (wallet), as their registered payment method, the 'charge' method is used to charge the consumer's local payment-method.

If a customer decides to refund a transaction, the 'refund-charge' method can be used to refund the transaction.

API Versioning

The Boku Payment Gateway API is versioned to provide support for changes to functionality without affecting existing integrations. Each API URL includes version information that enables distinct functionality across different versions.

There are several types of changes that could result in a new API version:

New API functionality – new APIs, new parameters, additional information in responses, improved error reporting.
Deprecated API functionality – deprecated APIs, deprecated parameters, deprecated error messages.
Changes in functionality – existing functional behavior changes such as the returned result of a call. A warning is changed to an error. Validation becomes stricter or more lenient.

In these cases, Boku will release a new API version through a new endpoint(s). When new versions of existing APIs are added, support for existing versions is maintained. Unless otherwise stated, as a rule, compatibility is maintained across versions. Prior supported endpoints should have unchanged behavior. If an API is deprecated and scheduled to be removed, a notice of not less than 6 months will be given. Requests for extensions to this period can be considered.

Boku may make changes to the API within an existing version without changing the version number. An example of a non-versioning change would be the addition of an optional field to a request or to a response.

API Calls

URL Scheme

All the below API calls are against URLs that follow the pattern,

https://${api-node}.boku.com/${api-family}/${api-version}/${api-call}

Definitions for the above placeholders:

api-node: This follows the pattern '${country}-api4' (e.g. 'us-api4').
- 'country' is the two letter country code of the end-user's payment-method against which the call is made.
- The country code is required and is used for more efficient routing of the request.
- The country code in the url must match the country code supplied in the optin-request.country element.
api-family: Groups a family of related API methods.
- In this API, family is either one of:
  - 'optin' - For interacting with the user or handset to obtain billing approval.
  - 'billing' - For actually performing billing operations against the user.
api-version: In this version of the API, this value is always the string '3.0'.
- Calls under different version numbers may be used in the future to introduce non-compatible API changes.
api-call: The name particular API call or method to invoke, for example 'charge' or 'refund-charge'.
- This usually matches the XML root element name, sans the '-request' suffix.

Fully qualified API call URLs are documented with each of the example calls detailed below.

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "apimatic-bk/bk-sdk:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "apimatic-bk/bk-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/apimatic-bk/bk-sdk#1.0.0

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
country	`string`	Country code in ISO 3166-1-alpha-2 standard Default: `'gb'`
environment	`Environment`	The API environment. Default: `Environment.MERCHANT_TEST_ENVIRONMENT`
timeout	`int`	Timeout for API calls in seconds. Default: `0`
enableRetries	`bool`	Whether to enable retries and backoff feature. Default: `false`
numberOfRetries	`int`	The number of retries to make. Default: `0`
retryInterval	`float`	The retry time interval between the endpoint calls. Default: `1`
backOffFactor	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
maximumRetryWaitTime	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
retryOnTimeout	`bool`	Whether to retry on request timeout. Default: `true`
httpStatusCodesToRetry	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
httpMethodsToRetry	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls

The API client can be initialized as follows:

use BokuDirectPaymentsAPILib\Environment;
use BokuDirectPaymentsAPILib\BokuDirectPaymentsAPIClientBuilder;

$client = BokuDirectPaymentsAPIClientBuilder::init()
    ->environment(Environment::MERCHANT_TEST_ENVIRONMENT)
    ->country('gb')
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
MERCHANT_TEST_ENVIRONMENT	Default
PRODUCTION_ENVIRONMENT	-

apimatic-bk / bk-sdk

Maintainers

Package info

Statistics

Security