Getting started

Pagarme API

How to Build

The generated code uses the Newtonsoft Json.NET NuGet Package. If the automatic NuGet package restore is enabled, these dependencies will be installed automatically. Therefore, you will need internet access for build.

1. Open the solution (PagarmeCoreApi.sln) file.
2. Invoke the build process using Ctrl+Shift+B shortcut key or using the Build menu as shown below.

How to Use

The build process generates a portable class library, which can be used like a normal class library. The generated library is compatible with Windows Forms, Windows RT, Windows Phone 8, Silverlight 5, Xamarin iOS, Xamarin Android and Mono. More information on how to use can be found at the MSDN Portable Class Libraries documentation.

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

1. Starting a new project

For starting a new project, right click on the current solution from the solution explorer and choose Add -> New Project.

Next, choose "Console Application", provide a TestConsoleProject as the project name and click OK.

2. Set as startup project

The new console project is the entry point for the eventual execution. This requires us to set the TestConsoleProject as the start-up project. To do this, right-click on the TestConsoleProject and choose Set as StartUp Project form the context menu.

3. Add reference of the library project

In order to use the PagarmeCoreApi library in the new project, first we must add a projet reference to the TestConsoleProject. First, right click on the References node in the solution explorer and click Add Reference....

Next, a window will be displayed where we must set the checkbox on PagarmeCoreApi.PCL and click OK. By doing this, we have added a reference of the PagarmeCoreApi.PCL project into the new TestConsoleProject.

4. Write sample code

Once the TestConsoleProject is created, a file named Program.cs will be visible in the solution explorer with an empty Main method. This is the entry point for the execution of the entire solution. Here, you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

How to Test

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
basicAuthUserName	The username to use with basic authentication
basicAuthPassword	The password to use with basic authentication

API client can be initialized as following.

// Configuration parameters and credentials
string basicAuthUserName = "basicAuthUserName"; // The username to use with basic authentication
string basicAuthPassword = "basicAuthPassword"; // The password to use with basic authentication

PagarmeCoreApiClient client = new PagarmeCoreApiClient(basicAuthUserName, basicAuthPassword);

Class Reference

List of Controllers

• PlansController
• SubscriptionsController
• OrdersController
• InvoicesController
• CustomersController
• ChargesController
• TransfersController
• RecipientsController
• TokensController
• TransactionsController

PlansController

Get singleton instance

The singleton instance of the PlansController class can be accessed from the API Client.

IPlansController plans = client.Plans;

GetPlan

Gets a plan

Task<Models.GetPlanResponse> GetPlan(string planId)

Parameters

Parameter	Tags	Description
planId	Required	Plan id

Example Usage

string planId = "plan_id";

Models.GetPlanResponse result = await plans.GetPlan(planId);

UpdatePlanMetadata

Updates the metadata from a plan

