pnz-payments-sdk

Getting Started with Account and Transaction API Specification

Introduction

Swagger for Account and Transaction API Specification. This is heavily derived from the Open Banking UK API - see www.openbanking.org.uk for details.

Install the Package

Install the gem from the command line:

gem install pnz-payments-sdk -v 1.0.0

Or add the gem to your Gemfile and run bundle:

gem 'pnz-payments-sdk', '1.0.0'

For additional gem details, see the RubyGems page for the pnz-payments-sdk gem.

Test the SDK

To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:

rake

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
environment	Environment	The API environment. Default: Environment.PRODUCTION
connection	Faraday::Connection	The Faraday connection object passed by the SDK user for making requests
adapter	Faraday::Adapter	The Faraday adapter object passed by the SDK user for performing http requests
timeout	Float	The value to use for connection timeout. Default: 60
max_retries	Integer	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	Float	Pause in seconds between retries. Default: 1
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	Array	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array	A list of HTTP methods to retry. Default: %i[get put]
http_callback	HttpCallBack	The Http CallBack allows defining callables for pre and post API calls.
bearer_auth_credentials	BearerAuthCredentials	The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

client = AccountAndTransactionApiSpecification::Client.new(
  bearer_auth_credentials: BearerAuthCredentials.new(
    access_token: 'AccessToken'
  ),
  environment: Environment::PRODUCTION
)

Environments

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

Fields

Name	Description
production	Default
environment2	-

Authorization

This API uses the following authentication schemes.

• HTTPBearerAuthentication (OAuth 2 Bearer token)

List of APIs

• Direct Debits
• Scheduled Payments
• Standing Orders
• Accounts
• Balances
• Beneficiaries
• Offers
• Party
• Statements
• Transactions

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest