@pagarme/pagarme-nodejs-sdk

Getting Started with PagarmeApiSDK

Introduction

Pagarme API

Building

Requirements

The SDK relies on Node.js and npm (to resolve dependencies). It also requires Typescript version 3.9+. You can download and install Node.js and npm from the official Node.js website.

NOTE: npm is installed by default when Node.js is installed.

Verify Successful Installation

Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:

• Node.js: node --version

• npm: npm --version

Install Dependencies

• To resolve all dependencies, go to the SDK root directory and run the following command with npm:

npm install

• This will install all dependencies in the node_modules folder.

Installation

The following section explains how to use the generated library in a new project.

1. Initialize the Node Project

• Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

• Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.

• To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:

npm init --y

2. Add Dependencies to the Client Library

• The created project manages its dependencies using its package.json file. In order to add a dependency on the PagarmeApiSDKLib client library, double click on the package.json file in the bar on the left and add the dependency to the package in it.

• To install the package in the project, run the following command in the terminal:

npm install

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
serviceRefererName	string
timeout	number	Timeout for API calls. Default: 0
httpClientOptions	Partial<HttpClientOptions>	Stable configurable http client options.
unstableHttpClientOptions	any	Unstable configurable http client options.
basicAuthCredentials	BasicAuthCredentials	The credential object for basicAuth

HttpClientOptions

Parameter	Type	Description
timeout	number	Timeout in milliseconds.
httpAgent	any	Custom http agent to be used when performing http requests.
httpsAgent	any	Custom https agent to be used when performing http requests.
retryConfig	Partial<RetryConfiguration>	Configurations to retry requests.

RetryConfiguration

Parameter	Type	Description
maxNumberOfRetries	number	Maximum number of retries. Default: 0
retryOnTimeout	boolean	Whether to retry on request timeout. Default: true
retryInterval	number	Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1
maximumRetryWaitTime	number	Overall wait time for the requests getting retried. Default: 0
backoffFactor	number	Used in calculation of wait time for next request in case of failure. Default: 2
httpStatusCodesToRetry	number[]	Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
httpMethodsToRetry	HttpMethod[]	Http methods to retry against. Default: ['GET', 'PUT']

The API client can be initialized as follows:

const client = new Client({
  basicAuthCredentials: {
    username: 'BasicAuthUserName',
    password: 'BasicAuthPassword'
  },
  serviceRefererName: 'ServiceRefererName',
  timeout: 0,
});

Authorization

This API uses the following authentication schemes.

• httpBasic (Basic Authentication)

API Errors

Here is the list of errors that the API might throw.

HTTP Status Code	Error Description	Exception Class
400	Invalid request	CustomError
401	Invalid API key	CustomError
404	An informed resource was not found	CustomError
412	Business validation error	CustomError
422	Contract validation error	CustomError
500	Internal server error	CustomError

List of APIs

• Subscriptions
• Orders
• Plans
• Invoices
• Customers
• Charges
• Recipients
• Tokens
• Transactions
• Transfers
• Payables
• Balance Operations

Classes Documentation

• ApiResponse
• ApiError