Task<Models.GetPlanResponse> UpdatePlanMetadata(string planId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	The plan id
request	Required	Request for updating the plan metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetPlanResponse result = await plans.UpdatePlanMetadata(planId, request, idempotencyKey);

UpdatePlanItem

Updates a plan item

Task<Models.GetPlanItemResponse> UpdatePlanItem(
        string planId,
        string planItemId,
        Models.UpdatePlanItemRequest body,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
planItemId	Required	Plan item id
body	Required	Request for updating the plan item
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
string planItemId = "plan_item_id";
var body = new Models.UpdatePlanItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetPlanItemResponse result = await plans.UpdatePlanItem(planId, planItemId, body, idempotencyKey);

CreatePlanItem

Adds a new item to a plan

Task<Models.GetPlanItemResponse> CreatePlanItem(string planId, Models.CreatePlanItemRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
request	Required	Request for creating a plan item
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
var request = new Models.CreatePlanItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetPlanItemResponse result = await plans.CreatePlanItem(planId, request, idempotencyKey);

GetPlanItem

Gets a plan item

Task<Models.GetPlanItemResponse> GetPlanItem(string planId, string planItemId)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
planItemId	Required	Plan item id

Example Usage

string planId = "plan_id";
string planItemId = "plan_item_id";

Models.GetPlanItemResponse result = await plans.GetPlanItem(planId, planItemId);

CreatePlan

Creates a new plan

Task<Models.GetPlanResponse> CreatePlan(Models.CreatePlanRequest body, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	Required	Request for creating a plan
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var body = new Models.CreatePlanRequest();
string idempotencyKey = "idempotency-key";

Models.GetPlanResponse result = await plans.CreatePlan(body, idempotencyKey);

DeletePlanItem

Removes an item from a plan

Task<Models.GetPlanItemResponse> DeletePlanItem(string planId, string planItemId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
planItemId	Required	Plan item id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
string planItemId = "plan_item_id";
string idempotencyKey = "idempotency-key";

Models.GetPlanItemResponse result = await plans.DeletePlanItem(planId, planItemId, idempotencyKey);

GetPlans

Gets all plans

Task<Models.ListPlansResponse> GetPlans(
        int? page = null,
        int? size = null,
        string name = null,
        string status = null,
        string billingType = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size
name	Optional	Filter for Plan's name
status	Optional	Filter for Plan's status
billingType	Optional	Filter for plan's billing type
createdSince	Optional	Filter for plan's creation date start range
createdUntil	Optional	Filter for plan's creation date end range

Example Usage

int? page = 197;
int? size = 197;
string name = "name";
string status = "status";
string billingType = "billing_type";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListPlansResponse result = await plans.GetPlans(page, size, name, status, billingType, createdSince, createdUntil);

UpdatePlan

Updates a plan

Task<Models.GetPlanResponse> UpdatePlan(string planId, Models.UpdatePlanRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
request	Required	Request for updating a plan
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
var request = new Models.UpdatePlanRequest();
string idempotencyKey = "idempotency-key";

Models.GetPlanResponse result = await plans.UpdatePlan(planId, request, idempotencyKey);

DeletePlan

Deletes a plan

Task<Models.GetPlanResponse> DeletePlan(string planId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	Required	Plan id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string planId = "plan_id";
string idempotencyKey = "idempotency-key";

Models.GetPlanResponse result = await plans.DeletePlan(planId, idempotencyKey);

Back to List of Controllers

SubscriptionsController

Get singleton instance

The singleton instance of the SubscriptionsController class can be accessed from the API Client.

ISubscriptionsController subscriptions = client.Subscriptions;

UpdateSubscriptionCard

Updates the credit card from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionCard(string subscriptionId, Models.UpdateSubscriptionCardRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Required	Request for updating a card
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionCardRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionCard(subscriptionId, request, idempotencyKey);

DeleteUsage

Deletes a usage

Task<Models.GetUsageResponse> DeleteUsage(
        string subscriptionId,
        string itemId,
        string usageId,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
itemId	Required	The subscription item id
usageId	Required	The usage id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";
string usageId = "usage_id";
string idempotencyKey = "idempotency-key";

Models.GetUsageResponse result = await subscriptions.DeleteUsage(subscriptionId, itemId, usageId, idempotencyKey);

CreateDiscount

Creates a discount

Task<Models.GetDiscountResponse> CreateDiscount(string subscriptionId, Models.CreateDiscountRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Required	Request for creating a discount
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.CreateDiscountRequest();
string idempotencyKey = "idempotency-key";

Models.GetDiscountResponse result = await subscriptions.CreateDiscount(subscriptionId, request, idempotencyKey);

CreateAnUsage

Create Usage

Task<Models.GetUsageResponse> CreateAnUsage(string subscriptionId, string itemId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
itemId	Required	Item id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";
string idempotencyKey = "idempotency-key";

Models.GetUsageResponse result = await subscriptions.CreateAnUsage(subscriptionId, itemId, idempotencyKey);

UpdateCurrentCycleStatus

TODO: Add a method description

Task UpdateCurrentCycleStatus(string subscriptionId, Models.UpdateCurrentCycleStatusRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
request	Required	Request for updating the end date of the subscription current status
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateCurrentCycleStatusRequest();
string idempotencyKey = "idempotency-key";

await subscriptions.UpdateCurrentCycleStatus(subscriptionId, request, idempotencyKey);

UpdateSubscriptionPaymentMethod

Updates the payment method from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionPaymentMethod(string subscriptionId, Models.UpdateSubscriptionPaymentMethodRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Required	Request for updating the paymentmethod from a subscription
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionPaymentMethodRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionPaymentMethod(subscriptionId, request, idempotencyKey);

DeleteDiscount

Deletes a discount

Task<Models.GetDiscountResponse> DeleteDiscount(string subscriptionId, string discountId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
discountId	Required	Discount Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string discountId = "discount_id";
string idempotencyKey = "idempotency-key";

Models.GetDiscountResponse result = await subscriptions.DeleteDiscount(subscriptionId, discountId, idempotencyKey);

GetSubscriptionItems

Get Subscription Items

Task<Models.ListSubscriptionItemsResponse> GetSubscriptionItems(
        string subscriptionId,
        int? page = null,
        int? size = null,
        string name = null,
        string code = null,
        string status = null,
        string description = null,
        string createdSince = null,
        string createdUntil = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
page	Optional	Page number
size	Optional	Page size
name	Optional	The item name
code	Optional	Identification code in the client system
status	Optional	The item statis
description	Optional	The item description
createdSince	Optional	Filter for item's creation date start range
createdUntil	Optional	Filter for item's creation date end range

Example Usage

string subscriptionId = "subscription_id";
int? page = 155;
int? size = 155;
string name = "name";
string code = "code";
string status = "status";
string description = "description";
string createdSince = "created_since";
string createdUntil = "created_until";

Models.ListSubscriptionItemsResponse result = await subscriptions.GetSubscriptionItems(subscriptionId, page, size, name, code, status, description, createdSince, createdUntil);

GetSubscriptionItem

Get Subscription Item

Task<Models.GetSubscriptionItemResponse> GetSubscriptionItem(string subscriptionId, string itemId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
itemId	Required	Item id

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";

Models.GetSubscriptionItemResponse result = await subscriptions.GetSubscriptionItem(subscriptionId, itemId);

GetSubscriptions

Gets all subscriptions

Task<Models.ListSubscriptionsResponse> GetSubscriptions(
        int? page = null,
        int? size = null,
        string code = null,
        string billingType = null,
        string customerId = null,
        string planId = null,
        string cardId = null,
        string status = null,
        DateTime? nextBillingSince = null,
        DateTime? nextBillingUntil = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size
code	Optional	Filter for subscription's code
billingType	Optional	Filter for subscription's billing type
customerId	Optional	Filter for subscription's customer id
planId	Optional	Filter for subscription's plan id
cardId	Optional	Filter for subscription's card id
status	Optional	Filter for subscription's status
nextBillingSince	Optional	Filter for subscription's next billing date start range
nextBillingUntil	Optional	Filter for subscription's next billing date end range
createdSince	Optional	Filter for subscription's creation date start range
createdUntil	Optional	Filter for subscriptions creation date end range

Example Usage

int? page = 155;
int? size = 155;
string code = "code";
string billingType = "billing_type";
string customerId = "customer_id";
string planId = "plan_id";
string cardId = "card_id";
string status = "status";
DateTime? nextBillingSince = DateTime.Now();
DateTime? nextBillingUntil = DateTime.Now();
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListSubscriptionsResponse result = await subscriptions.GetSubscriptions(page, size, code, billingType, customerId, planId, cardId, status, nextBillingSince, nextBillingUntil, createdSince, createdUntil);

CancelSubscription

Cancels a subscription

Task<Models.GetSubscriptionResponse> CancelSubscription(string subscriptionId, Models.CreateCancelSubscriptionRequest request = null, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Optional	Request for cancelling a subscription
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.CreateCancelSubscriptionRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.CancelSubscription(subscriptionId, request, idempotencyKey);

CreateIncrement

Creates a increment

Task<Models.GetIncrementResponse> CreateIncrement(string subscriptionId, Models.CreateIncrementRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Required	Request for creating a increment
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.CreateIncrementRequest();
string idempotencyKey = "idempotency-key";

Models.GetIncrementResponse result = await subscriptions.CreateIncrement(subscriptionId, request, idempotencyKey);

CreateUsage

Creates a usage

Task<Models.GetUsageResponse> CreateUsage(
        string subscriptionId,
        string itemId,
        Models.CreateUsageRequest body,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
itemId	Required	Item id
body	Required	Request for creating a usage
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";
var body = new Models.CreateUsageRequest();
string idempotencyKey = "idempotency-key";

Models.GetUsageResponse result = await subscriptions.CreateUsage(subscriptionId, itemId, body, idempotencyKey);

CreateSubscription

Creates a new subscription

Task<Models.GetSubscriptionResponse> CreateSubscription(Models.CreateSubscriptionRequest body, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	Required	Request for creating a subscription
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var body = new Models.CreateSubscriptionRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.CreateSubscription(body, idempotencyKey);

GetDiscountById

TODO: Add a method description

Task<Models.GetDiscountResponse> GetDiscountById(string subscriptionId, string discountId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
discountId	Required	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string discountId = "discountId";

Models.GetDiscountResponse result = await subscriptions.GetDiscountById(subscriptionId, discountId);

UpdateSubscriptionAffiliationId

TODO: Add a method description

Task<Models.GetSubscriptionResponse> UpdateSubscriptionAffiliationId(string subscriptionId, Models.UpdateSubscriptionAffiliationIdRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	TODO: Add a parameter description
request	Required	Request for updating a subscription affiliation id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionAffiliationIdRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionAffiliationId(subscriptionId, request, idempotencyKey);

UpdateSubscriptionMetadata

Updates the metadata from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionMetadata(string subscriptionId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
request	Required	Request for updating the subscrption metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionMetadata(subscriptionId, request, idempotencyKey);

DeleteIncrement

Deletes a increment

Task<Models.GetIncrementResponse> DeleteIncrement(string subscriptionId, string incrementId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
incrementId	Required	Increment id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string incrementId = "increment_id";
string idempotencyKey = "idempotency-key";

Models.GetIncrementResponse result = await subscriptions.DeleteIncrement(subscriptionId, incrementId, idempotencyKey);

GetSubscriptionCycles

TODO: Add a method description

Task<Models.ListCyclesResponse> GetSubscriptionCycles(string subscriptionId, string page, string size)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
page	Required	Page number
size	Required	Page size

Example Usage

string subscriptionId = "subscription_id";
string page = "page";
string size = "size";

Models.ListCyclesResponse result = await subscriptions.GetSubscriptionCycles(subscriptionId, page, size);

GetIncrementById

TODO: Add a method description

Task<Models.GetIncrementResponse> GetIncrementById(string subscriptionId, string incrementId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription Id
incrementId	Required	The increment Id

Example Usage

string subscriptionId = "subscription_id";
string incrementId = "increment_id";

Models.GetIncrementResponse result = await subscriptions.GetIncrementById(subscriptionId, incrementId);

GetDiscounts

TODO: Add a method description

Task<Models.ListDiscountsResponse> GetDiscounts(string subscriptionId, int page, int size)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
page	Required	Page number
size	Required	Page size

Example Usage

string subscriptionId = "subscription_id";
int page = 155;
int size = 155;

Models.ListDiscountsResponse result = await subscriptions.GetDiscounts(subscriptionId, page, size);

UpdateSubscriptionBillingDate

Updates the billing date from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionBillingDate(string subscriptionId, Models.UpdateSubscriptionBillingDateRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
request	Required	Request for updating the subscription billing date
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionBillingDateRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionBillingDate(subscriptionId, request, idempotencyKey);

DeleteSubscriptionItem

Deletes a subscription item

Task<Models.GetSubscriptionItemResponse> DeleteSubscriptionItem(string subscriptionId, string subscriptionItemId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
subscriptionItemId	Required	Subscription item id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string subscriptionItemId = "subscription_item_id";
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionItemResponse result = await subscriptions.DeleteSubscriptionItem(subscriptionId, subscriptionItemId, idempotencyKey);

GetIncrements

TODO: Add a method description

Task<Models.ListIncrementsResponse> GetIncrements(string subscriptionId, int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
page	Optional	Page number
size	Optional	Page size

Example Usage

string subscriptionId = "subscription_id";
int? page = 155;
int? size = 155;

Models.ListIncrementsResponse result = await subscriptions.GetIncrements(subscriptionId, page, size);

UpdateSubscriptionDueDays

Updates the boleto due days from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionDueDays(string subscriptionId, Models.UpdateSubscriptionDueDaysRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
request	Required	TODO: Add a parameter description
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionDueDaysRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionDueDays(subscriptionId, request, idempotencyKey);

UpdateSubscriptionStartAt

Updates the start at date from a subscription

Task<Models.GetSubscriptionResponse> UpdateSubscriptionStartAt(string subscriptionId, Models.UpdateSubscriptionStartAtRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
request	Required	Request for updating the subscription start date
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionStartAtRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionStartAt(subscriptionId, request, idempotencyKey);

UpdateSubscriptionItem

Updates a subscription item

Task<Models.GetSubscriptionItemResponse> UpdateSubscriptionItem(
        string subscriptionId,
        string itemId,
        Models.UpdateSubscriptionItemRequest body,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
itemId	Required	Item id
body	Required	Request for updating a subscription item
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";
var body = new Models.UpdateSubscriptionItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionItemResponse result = await subscriptions.UpdateSubscriptionItem(subscriptionId, itemId, body, idempotencyKey);

CreateSubscriptionItem

Creates a new Subscription item

Task<Models.GetSubscriptionItemResponse> CreateSubscriptionItem(string subscriptionId, Models.CreateSubscriptionItemRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id
request	Required	Request for creating a subscription item
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.CreateSubscriptionItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionItemResponse result = await subscriptions.CreateSubscriptionItem(subscriptionId, request, idempotencyKey);

GetSubscription

Gets a subscription

Task<Models.GetSubscriptionResponse> GetSubscription(string subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription id

Example Usage

string subscriptionId = "subscription_id";

Models.GetSubscriptionResponse result = await subscriptions.GetSubscription(subscriptionId);

GetUsages

Lists all usages from a subscription item

Task<Models.ListUsagesResponse> GetUsages(
        string subscriptionId,
        string itemId,
        int? page = null,
        int? size = null,
        string code = null,
        string mgroup = null,
        DateTime? usedSince = null,
        DateTime? usedUntil = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
itemId	Required	The subscription item id
page	Optional	Page number
size	Optional	Page size
code	Optional	Identification code in the client system
mgroup	Optional	Identification group in the client system
usedSince	Optional	TODO: Add a parameter description
usedUntil	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string itemId = "item_id";
int? page = 155;
int? size = 155;
string code = "code";
string mgroup = "group";
DateTime? usedSince = DateTime.Now();
DateTime? usedUntil = DateTime.Now();

Models.ListUsagesResponse result = await subscriptions.GetUsages(subscriptionId, itemId, page, size, code, mgroup, usedSince, usedUntil);

UpdateLatestPeriodEndAt

TODO: Add a method description

Task<Models.GetSubscriptionResponse> UpdateLatestPeriodEndAt(string subscriptionId, Models.UpdateCurrentCycleEndDateRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	TODO: Add a parameter description
request	Required	Request for updating the end date of the current signature cycle
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateCurrentCycleEndDateRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateLatestPeriodEndAt(subscriptionId, request, idempotencyKey);

UpdateSubscriptionMiniumPrice

Atualização do valor mínimo da assinatura

Task<Models.GetSubscriptionResponse> UpdateSubscriptionMiniumPrice(string subscriptionId, Models.UpdateSubscriptionMinimumPriceRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
request	Required	Request da requisição com o valor mínimo que será configurado
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
var request = new Models.UpdateSubscriptionMinimumPriceRequest();
string idempotencyKey = "idempotency-key";

Models.GetSubscriptionResponse result = await subscriptions.UpdateSubscriptionMiniumPrice(subscriptionId, request, idempotencyKey);

GetSubscriptionCycleById

TODO: Add a method description

Task<Models.GetPeriodResponse> GetSubscriptionCycleById(string subscriptionId, string cycleId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription id
cycleId	Required	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string cycleId = "cycleId";

Models.GetPeriodResponse result = await subscriptions.GetSubscriptionCycleById(subscriptionId, cycleId);

RenewSubscription

TODO: Add a method description

Task<Models.GetPeriodResponse> RenewSubscription(string subscriptionId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	TODO: Add a parameter description
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string idempotencyKey = "idempotency-key";

Models.GetPeriodResponse result = await subscriptions.RenewSubscription(subscriptionId, idempotencyKey);

GetUsageReport

TODO: Add a method description

Task<Models.GetUsageReportResponse> GetUsageReport(string subscriptionId, string periodId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	The subscription Id
periodId	Required	The period Id

Example Usage

string subscriptionId = "subscription_id";
string periodId = "period_id";

Models.GetUsageReportResponse result = await subscriptions.GetUsageReport(subscriptionId, periodId);

UpdateSplitSubscription

TODO: Add a method description

Task<Models.GetSubscriptionResponse> UpdateSplitSubscription(string id, Models.UpdateSubscriptionSplitRequest request)

Parameters

Parameter	Tags	Description
id	Required	Subscription's id
request	Required	TODO: Add a parameter description

Example Usage

string id = "id";
var request = new Models.UpdateSubscriptionSplitRequest();

Models.GetSubscriptionResponse result = await subscriptions.UpdateSplitSubscription(id, request);

Back to List of Controllers

OrdersController

Get singleton instance

The singleton instance of the OrdersController class can be accessed from the API Client.

IOrdersController orders = client.Orders;

GetOrders

Gets all orders

Task<Models.ListOrderResponse> GetOrders(
        int? page = null,
        int? size = null,
        string code = null,
        string status = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null,
        string customerId = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size
code	Optional	Filter for order's code
status	Optional	Filter for order's status
createdSince	Optional	Filter for order's creation date start range
createdUntil	Optional	Filter for order's creation date end range
customerId	Optional	Filter for order's customer id

Example Usage

int? page = 155;
int? size = 155;
string code = "code";
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();
string customerId = "customer_id";

Models.ListOrderResponse result = await orders.GetOrders(page, size, code, status, createdSince, createdUntil, customerId);

DeleteAllOrderItems

TODO: Add a method description

Task<Models.GetOrderResponse> DeleteAllOrderItems(string orderId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string orderId = "orderId";
string idempotencyKey = "idempotency-key";

Models.GetOrderResponse result = await orders.DeleteAllOrderItems(orderId, idempotencyKey);

UpdateOrderItem

TODO: Add a method description

Task<Models.GetOrderItemResponse> UpdateOrderItem(
        string orderId,
        string itemId,
        Models.UpdateOrderItemRequest request,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order Id
itemId	Required	Item Id
request	Required	Item Model
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string orderId = "orderId";
string itemId = "itemId";
var request = new Models.UpdateOrderItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetOrderItemResponse result = await orders.UpdateOrderItem(orderId, itemId, request, idempotencyKey);

DeleteOrderItem

TODO: Add a method description

Task<Models.GetOrderItemResponse> DeleteOrderItem(string orderId, string itemId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order Id
itemId	Required	Item Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string orderId = "orderId";
string itemId = "itemId";
string idempotencyKey = "idempotency-key";

Models.GetOrderItemResponse result = await orders.DeleteOrderItem(orderId, itemId, idempotencyKey);

CloseOrder

TODO: Add a method description

Task<Models.GetOrderResponse> CloseOrder(string id, Models.UpdateOrderStatusRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
id	Required	Order Id
request	Required	Update Order Model
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string id = "id";
var request = new Models.UpdateOrderStatusRequest();
string idempotencyKey = "idempotency-key";

Models.GetOrderResponse result = await orders.CloseOrder(id, request, idempotencyKey);

CreateOrder

Creates a new Order

Task<Models.GetOrderResponse> CreateOrder(Models.CreateOrderRequest body, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	Required	Request for creating an order
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var body = new Models.CreateOrderRequest();
string idempotencyKey = "idempotency-key";

Models.GetOrderResponse result = await orders.CreateOrder(body, idempotencyKey);

CreateOrderItem

TODO: Add a method description

Task<Models.GetOrderItemResponse> CreateOrderItem(string orderId, Models.CreateOrderItemRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order Id
request	Required	Order Item Model
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string orderId = "orderId";
var request = new Models.CreateOrderItemRequest();
string idempotencyKey = "idempotency-key";

Models.GetOrderItemResponse result = await orders.CreateOrderItem(orderId, request, idempotencyKey);

GetOrderItem

TODO: Add a method description

Task<Models.GetOrderItemResponse> GetOrderItem(string orderId, string itemId)

Parameters

Parameter	Tags	Description
orderId	Required	Order Id
itemId	Required	Item Id

Example Usage

string orderId = "orderId";
string itemId = "itemId";

Models.GetOrderItemResponse result = await orders.GetOrderItem(orderId, itemId);

UpdateOrderMetadata

Updates the metadata from an order

Task<Models.GetOrderResponse> UpdateOrderMetadata(string orderId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	Required	The order id
request	Required	Request for updating the order metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string orderId = "order_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetOrderResponse result = await orders.UpdateOrderMetadata(orderId, request, idempotencyKey);

GetOrder

Gets an order

Task<Models.GetOrderResponse> GetOrder(string orderId)

Parameters

Parameter	Tags	Description
orderId	Required	Order id

Example Usage

string orderId = "order_id";

Models.GetOrderResponse result = await orders.GetOrder(orderId);

Back to List of Controllers

InvoicesController

Get singleton instance

The singleton instance of the InvoicesController class can be accessed from the API Client.

IInvoicesController invoices = client.Invoices;

GetPartialInvoice

TODO: Add a method description

Task<Models.GetInvoiceResponse> GetPartialInvoice(string subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id

Example Usage

string subscriptionId = "subscription_id";

Models.GetInvoiceResponse result = await invoices.GetPartialInvoice(subscriptionId);

CancelInvoice

Cancels an invoice

Task<Models.GetInvoiceResponse> CancelInvoice(string invoiceId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
invoiceId	Required	Invoice id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string invoiceId = "invoice_id";
string idempotencyKey = "idempotency-key";

Models.GetInvoiceResponse result = await invoices.CancelInvoice(invoiceId, idempotencyKey);

CreateInvoice

Create an Invoice

Task<Models.GetInvoiceResponse> CreateInvoice(
        string subscriptionId,
        string cycleId,
        Models.CreateInvoiceRequest request = null,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	Required	Subscription Id
cycleId	Required	Cycle Id
request	Optional	TODO: Add a parameter description
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string subscriptionId = "subscription_id";
string cycleId = "cycle_id";
var request = new Models.CreateInvoiceRequest();
string idempotencyKey = "idempotency-key";

Models.GetInvoiceResponse result = await invoices.CreateInvoice(subscriptionId, cycleId, request, idempotencyKey);

UpdateInvoiceMetadata

Updates the metadata from an invoice

Task<Models.GetInvoiceResponse> UpdateInvoiceMetadata(string invoiceId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
invoiceId	Required	The invoice id
request	Required	Request for updating the invoice metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string invoiceId = "invoice_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetInvoiceResponse result = await invoices.UpdateInvoiceMetadata(invoiceId, request, idempotencyKey);

GetInvoices

Gets all invoices

Task<Models.ListInvoicesResponse> GetInvoices(
        int? page = null,
        int? size = null,
        string code = null,
        string customerId = null,
        string subscriptionId = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null,
        string status = null,
        DateTime? dueSince = null,
        DateTime? dueUntil = null,
        string customerDocument = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size
code	Optional	Filter for Invoice's code
customerId	Optional	Filter for Invoice's customer id
subscriptionId	Optional	Filter for Invoice's subscription id
createdSince	Optional	Filter for Invoice's creation date start range
createdUntil	Optional	Filter for Invoices creation date end range
status	Optional	Filter for Invoice's status
dueSince	Optional	Filter for Invoice's due date start range
dueUntil	Optional	Filter for Invoice's due date end range
customerDocument	Optional	TODO: Add a parameter description

Example Usage

int? page = 155;
int? size = 155;
string code = "code";
string customerId = "customer_id";
string subscriptionId = "subscription_id";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();
string status = "status";
DateTime? dueSince = DateTime.Now();
DateTime? dueUntil = DateTime.Now();
string customerDocument = "customer_document";

Models.ListInvoicesResponse result = await invoices.GetInvoices(page, size, code, customerId, subscriptionId, createdSince, createdUntil, status, dueSince, dueUntil, customerDocument);

GetInvoice

Gets an invoice

Task<Models.GetInvoiceResponse> GetInvoice(string invoiceId)

Parameters

Parameter	Tags	Description
invoiceId	Required	Invoice Id

Example Usage

string invoiceId = "invoice_id";

Models.GetInvoiceResponse result = await invoices.GetInvoice(invoiceId);

UpdateInvoiceStatus

Updates the status from an invoice

Task<Models.GetInvoiceResponse> UpdateInvoiceStatus(string invoiceId, Models.UpdateInvoiceStatusRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
invoiceId	Required	Invoice Id
request	Required	Request for updating an invoice's status
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string invoiceId = "invoice_id";
var request = new Models.UpdateInvoiceStatusRequest();
string idempotencyKey = "idempotency-key";

Models.GetInvoiceResponse result = await invoices.UpdateInvoiceStatus(invoiceId, request, idempotencyKey);

Back to List of Controllers

CustomersController

Get singleton instance

The singleton instance of the CustomersController class can be accessed from the API Client.

ICustomersController customers = client.Customers;

UpdateCard

Updates a card

Task<Models.GetCardResponse> UpdateCard(
        string customerId,
        string cardId,
        Models.UpdateCardRequest request,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
cardId	Required	Card id
request	Required	Request for updating a card
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string cardId = "card_id";
var request = new Models.UpdateCardRequest();
string idempotencyKey = "idempotency-key";

Models.GetCardResponse result = await customers.UpdateCard(customerId, cardId, request, idempotencyKey);

UpdateAddress

Updates an address

Task<Models.GetAddressResponse> UpdateAddress(
        string customerId,
        string addressId,
        Models.UpdateAddressRequest request,
        string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
addressId	Required	Address Id
request	Required	Request for updating an address
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string addressId = "address_id";
var request = new Models.UpdateAddressRequest();
string idempotencyKey = "idempotency-key";

Models.GetAddressResponse result = await customers.UpdateAddress(customerId, addressId, request, idempotencyKey);

DeleteAccessToken

Delete a customer's access token

Task<Models.GetAccessTokenResponse> DeleteAccessToken(string customerId, string tokenId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
tokenId	Required	Token Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string tokenId = "token_id";
string idempotencyKey = "idempotency-key";

Models.GetAccessTokenResponse result = await customers.DeleteAccessToken(customerId, tokenId, idempotencyKey);

CreateAccessToken

Creates a access token for a customer

Task<Models.GetAccessTokenResponse> CreateAccessToken(string customerId, Models.CreateAccessTokenRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
request	Required	Request for creating a access token
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
var request = new Models.CreateAccessTokenRequest();
string idempotencyKey = "idempotency-key";

Models.GetAccessTokenResponse result = await customers.CreateAccessToken(customerId, request, idempotencyKey);

CreateAddress

Creates a new address for a customer

Task<Models.GetAddressResponse> CreateAddress(string customerId, Models.CreateAddressRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
request	Required	Request for creating an address
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
var request = new Models.CreateAddressRequest();
string idempotencyKey = "idempotency-key";

Models.GetAddressResponse result = await customers.CreateAddress(customerId, request, idempotencyKey);

CreateCustomer

Creates a new customer

Task<Models.GetCustomerResponse> CreateCustomer(Models.CreateCustomerRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	Required	Request for creating a customer
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var request = new Models.CreateCustomerRequest();
string idempotencyKey = "idempotency-key";

Models.GetCustomerResponse result = await customers.CreateCustomer(request, idempotencyKey);

DeleteAccessTokens

Delete a Customer's access tokens

Task<Models.ListAccessTokensResponse> DeleteAccessTokens(string customerId)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id

Example Usage

string customerId = "customer_id";

Models.ListAccessTokensResponse result = await customers.DeleteAccessTokens(customerId);

GetAddress

Get a customer's address

Task<Models.GetAddressResponse> GetAddress(string customerId, string addressId)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
addressId	Required	Address Id

Example Usage

string customerId = "customer_id";
string addressId = "address_id";

Models.GetAddressResponse result = await customers.GetAddress(customerId, addressId);

DeleteAddress

Delete a Customer's address

Task<Models.GetAddressResponse> DeleteAddress(string customerId, string addressId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
addressId	Required	Address Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string addressId = "address_id";
string idempotencyKey = "idempotency-key";

Models.GetAddressResponse result = await customers.DeleteAddress(customerId, addressId, idempotencyKey);

CreateCard

Creates a new card for a customer

Task<Models.GetCardResponse> CreateCard(string customerId, Models.CreateCardRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
request	Required	Request for creating a card
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
var request = new Models.CreateCardRequest();
string idempotencyKey = "idempotency-key";

Models.GetCardResponse result = await customers.CreateCard(customerId, request, idempotencyKey);

GetCustomers

Get all Customers

Task<Models.ListCustomersResponse> GetCustomers(
        string name = null,
        string document = null,
        int? page = 1,
        int? size = 10,
        string email = null,
        string code = null)

Parameters

Parameter	Tags	Description
name	Optional	Name of the Customer
document	Optional	Document of the Customer
page	Optional DefaultValue	Current page the the search
size	Optional DefaultValue	Quantity pages of the search
email	Optional	Customer's email
code	Optional	Customer's code

Example Usage

string name = "name";
string document = "document";
int? page = 1;
int? size = 10;
string email = "email";
string code = "Code";

Models.ListCustomersResponse result = await customers.GetCustomers(name, document, page, size, email, code);

UpdateCustomer

Updates a customer

Task<Models.GetCustomerResponse> UpdateCustomer(string customerId, Models.UpdateCustomerRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
request	Required	Request for updating a customer
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
var request = new Models.UpdateCustomerRequest();
string idempotencyKey = "idempotency-key";

Models.GetCustomerResponse result = await customers.UpdateCustomer(customerId, request, idempotencyKey);

GetAccessTokens

Get all access tokens from a customer

Task<Models.ListAccessTokensResponse> GetAccessTokens(string customerId, int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
page	Optional	Page number
size	Optional	Page size

Example Usage

string customerId = "customer_id";
int? page = 247;
int? size = 247;

Models.ListAccessTokensResponse result = await customers.GetAccessTokens(customerId, page, size);

GetCards

Get all cards from a customer

Task<Models.ListCardsResponse> GetCards(string customerId, int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
page	Optional	Page number
size	Optional	Page size

Example Usage

string customerId = "customer_id";
int? page = 247;
int? size = 247;

Models.ListCardsResponse result = await customers.GetCards(customerId, page, size);

RenewCard

Renew a card

Task<Models.GetCardResponse> RenewCard(string customerId, string cardId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
cardId	Required	Card Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string cardId = "card_id";
string idempotencyKey = "idempotency-key";

Models.GetCardResponse result = await customers.RenewCard(customerId, cardId, idempotencyKey);

GetAccessToken

Get a Customer's access token

Task<Models.GetAccessTokenResponse> GetAccessToken(string customerId, string tokenId)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
tokenId	Required	Token Id

Example Usage

string customerId = "customer_id";
string tokenId = "token_id";

Models.GetAccessTokenResponse result = await customers.GetAccessToken(customerId, tokenId);

UpdateCustomerMetadata

Updates the metadata a customer

Task<Models.GetCustomerResponse> UpdateCustomerMetadata(string customerId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	The customer id
request	Required	Request for updating the customer metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetCustomerResponse result = await customers.UpdateCustomerMetadata(customerId, request, idempotencyKey);

DeleteCard

Delete a customer's card

Task<Models.GetCardResponse> DeleteCard(string customerId, string cardId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id
cardId	Required	Card Id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string customerId = "customer_id";
string cardId = "card_id";
string idempotencyKey = "idempotency-key";

Models.GetCardResponse result = await customers.DeleteCard(customerId, cardId, idempotencyKey);

GetAddresses

Gets all adressess from a customer

Task<Models.ListAddressesResponse> GetAddresses(string customerId, int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
page	Optional	Page number
size	Optional	Page size

Example Usage

string customerId = "customer_id";
int? page = 247;
int? size = 247;

Models.ListAddressesResponse result = await customers.GetAddresses(customerId, page, size);

GetCustomer

Get a customer

Task<Models.GetCustomerResponse> GetCustomer(string customerId)

Parameters

Parameter	Tags	Description
customerId	Required	Customer Id

Example Usage

string customerId = "customer_id";

Models.GetCustomerResponse result = await customers.GetCustomer(customerId);

GetCard

Get a customer's card

Task<Models.GetCardResponse> GetCard(string customerId, string cardId)

Parameters

Parameter	Tags	Description
customerId	Required	Customer id
cardId	Required	Card id

Example Usage

string customerId = "customer_id";
string cardId = "card_id";

Models.GetCardResponse result = await customers.GetCard(customerId, cardId);

Back to List of Controllers

ChargesController

Get singleton instance

The singleton instance of the ChargesController class can be accessed from the API Client.

IChargesController charges = client.Charges;

UpdateChargeMetadata

Updates the metadata from a charge

Task<Models.GetChargeResponse> UpdateChargeMetadata(string chargeId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	The charge id
request	Required	Request for updating the charge metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.UpdateChargeMetadata(chargeId, request, idempotencyKey);

CaptureCharge

Captures a charge

Task<Models.GetChargeResponse> CaptureCharge(string chargeId, Models.CreateCaptureChargeRequest request = null, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id
request	Optional	Request for capturing a charge
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.CreateCaptureChargeRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.CaptureCharge(chargeId, request, idempotencyKey);

UpdateChargePaymentMethod

Updates a charge's payment method

Task<Models.GetChargeResponse> UpdateChargePaymentMethod(string chargeId, Models.UpdateChargePaymentMethodRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id
request	Required	Request for updating the payment method from a charge
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.UpdateChargePaymentMethodRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.UpdateChargePaymentMethod(chargeId, request, idempotencyKey);

GetChargeTransactions

TODO: Add a method description

Task<Models.ListChargeTransactionsResponse> GetChargeTransactions(string chargeId, int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge Id
page	Optional	Page number
size	Optional	Page size

Example Usage

string chargeId = "charge_id";
int? page = 247;
int? size = 247;

Models.ListChargeTransactionsResponse result = await charges.GetChargeTransactions(chargeId, page, size);

UpdateChargeDueDate

Updates the due date from a charge

Task<Models.GetChargeResponse> UpdateChargeDueDate(string chargeId, Models.UpdateChargeDueDateRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge Id
request	Required	Request for updating the due date
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.UpdateChargeDueDateRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.UpdateChargeDueDate(chargeId, request, idempotencyKey);

GetCharges

Lists all charges

Task<Models.ListChargesResponse> GetCharges(
        int? page = null,
        int? size = null,
        string code = null,
        string status = null,
        string paymentMethod = null,
        string customerId = null,
        string orderId = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size
code	Optional	Filter for charge's code
status	Optional	Filter for charge's status
paymentMethod	Optional	Filter for charge's payment method
customerId	Optional	Filter for charge's customer id
orderId	Optional	Filter for charge's order id
createdSince	Optional	Filter for the beginning of the range for charge's creation
createdUntil	Optional	Filter for the end of the range for charge's creation

Example Usage

int? page = 247;
int? size = 247;
string code = "code";
string status = "status";
string paymentMethod = "payment_method";
string customerId = "customer_id";
string orderId = "order_id";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListChargesResponse result = await charges.GetCharges(page, size, code, status, paymentMethod, customerId, orderId, createdSince, createdUntil);

UpdateChargeCard

Updates the card from a charge

Task<Models.GetChargeResponse> UpdateChargeCard(string chargeId, Models.UpdateChargeCardRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id
request	Required	Request for updating a charge's card
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.UpdateChargeCardRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.UpdateChargeCard(chargeId, request, idempotencyKey);

GetCharge

Get a charge from its id

Task<Models.GetChargeResponse> GetCharge(string chargeId)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id

Example Usage

string chargeId = "charge_id";

Models.GetChargeResponse result = await charges.GetCharge(chargeId);

GetChargesSummary

TODO: Add a method description

Task<Models.GetChargesSummaryResponse> GetChargesSummary(string status, DateTime? createdSince = null, DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
status	Required	TODO: Add a parameter description
createdSince	Optional	TODO: Add a parameter description
createdUntil	Optional	TODO: Add a parameter description

Example Usage

string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.GetChargesSummaryResponse result = await charges.GetChargesSummary(status, createdSince, createdUntil);

RetryCharge

Retries a charge

Task<Models.GetChargeResponse> RetryCharge(string chargeId, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.RetryCharge(chargeId, idempotencyKey);

CancelCharge

Cancel a charge

Task<Models.GetChargeResponse> CancelCharge(string chargeId, Models.CreateCancelChargeRequest request = null, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	Charge id
request	Optional	Request for cancelling a charge
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.CreateCancelChargeRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.CancelCharge(chargeId, request, idempotencyKey);

CreateCharge

Creates a new charge

Task<Models.GetChargeResponse> CreateCharge(Models.CreateChargeRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	Required	Request for creating a charge
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var request = new Models.CreateChargeRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.CreateCharge(request, idempotencyKey);

ConfirmPayment

TODO: Add a method description

Task<Models.GetChargeResponse> ConfirmPayment(string chargeId, Models.CreateConfirmPaymentRequest request = null, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	Required	TODO: Add a parameter description
request	Optional	Request for confirm payment
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string chargeId = "charge_id";
var request = new Models.CreateConfirmPaymentRequest();
string idempotencyKey = "idempotency-key";

Models.GetChargeResponse result = await charges.ConfirmPayment(chargeId, request, idempotencyKey);

Back to List of Controllers

TransfersController

Get singleton instance

The singleton instance of the TransfersController class can be accessed from the API Client.

ITransfersController transfers = client.Transfers;

GetTransferById

TODO: Add a method description

Task<Models.GetTransfer> GetTransferById(string transferId)

Parameters

Parameter	Tags	Description
transferId	Required	TODO: Add a parameter description

Example Usage

string transferId = "transfer_id";

Models.GetTransfer result = await transfers.GetTransferById(transferId);

CreateTransfer

TODO: Add a method description

Task<Models.GetTransfer> CreateTransfer(Models.CreateTransfer request)

Parameters

Parameter	Tags	Description
request	Required	TODO: Add a parameter description

Example Usage

var request = new Models.CreateTransfer();

Models.GetTransfer result = await transfers.CreateTransfer(request);

GetTransfers

Gets all transfers

Task<Models.ListTransfers> GetTransfers()

Example Usage

Models.ListTransfers result = await transfers.GetTransfers();

Back to List of Controllers

RecipientsController

Get singleton instance

The singleton instance of the RecipientsController class can be accessed from the API Client.

IRecipientsController recipients = client.Recipients;

GetTransfer

Gets a transfer

Task<Models.GetTransferResponse> GetTransfer(string recipientId, string transferId)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
transferId	Required	Transfer id

Example Usage

string recipientId = "recipient_id";
string transferId = "transfer_id";

Models.GetTransferResponse result = await recipients.GetTransfer(recipientId, transferId);

UpdateRecipient

Updates a recipient

Task<Models.GetRecipientResponse> UpdateRecipient(string recipientId, Models.UpdateRecipientRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
request	Required	Recipient data
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.UpdateRecipientRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.UpdateRecipient(recipientId, request, idempotencyKey);

CreateAnticipation

Creates an anticipation

Task<Models.GetAnticipationResponse> CreateAnticipation(string recipientId, Models.CreateAnticipationRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
request	Required	Anticipation data
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.CreateAnticipationRequest();
string idempotencyKey = "idempotency-key";

Models.GetAnticipationResponse result = await recipients.CreateAnticipation(recipientId, request, idempotencyKey);

GetAnticipationLimits

Gets the anticipation limits for a recipient

Task<Models.GetAnticipationLimitResponse> GetAnticipationLimits(string recipientId, string timeframe, DateTime paymentDate)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
timeframe	Required	Timeframe
paymentDate	Required	Anticipation payment date

Example Usage

string recipientId = "recipient_id";
string timeframe = "timeframe";
DateTime paymentDate = DateTime.Now();

Models.GetAnticipationLimitResponse result = await recipients.GetAnticipationLimits(recipientId, timeframe, paymentDate);

GetRecipients

Retrieves paginated recipients information

Task<Models.ListRecipientResponse> GetRecipients(int? page = null, int? size = null)

Parameters

Parameter	Tags	Description
page	Optional	Page number
size	Optional	Page size

Example Usage

int? page = 247;
int? size = 247;

Models.ListRecipientResponse result = await recipients.GetRecipients(page, size);

GetWithdrawById

TODO: Add a method description

Task<Models.GetWithdrawResponse> GetWithdrawById(string recipientId, string withdrawalId)

Parameters

Parameter	Tags	Description
recipientId	Required	TODO: Add a parameter description
withdrawalId	Required	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
string withdrawalId = "withdrawal_id";

Models.GetWithdrawResponse result = await recipients.GetWithdrawById(recipientId, withdrawalId);

UpdateRecipientDefaultBankAccount

Updates the default bank account from a recipient

Task<Models.GetRecipientResponse> UpdateRecipientDefaultBankAccount(string recipientId, Models.UpdateRecipientBankAccountRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
request	Required	Bank account data
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.UpdateRecipientBankAccountRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.UpdateRecipientDefaultBankAccount(recipientId, request, idempotencyKey);

UpdateRecipientMetadata

Updates recipient metadata

Task<Models.GetRecipientResponse> UpdateRecipientMetadata(string recipientId, Models.UpdateMetadataRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
request	Required	Metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.UpdateMetadataRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.UpdateRecipientMetadata(recipientId, request, idempotencyKey);

GetTransfers

Gets a paginated list of transfers for the recipient

Task<Models.ListTransferResponse> GetTransfers(
        string recipientId,
        int? page = null,
        int? size = null,
        string status = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
page	Optional	Page number
size	Optional	Page size
status	Optional	Filter for transfer status
createdSince	Optional	Filter for start range of transfer creation date
createdUntil	Optional	Filter for end range of transfer creation date

Example Usage

string recipientId = "recipient_id";
int? page = 247;
int? size = 247;
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListTransferResponse result = await recipients.GetTransfers(recipientId, page, size, status, createdSince, createdUntil);

CreateWithdraw

TODO: Add a method description

Task<Models.GetWithdrawResponse> CreateWithdraw(string recipientId, Models.CreateWithdrawRequest request)

Parameters

Parameter	Tags	Description
recipientId	Required	TODO: Add a parameter description
request	Required	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.CreateWithdrawRequest();

Models.GetWithdrawResponse result = await recipients.CreateWithdraw(recipientId, request);

UpdateAutomaticAnticipationSettings

Updates recipient metadata

Task<Models.GetRecipientResponse> UpdateAutomaticAnticipationSettings(string recipientId, Models.UpdateAutomaticAnticipationSettingsRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
request	Required	Metadata
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.UpdateAutomaticAnticipationSettingsRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.UpdateAutomaticAnticipationSettings(recipientId, request, idempotencyKey);

GetAnticipation

Gets an anticipation

Task<Models.GetAnticipationResponse> GetAnticipation(string recipientId, string anticipationId)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
anticipationId	Required	Anticipation id

Example Usage

string recipientId = "recipient_id";
string anticipationId = "anticipation_id";

Models.GetAnticipationResponse result = await recipients.GetAnticipation(recipientId, anticipationId);

UpdateRecipientTransferSettings

TODO: Add a method description

Task<Models.GetRecipientResponse> UpdateRecipientTransferSettings(string recipientId, Models.UpdateTransferSettingsRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient Identificator
request	Required	TODO: Add a parameter description
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.UpdateTransferSettingsRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.UpdateRecipientTransferSettings(recipientId, request, idempotencyKey);

GetAnticipations

Retrieves a paginated list of anticipations from a recipient

Task<Models.ListAnticipationResponse> GetAnticipations(
        string recipientId,
        int? page = null,
        int? size = null,
        string status = null,
        string timeframe = null,
        DateTime? paymentDateSince = null,
        DateTime? paymentDateUntil = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id
page	Optional	Page number
size	Optional	Page size
status	Optional	Filter for anticipation status
timeframe	Optional	Filter for anticipation timeframe
paymentDateSince	Optional	Filter for start range for anticipation payment date
paymentDateUntil	Optional	Filter for end range for anticipation payment date
createdSince	Optional	Filter for start range for anticipation creation date
createdUntil	Optional	Filter for end range for anticipation creation date

Example Usage

string recipientId = "recipient_id";
int? page = 247;
int? size = 247;
string status = "status";
string timeframe = "timeframe";
DateTime? paymentDateSince = DateTime.Now();
DateTime? paymentDateUntil = DateTime.Now();
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListAnticipationResponse result = await recipients.GetAnticipations(recipientId, page, size, status, timeframe, paymentDateSince, paymentDateUntil, createdSince, createdUntil);

GetRecipient

Retrieves recipient information

Task<Models.GetRecipientResponse> GetRecipient(string recipientId)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipiend id

Example Usage

string recipientId = "recipient_id";

Models.GetRecipientResponse result = await recipients.GetRecipient(recipientId);

GetWithdrawals

Gets a paginated list of transfers for the recipient

Task<Models.ListWithdrawals> GetWithdrawals(
        string recipientId,
        int? page = null,
        int? size = null,
        string status = null,
        DateTime? createdSince = null,
        DateTime? createdUntil = null)

Parameters

Parameter	Tags	Description
recipientId	Required	TODO: Add a parameter description
page	Optional	TODO: Add a parameter description
size	Optional	TODO: Add a parameter description
status	Optional	TODO: Add a parameter description
createdSince	Optional	TODO: Add a parameter description
createdUntil	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
int? page = 247;
int? size = 247;
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

Models.ListWithdrawals result = await recipients.GetWithdrawals(recipientId, page, size, status, createdSince, createdUntil);

GetBalance

Get balance information for a recipient

Task<Models.GetBalanceResponse> GetBalance(string recipientId)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient id

Example Usage

string recipientId = "recipient_id";

Models.GetBalanceResponse result = await recipients.GetBalance(recipientId);

CreateTransfer

Creates a transfer for a recipient

Task<Models.GetTransferResponse> CreateTransfer(string recipientId, Models.CreateTransferRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
recipientId	Required	Recipient Id
request	Required	Transfer data
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string recipientId = "recipient_id";
var request = new Models.CreateTransferRequest();
string idempotencyKey = "idempotency-key";

Models.GetTransferResponse result = await recipients.CreateTransfer(recipientId, request, idempotencyKey);

CreateRecipient

Creates a new recipient

Task<Models.GetRecipientResponse> CreateRecipient(Models.CreateRecipientRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	Required	Recipient data
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

var request = new Models.CreateRecipientRequest();
string idempotencyKey = "idempotency-key";

Models.GetRecipientResponse result = await recipients.CreateRecipient(request, idempotencyKey);

GetRecipientByCode

Retrieves recipient information

Task<Models.GetRecipientResponse> GetRecipientByCode(string code)

Parameters

Parameter	Tags	Description
code	Required	Recipient code

Example Usage

string code = "code";

Models.GetRecipientResponse result = await recipients.GetRecipientByCode(code);

GetDefaultRecipient

TODO: Add a method description

Task<Models.GetRecipientResponse> GetDefaultRecipient()

Example Usage

Models.GetRecipientResponse result = await recipients.GetDefaultRecipient();

Back to List of Controllers

TokensController

Get singleton instance

The singleton instance of the TokensController class can be accessed from the API Client.

ITokensController tokens = client.Tokens;

CreateToken

Tags: Skips Authentication

TODO: Add a method description

Task<Models.GetTokenResponse> CreateToken(string publicKey, Models.CreateTokenRequest request, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
publicKey	Required	Public key
request	Required	Request for creating a token
idempotencyKey	Optional	TODO: Add a parameter description

Example Usage

string publicKey = "public_key";
var request = new Models.CreateTokenRequest();
string idempotencyKey = "idempotency-key";

Models.GetTokenResponse result = await tokens.CreateToken(publicKey, request, idempotencyKey);

GetToken

Tags: Skips Authentication

Gets a token from its id

Task<Models.GetTokenResponse> GetToken(string id, string publicKey)

Parameters

Parameter	Tags	Description
id	Required	Token id
publicKey	Required	Public key

Example Usage

string id = "id";
string publicKey = "public_key";

Models.GetTokenResponse result = await tokens.GetToken(id, publicKey);

Back to List of Controllers

TransactionsController

Get singleton instance

The singleton instance of the TransactionsController class can be accessed from the API Client.

ITransactionsController transactions = client.Transactions;

GetTransaction

TODO: Add a method description

Task<Models.GetTransactionResponse> GetTransaction(string transactionId)

Parameters

Parameter	Tags	Description
transactionId	Required	TODO: Add a parameter description

Example Usage

string transactionId = "transaction_id";

Models.GetTransactionResponse result = await transactions.GetTransaction(transactionId);

Back to List of Controllers