Getting Started with PagarmeApiSDK

Introduction

Pagarme API

Requirements

The SDK requires Go version 1.18 or above.

Building

Install Dependencies

Resolve all the SDK dependencies, using the go get command.

Installation

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

1. Add SDK as a Dependency to the Application

• Add the following lines to your application's go.mod file:

replace pagarmeapisdk => ".\\PagarmeApiSDK" // local path to the SDK

require pagarmeapisdk v0.0.0

• Resolve the dependencies in the updated go.mod file, using the go get command.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

config := pagarmeapisdk.CreateConfiguration(
    pagarmeapisdk.WithServiceRefererName("ServiceRefererName"),
    pagarmeapisdk.WithBasicAuthUserName("BasicAuthUserName"),
    pagarmeapisdk.WithBasicAuthPassword("BasicAuthPassword"),
)
client := pagarmeapisdk.NewClient(config)

Authorization

This API uses Basic Authentication.

API Errors

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

List of APIs

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

Classes Documentation

• HttpConfiguration
• RetryConfiguration