Getting started

Mundipagg 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.

Open the solution (MundiAPI.sln) file.
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 MundiAPI 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 MundiAPI 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 MundiAPI.Tests and click OK. By doing this, we have added a reference of the MundiAPI.Tests 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
serviceRefererName	TODO: add a 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 serviceRefererName = "serviceRefererName";
string basicAuthUserName = "basicAuthUserName"; // The username to use with basic authentication
string basicAuthPassword = "basicAuthPassword"; // The password to use with basic authentication

MundiAPIClient client = new MundiAPIClient(serviceRefererName, basicAuthUserName, basicAuthPassword);

Class Reference

SubscriptionsController

Get singleton instance

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

SubscriptionsController subscriptions = client.Subscriptions;

CreateDiscount

Creates a discount

Task<PCL.Models.SubscriptionsDiscountsResponse> CreateDiscount(string subscriptionId, PCL.Models.SubscriptionsDiscountsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsDiscountsRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.SubscriptionsDiscountsResponse result = await subscriptions.CreateDiscount(subscriptionId, body, idempotencyKey);

Errors

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

GetSubscriptionItem

Get Subscription Item

Task<PCL.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";

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

Errors

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

UpdateSubscriptionItem

Updates a subscription item

Task<PCL.Models.GetSubscriptionItemResponse> UpdateSubscriptionItem(
        string subscriptionId,
        string itemId,
        PCL.Models.SubscriptionsItemsRequest 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 PCL.Models.SubscriptionsItemsRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

DeleteUsage

Deletes a usage

Task<PCL.Models.SubscriptionsItemsUsagesUsageIdResponse> 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";

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

Errors

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

CancelSubscription

Cancels a subscription

Task<PCL.Models.GetSubscriptionResponse> CancelSubscription(string subscriptionId, string idempotencyKey = null, PCL.Models.SubscriptionsRequest body = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
string idempotencyKey = "idempotency-key";
var body = new PCL.Models.SubscriptionsRequest();

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

Errors

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

GetSubscription

Gets a subscription

Task<PCL.Models.GetSubscriptionResponse> GetSubscription(string subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id

Example Usage

string subscriptionId = "subscription_id";

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

Errors

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

DeleteIncrement

Deletes a increment

Task<PCL.Models.SubscriptionsIncrementsResponse> 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";

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

Errors

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

GetIncrementById

GetIncrementById

Task<PCL.Models.SubscriptionsIncrementsResponse> 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";

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

Errors

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

GetSubscriptionCycleById

GetSubscriptionCycleById

Task<PCL.Models.SubscriptionsCyclesResponse> 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";

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

Errors

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

UpdateSubscriptionStartAt

Updates the start at date from a subscription

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionStartAt(string subscriptionId, PCL.Models.SubscriptionsStartAtRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsStartAtRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateSubscriptionPaymentMethod

Updates the payment method from a subscription

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionPaymentMethod(string subscriptionId, PCL.Models.SubscriptionsPaymentMethodRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsPaymentMethodRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateCurrentCycleStatus

UpdateCurrentCycleStatus

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
body	`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 body = new PCL.Models.UpdateCurrentCycleStatusRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

CreateSubscription

Creates a new subscription

Task<PCL.Models.GetSubscriptionResponse> CreateSubscription(PCL.Models.SubscriptionsRequest1 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 PCL.Models.SubscriptionsRequest1();
string idempotencyKey = "idempotency-key";

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

Errors

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

GetSubscriptions

Gets all subscriptions

Task<PCL.Models.SubscriptionsResponse3> 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 = 73;
int? size = 73;
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();

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

Errors

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

GetUsagesDetails

GetUsagesDetails

Task<PCL.Models.GetUsagesDetailsResponse> GetUsagesDetails(
        string subscriptionId,
        string cycleId = null,
        int? size = null,
        int? page = null,
        string itemId = null,
        string mgroup = null)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Identifier
cycleId	`Optional`	Cycle id
size	`Optional`	Page size
page	`Optional`	Page number
itemId	`Optional`	Identificador do item
mgroup	`Optional`	identificador da loja (account) de cada item

Example Usage

string subscriptionId = "subscription_id";
string cycleId = "cycle_id";
int? size = 73;
int? page = 73;
string itemId = "item_id";
string mgroup = "group";

PCL.Models.GetUsagesDetailsResponse result = await subscriptions.GetUsagesDetails(subscriptionId, cycleId, size, page, itemId, mgroup);

Errors

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

RenewSubscription

RenewSubscription

Task<PCL.Models.SubscriptionsCyclesResponse> 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";

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

Errors

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

GetSubscriptionCycles

GetSubscriptionCycles

Task<PCL.Models.SubscriptionsCyclesResponse2> 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";

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

Errors

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

CreateAnUsage

Create Usage

Task<PCL.Models.SubscriptionsItemsUsagesResponse> 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";

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

Errors

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

GetUsages

Lists all usages from a subscription item

Task<PCL.Models.SubscriptionsItemsUsagesResponse1> 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 = 73;
int? size = 73;
string code = "code";
string mgroup = "group";
DateTime? usedSince = DateTime.Now();
DateTime? usedUntil = DateTime.Now();

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

Errors

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

DeleteDiscount

Deletes a discount

Task<PCL.Models.SubscriptionsDiscountsResponse> 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";

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

Errors

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

GetIncrements

GetIncrements

Task<PCL.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 = 73;
int? size = 73;

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

Errors

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

CreateSubscriptionItem

Creates a new Subscription item

Task<PCL.Models.GetSubscriptionItemResponse> CreateSubscriptionItem(string subscriptionId, PCL.Models.SubscriptionsItemsRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsItemsRequest1();
string idempotencyKey = "idempotency-key";

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

Errors

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

GetSubscriptionItems

Get Subscription Items

Task<PCL.Models.SubscriptionsItemsResponse3> 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 = 73;
int? size = 73;
string name = "name";
string code = "code";
string status = "status";
string description = "description";
string createdSince = "created_since";
string createdUntil = "created_until";

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

Errors

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

UpdateSubscriptionBillingDate

Updates the billing date from a subscription

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionBillingDate(string subscriptionId, PCL.Models.SubscriptionsBillingDateRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsBillingDateRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateLatestPeriodEndAt

UpdateLatestPeriodEndAt

Task<PCL.Models.GetSubscriptionResponse> UpdateLatestPeriodEndAt(string subscriptionId, PCL.Models.SubscriptionsPeriodsLatestEndAtRequest body, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	TODO: Add a parameter description
body	`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 body = new PCL.Models.SubscriptionsPeriodsLatestEndAtRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateSubscriptionAffiliationId

UpdateSubscriptionAffiliationId

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionAffiliationId(string subscriptionId, PCL.Models.SubscriptionsGatewayAffiliationIdRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsGatewayAffiliationIdRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

DeleteSubscriptionItem

Deletes a subscription item

Task<PCL.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";

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

Errors

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

UpdateSubscriptionCard

Updates the credit card from a subscription

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionCard(string subscriptionId, PCL.Models.SubscriptionsCardRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsCardRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateSubscriptionMetadata

Updates the metadata from a subscription

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionMetadata(string subscriptionId, PCL.Models.SubscriptionsMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsMetadataRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

UpdateSubscriptionDueDays

Updates the boleto due days from a subscription

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

Parameters

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

Example Usage

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

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

Errors

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

GetDiscounts

GetDiscounts

Task<PCL.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 = 73;
int size = 73;

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

Errors

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

CreateIncrement

Creates a increment

Task<PCL.Models.SubscriptionsIncrementsResponse> CreateIncrement(string subscriptionId, PCL.Models.SubscriptionsIncrementsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
var body = new PCL.Models.SubscriptionsIncrementsRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.SubscriptionsIncrementsResponse result = await subscriptions.CreateIncrement(subscriptionId, body, idempotencyKey);

Errors

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

GetDiscountById

GetDiscountById

Task<PCL.Models.SubscriptionsDiscountsResponse> 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";

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

Errors

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

UpdateSubscriptionMiniumPrice

Atualização do valor mínimo da assinatura

Task<PCL.Models.GetSubscriptionResponse> UpdateSubscriptionMiniumPrice(string subscriptionId, PCL.Models.SubscriptionsMinimumPriceRequest body, string idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
body	`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 body = new PCL.Models.SubscriptionsMinimumPriceRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

GetUsageReport

GetUsageReport

Task<PCL.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";

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

Errors

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

UpdateSplitSubscription

UpdateSplitSubscription

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

Parameters

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

Example Usage

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

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

Errors

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

Back to List of Controllers

OrdersController

Get singleton instance

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

OrdersController orders = client.Orders;

UpdateOrderStatus

UpdateOrderStatus

Task<PCL.Models.OrdersClosedResponse> UpdateOrderStatus(string id, PCL.Models.UpdateOrderStatusRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.OrdersClosedResponse result = await orders.UpdateOrderStatus(id, body, idempotencyKey);

Errors

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

DeleteAllOrderItems

DeleteAllOrderItems

Task<PCL.Models.OrdersItemsResponse> 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";

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

Errors

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

CreateOrderItem

CreateOrderItem

Task<PCL.Models.OrdersItemsResponse1> CreateOrderItem(string orderId, PCL.Models.OrdersItemsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string orderId = "orderId";
var body = new PCL.Models.OrdersItemsRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.OrdersItemsResponse1 result = await orders.CreateOrderItem(orderId, body, idempotencyKey);

Errors

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

UpdateOrderMetadata

Updates the metadata from an order

Task<PCL.Models.OrdersMetadataResponse> UpdateOrderMetadata(string orderId, PCL.Models.OrdersMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string orderId = "order_id";
var body = new PCL.Models.OrdersMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.OrdersMetadataResponse result = await orders.UpdateOrderMetadata(orderId, body, idempotencyKey);

Errors

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

GetOrders

Gets all orders

Task<PCL.Models.OrdersResponse> 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 = 73;
int? size = 73;
string code = "code";
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();
string customerId = "customer_id";

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

Errors

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

CreateOrder

Creates a new Order

Task<PCL.Models.OrdersResponse1> CreateOrder(PCL.Models.OrdersRequest 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 PCL.Models.OrdersRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

DeleteOrderItem

DeleteOrderItem

Task<PCL.Models.OrdersItemsResponse1> 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";

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

Errors

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

GetOrderItem

GetOrderItem

Task<PCL.Models.OrdersItemsResponse1> 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";

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

Errors

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

UpdateOrderItem

UpdateOrderItem

Task<PCL.Models.OrdersItemsResponse1> UpdateOrderItem(
        string orderId,
        string itemId,
        PCL.Models.OrdersItemsRequest1 body,
        string idempotencyKey = null)

Parameters

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

Example Usage

string orderId = "orderId";
string itemId = "itemId";
var body = new PCL.Models.OrdersItemsRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.OrdersItemsResponse1 result = await orders.UpdateOrderItem(orderId, itemId, body, idempotencyKey);

Errors

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

GetOrder

Gets an order

Task<PCL.Models.OrdersResponse1> GetOrder(string orderId)

Parameters

Parameter	Tags	Description
orderId	`Required`	Order id

Example Usage

string orderId = "order_id";

PCL.Models.OrdersResponse1 result = await orders.GetOrder(orderId);

Errors

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

Back to List of Controllers

PlansController

Get singleton instance

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

PlansController plans = client.Plans;

UpdatePlanItem

Updates a plan item

Task<PCL.Models.PlansItemsResponse> UpdatePlanItem(
        string planId,
        string planItemId,
        PCL.Models.PlansItemsRequest 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 PCL.Models.PlansItemsRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

DeletePlanItem

Removes an item from a plan

Task<PCL.Models.PlansItemsResponse> 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";

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

Errors

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

GetPlanItem

Gets a plan item

Task<PCL.Models.PlansItemsResponse> 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";

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

Errors

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

CreatePlanItem

Adds a new item to a plan

Task<PCL.Models.PlansItemsResponse> CreatePlanItem(string planId, PCL.Models.PlansItemsRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

string planId = "plan_id";
var body = new PCL.Models.PlansItemsRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.PlansItemsResponse result = await plans.CreatePlanItem(planId, body, idempotencyKey);

Errors

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

GetPlans

Gets all plans

Task<PCL.Models.PlansResponse> 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 = 31;
int? size = 31;
string name = "name";
string status = "status";
string billingType = "billing_type";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

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

Errors

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

CreatePlan

Creates a new plan

Task<PCL.Models.PlansResponse1> CreatePlan(PCL.Models.PlansRequest 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 PCL.Models.PlansRequest();
string idempotencyKey = "idempotency-key";

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

Errors

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

GetPlan

Gets a plan

Task<PCL.Models.PlansResponse1> GetPlan(string planId)

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id

Example Usage

string planId = "plan_id";

PCL.Models.PlansResponse1 result = await plans.GetPlan(planId);

Errors

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

UpdatePlan

Updates a plan

Task<PCL.Models.PlansResponse1> UpdatePlan(string planId, PCL.Models.PlansRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

string planId = "plan_id";
var body = new PCL.Models.PlansRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.PlansResponse1 result = await plans.UpdatePlan(planId, body, idempotencyKey);

Errors

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

DeletePlan

Deletes a plan

Task<PCL.Models.PlansResponse1> 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";

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

Errors

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

UpdatePlanMetadata

Updates the metadata from a plan

Task<PCL.Models.PlansMetadataResponse> UpdatePlanMetadata(string planId, PCL.Models.PlansMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string planId = "plan_id";
var body = new PCL.Models.PlansMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.PlansMetadataResponse result = await plans.UpdatePlanMetadata(planId, body, idempotencyKey);

Errors

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

Back to List of Controllers

InvoicesController

Get singleton instance

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

InvoicesController invoices = client.Invoices;

CreateInvoice

Create an Invoice

Task<PCL.Models.SubscriptionsCyclesPayResponse> CreateInvoice(
        string subscriptionId,
        string cycleId,
        string idempotencyKey = null,
        PCL.Models.SubscriptionsCyclesPayRequest body = null)

Parameters

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

Example Usage

string subscriptionId = "subscription_id";
string cycleId = "cycle_id";
string idempotencyKey = "idempotency-key";
var body = new PCL.Models.SubscriptionsCyclesPayRequest();

PCL.Models.SubscriptionsCyclesPayResponse result = await invoices.CreateInvoice(subscriptionId, cycleId, idempotencyKey, body);

Errors

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

GetPartialInvoice

GetPartialInvoice

Task<PCL.Models.SubscriptionsPartialInvoiceResponse> GetPartialInvoice(string subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id

Example Usage

string subscriptionId = "subscription_id";

PCL.Models.SubscriptionsPartialInvoiceResponse result = await invoices.GetPartialInvoice(subscriptionId);

Errors

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

UpdateInvoiceStatus

Updates the status from an invoice

Task<PCL.Models.InvoicesStatusResponse> UpdateInvoiceStatus(string invoiceId, PCL.Models.UpdateCurrentCycleStatusRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string invoiceId = "invoice_id";
var body = new PCL.Models.UpdateCurrentCycleStatusRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.InvoicesStatusResponse result = await invoices.UpdateInvoiceStatus(invoiceId, body, idempotencyKey);

Errors

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

GetInvoice

Gets an invoice

Task<PCL.Models.InvoicesResponse> GetInvoice(string invoiceId)

Parameters

Parameter	Tags	Description
invoiceId	`Required`	Invoice Id

Example Usage

string invoiceId = "invoice_id";

PCL.Models.InvoicesResponse result = await invoices.GetInvoice(invoiceId);

Errors

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

CancelInvoice

Cancels an invoice

Task<PCL.Models.InvoicesResponse> 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";

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

Errors

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

UpdateInvoiceMetadata

Updates the metadata from an invoice

Task<PCL.Models.InvoicesMetadataResponse> UpdateInvoiceMetadata(string invoiceId, PCL.Models.InvoicesMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string invoiceId = "invoice_id";
var body = new PCL.Models.InvoicesMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.InvoicesMetadataResponse result = await invoices.UpdateInvoiceMetadata(invoiceId, body, idempotencyKey);

Errors

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

GetInvoices

Gets all invoices

Task<PCL.Models.InvoicesResponse2> 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`	Fillter for invoice's document

Example Usage

int? page = 31;
int? size = 31;
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";

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

Errors

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

Back to List of Controllers

CustomersController

Get singleton instance

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

CustomersController customers = client.Customers;

CreateAccessToken

Creates a access token for a customer

Task<PCL.Models.CustomersAccessTokensResponse> CreateAccessToken(string customerId, PCL.Models.CustomersAccessTokensRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
var body = new PCL.Models.CustomersAccessTokensRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersAccessTokensResponse result = await customers.CreateAccessToken(customerId, body, idempotencyKey);

Errors

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

GetAccessTokens

Get all access tokens from a customer

Task<PCL.Models.CustomersAccessTokensResponse1> 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 = 31;
int? size = 31;

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

Errors

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

UpdateCustomer

Updates a customer

Task<PCL.Models.CustomersResponse> UpdateCustomer(string customerId, PCL.Models.CustomersRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
var body = new PCL.Models.CustomersRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersResponse result = await customers.UpdateCustomer(customerId, body, idempotencyKey);

Errors

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

GetCustomer

Get a customer

Task<PCL.Models.CustomersResponse> GetCustomer(string customerId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id

Example Usage

string customerId = "customer_id";

PCL.Models.CustomersResponse result = await customers.GetCustomer(customerId);

Errors

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

DeleteAccessTokens

Delete a Customer's access tokens

Task<PCL.Models.CustomersAccessTokensResponse1> DeleteAccessTokens(string customerId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id

Example Usage

string customerId = "customer_id";

PCL.Models.CustomersAccessTokensResponse1 result = await customers.DeleteAccessTokens(customerId);

Errors

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

GetAddresses

Gets all adressess from a customer

Task<PCL.Models.CustomersAddressesResponse> 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 = 31;
int? size = 31;

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

Errors

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

CreateAddress

Creates a new address for a customer

Task<PCL.Models.CustomersAddressesResponse1> CreateAddress(string customerId, PCL.Models.CustomersAddressesRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
var body = new PCL.Models.CustomersAddressesRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersAddressesResponse1 result = await customers.CreateAddress(customerId, body, idempotencyKey);

Errors

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

GetAccessToken

Get a Customer's access token

Task<PCL.Models.CustomersAccessTokensResponse> 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";

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

Errors

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

DeleteAccessToken

Delete a customer's access token

Task<PCL.Models.CustomersAccessTokensResponse> 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";

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

Errors

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

GetAddress

Get a customer's address

Task<PCL.Models.CustomersAddressesResponse1> 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";

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

Errors

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

UpdateAddress

Updates an address

Task<PCL.Models.CustomersAddressesResponse1> UpdateAddress(
        string customerId,
        string addressId,
        PCL.Models.CustomersAddressesRequest1 body,
        string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
string addressId = "address_id";
var body = new PCL.Models.CustomersAddressesRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersAddressesResponse1 result = await customers.UpdateAddress(customerId, addressId, body, idempotencyKey);

Errors

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

DeleteAddress

Delete a Customer's address

Task<PCL.Models.CustomersAddressesResponse1> 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";

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

Errors

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

CreateCard

Creates a new card for a customer

Task<PCL.Models.CustomersCardsResponse> CreateCard(string customerId, PCL.Models.CustomersCardsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
var body = new PCL.Models.CustomersCardsRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersCardsResponse result = await customers.CreateCard(customerId, body, idempotencyKey);

Errors

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

GetCards

Get all cards from a customer

Task<PCL.Models.CustomersCardsResponse1> 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 = 31;
int? size = 31;

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

Errors

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

RenewCard

Renew a card

Task<PCL.Models.CustomersCardsRenewResponse> 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";

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

Errors

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

CreateCustomer

Creates a new customer

Task<PCL.Models.CustomersResponse> CreateCustomer(PCL.Models.CustomersRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.CustomersResponse result = await customers.CreateCustomer(body, idempotencyKey);

Errors

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

GetCustomers

Get all Customers

Task<PCL.Models.CustomersResponse3> 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";

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

Errors

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

UpdateCustomerMetadata

Updates the metadata a customer

Task<PCL.Models.CustomersMetadataResponse> UpdateCustomerMetadata(string customerId, PCL.Models.CustomersMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
var body = new PCL.Models.CustomersMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersMetadataResponse result = await customers.UpdateCustomerMetadata(customerId, body, idempotencyKey);

Errors

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

UpdateCard

Updates a card

Task<PCL.Models.CustomersCardsResponse> UpdateCard(
        string customerId,
        string cardId,
        PCL.Models.CustomersCardsRequest1 body,
        string idempotencyKey = null)

Parameters

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

Example Usage

string customerId = "customer_id";
string cardId = "card_id";
var body = new PCL.Models.CustomersCardsRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.CustomersCardsResponse result = await customers.UpdateCard(customerId, cardId, body, idempotencyKey);

Errors

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

DeleteCard

Delete a customer's card

Task<PCL.Models.CustomersCardsResponse> 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";

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

Errors

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

GetCard

Get a customer's card

Task<PCL.Models.CustomersCardsResponse> 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";

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

Errors

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

Back to List of Controllers

ChargesController

Get singleton instance

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

ChargesController charges = client.Charges;

GetCharge

Get a charge from its id

Task<PCL.Models.ChargesResponse> GetCharge(string chargeId)

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id

Example Usage

string chargeId = "charge_id";

PCL.Models.ChargesResponse result = await charges.GetCharge(chargeId);

Errors

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

CancelCharge

Cancel a charge

Task<PCL.Models.ChargesResponse> CancelCharge(string chargeId, string idempotencyKey = null, PCL.Models.ChargesRequest body = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
string idempotencyKey = "idempotency-key";
var body = new PCL.Models.ChargesRequest();

PCL.Models.ChargesResponse result = await charges.CancelCharge(chargeId, idempotencyKey, body);

Errors

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

ConfirmPayment

ConfirmPayment

Task<PCL.Models.ChargesConfirmPaymentResponse> ConfirmPayment(string chargeId, string idempotencyKey = null, PCL.Models.CreateConfirmPaymentRequest body = null)

Parameters

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

Example Usage

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

PCL.Models.ChargesConfirmPaymentResponse result = await charges.ConfirmPayment(chargeId, idempotencyKey, body);

Errors

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

UpdateChargeCard

Updates the card from a charge

Task<PCL.Models.ChargesCardResponse> UpdateChargeCard(string chargeId, PCL.Models.ChargesCardRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
var body = new PCL.Models.ChargesCardRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.ChargesCardResponse result = await charges.UpdateChargeCard(chargeId, body, idempotencyKey);

Errors

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

GetCharges

Lists all charges

Task<PCL.Models.ChargesResponse2> 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 = 122;
int? size = 122;
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();

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

Errors

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

RetryCharge

Retries a charge

Task<PCL.Models.ChargesRetryResponse> 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";

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

Errors

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

UpdateChargePaymentMethod

Updates a charge's payment method

Task<PCL.Models.ChargesPaymentMethodResponse> UpdateChargePaymentMethod(string chargeId, PCL.Models.ChargesPaymentMethodRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
var body = new PCL.Models.ChargesPaymentMethodRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.ChargesPaymentMethodResponse result = await charges.UpdateChargePaymentMethod(chargeId, body, idempotencyKey);

Errors

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

UpdateChargeMetadata

Updates the metadata from a charge

Task<PCL.Models.ChargesMetadataResponse> UpdateChargeMetadata(string chargeId, PCL.Models.ChargesMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
var body = new PCL.Models.ChargesMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.ChargesMetadataResponse result = await charges.UpdateChargeMetadata(chargeId, body, idempotencyKey);

Errors

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

CaptureCharge

Captures a charge

Task<PCL.Models.ChargesCaptureResponse> CaptureCharge(string chargeId, string idempotencyKey = null, PCL.Models.ChargesCaptureRequest body = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
string idempotencyKey = "idempotency-key";
var body = new PCL.Models.ChargesCaptureRequest();

PCL.Models.ChargesCaptureResponse result = await charges.CaptureCharge(chargeId, idempotencyKey, body);

Errors

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

UpdateChargeDueDate

Updates the due date from a charge

Task<PCL.Models.ChargesDueDateResponse> UpdateChargeDueDate(string chargeId, PCL.Models.ChargesDueDateRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string chargeId = "charge_id";
var body = new PCL.Models.ChargesDueDateRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.ChargesDueDateResponse result = await charges.UpdateChargeDueDate(chargeId, body, idempotencyKey);

Errors

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

CreateCharge

Creates a new charge

Task<PCL.Models.ChargesResponse> CreateCharge(PCL.Models.ChargesRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.ChargesResponse result = await charges.CreateCharge(body, idempotencyKey);

Errors

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

GetChargeTransactions

GetChargeTransactions

Task<PCL.Models.ChargesTransactionsResponse> 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 = 122;
int? size = 122;

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

Errors

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

GetChargesSummary

GetChargesSummary

Task<PCL.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();

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

Errors

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

Back to List of Controllers

RecipientsController

Get singleton instance

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

RecipientsController recipients = client.Recipients;

UpdateRecipientMetadata

Updates recipient metadata

Task<PCL.Models.RecipientsMetadataResponse> UpdateRecipientMetadata(string recipientId, PCL.Models.RecipientsMetadataRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string recipientId = "recipient_id";
var body = new PCL.Models.RecipientsMetadataRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.RecipientsMetadataResponse result = await recipients.UpdateRecipientMetadata(recipientId, body, idempotencyKey);

Errors

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

UpdateRecipientTransferSettings

UpdateRecipientTransferSettings

Task<PCL.Models.RecipientsTransferSettingsResponse> UpdateRecipientTransferSettings(string recipientId, PCL.Models.UpdateTransferSettingsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.RecipientsTransferSettingsResponse result = await recipients.UpdateRecipientTransferSettings(recipientId, body, idempotencyKey);

Errors

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

GetAnticipation

Gets an anticipation

Task<PCL.Models.RecipientsAnticipationsResponse> 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";

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

Errors

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

GetRecipients

Retrieves paginated recipients information

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

int? page = 122;
int? size = 122;

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

Errors

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

CreateRecipient

Creates a new recipient

Task<PCL.Models.RecipientsResponse1> CreateRecipient(PCL.Models.RecipientsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.RecipientsResponse1 result = await recipients.CreateRecipient(body, idempotencyKey);

Errors

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

GetBalance

Get balance information for a recipient

Task<PCL.Models.RecipientsBalanceResponse> GetBalance(string recipientId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id

Example Usage

string recipientId = "recipient_id";

PCL.Models.RecipientsBalanceResponse result = await recipients.GetBalance(recipientId);

Errors

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

GetAnticipations

Retrieves a paginated list of anticipations from a recipient

Task<PCL.Models.RecipientsAnticipationsResponse1> 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 = 122;
int? size = 122;
string status = "status";
string timeframe = "timeframe";
DateTime? paymentDateSince = DateTime.Now();
DateTime? paymentDateUntil = DateTime.Now();
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

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

Errors

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

CreateAnticipation

Creates an anticipation

Task<PCL.Models.RecipientsAnticipationsResponse> CreateAnticipation(string recipientId, PCL.Models.RecipientsAnticipationsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string recipientId = "recipient_id";
var body = new PCL.Models.RecipientsAnticipationsRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.RecipientsAnticipationsResponse result = await recipients.CreateAnticipation(recipientId, body, idempotencyKey);

Errors

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

UpdateRecipientDefaultBankAccount

Updates the default bank account from a recipient

Task<PCL.Models.RecipientsDefaultBankAccountResponse> UpdateRecipientDefaultBankAccount(string recipientId, PCL.Models.RecipientsDefaultBankAccountRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string recipientId = "recipient_id";
var body = new PCL.Models.RecipientsDefaultBankAccountRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.RecipientsDefaultBankAccountResponse result = await recipients.UpdateRecipientDefaultBankAccount(recipientId, body, idempotencyKey);

Errors

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

GetRecipient

Retrieves recipient information

Task<PCL.Models.RecipientsResponse1> GetRecipient(string recipientId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipiend id

Example Usage

string recipientId = "recipient_id";

PCL.Models.RecipientsResponse1 result = await recipients.GetRecipient(recipientId);

Errors

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

UpdateRecipient

Updates a recipient

Task<PCL.Models.RecipientsResponse1> UpdateRecipient(string recipientId, PCL.Models.RecipientsRequest1 body, string idempotencyKey = null)

Parameters

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

Example Usage

string recipientId = "recipient_id";
var body = new PCL.Models.RecipientsRequest1();
string idempotencyKey = "idempotency-key";

PCL.Models.RecipientsResponse1 result = await recipients.UpdateRecipient(recipientId, body, idempotencyKey);

Errors

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

GetTransfer

Gets a transfer

Task<PCL.Models.RecipientsTransfersResponse> 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";

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

Errors

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

GetTransfers

Gets a paginated list of transfers for the recipient

Task<PCL.Models.RecipientsTransfersResponse1> 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 = 122;
int? size = 122;
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

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

Errors

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

CreateTransfer

Creates a transfer for a recipient

Task<PCL.Models.RecipientsTransfersResponse> CreateTransfer(string recipientId, PCL.Models.RecipientsTransfersRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

string recipientId = "recipient_id";
var body = new PCL.Models.RecipientsTransfersRequest();
string idempotencyKey = "idempotency-key";

PCL.Models.RecipientsTransfersResponse result = await recipients.CreateTransfer(recipientId, body, idempotencyKey);

Errors

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

GetAnticipationLimits

Gets the anticipation limits for a recipient

Task<PCL.Models.RecipientsAnticipationLimitsResponse> 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();

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

Errors

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

CreateWithdraw

CreateWithdraw

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	TODO: Add a parameter description
body	`Required`	TODO: Add a parameter description

Example Usage

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

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

Errors

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

GetWithdrawals

Gets a paginated list of transfers for the recipient

Task<PCL.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 = 122;
int? size = 122;
string status = "status";
DateTime? createdSince = DateTime.Now();
DateTime? createdUntil = DateTime.Now();

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

Errors

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

GetWithdrawById

GetWithdrawById

Task<PCL.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";

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

Errors

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

UpdateAutomaticAnticipationSettings

Updates recipient metadata

Task<PCL.Models.RecipientsAutomaticAnticipationSettingsResponse> UpdateAutomaticAnticipationSettings(string recipientId, PCL.Models.UpdateAutomaticAnticipationSettingsRequest body, string idempotencyKey = null)

Parameters

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

Example Usage

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

PCL.Models.RecipientsAutomaticAnticipationSettingsResponse result = await recipients.UpdateAutomaticAnticipationSettings(recipientId, body, idempotencyKey);

Errors

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

GetRecipientByCode

Retrieves recipient information

Task<PCL.Models.RecipientsCodeResponse> GetRecipientByCode(string code)

Parameters

Parameter	Tags	Description
code	`Required`	Recipient code

Example Usage

string code = "code";

PCL.Models.RecipientsCodeResponse result = await recipients.GetRecipientByCode(code);

Errors

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

Back to List of Controllers

TokensController

Get singleton instance

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

TokensController tokens = client.Tokens;

CreateToken

Tags: Skips Authentication

CreateToken

Task<PCL.Models.TokensResponse> CreateToken(
        string publicKey,
        PCL.Models.TokensRequest body,
        string idempotencyKey = null,
        string appId = null)

Parameters

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

Example Usage

string publicKey = "public_key";
var body = new PCL.Models.TokensRequest();
string idempotencyKey = "idempotency-key";
string appId = "appId";

PCL.Models.TokensResponse result = await tokens.CreateToken(publicKey, body, idempotencyKey, appId);

Errors

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

GetToken

Tags: Skips Authentication

Gets a token from its id

Task<PCL.Models.TokensResponse> GetToken(string id, string publicKey, string appId = null)

Parameters

Parameter	Tags	Description
id	`Required`	Token id
publicKey	`Required`	Public key
appId	`Optional`	TODO: Add a parameter description

Example Usage

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

PCL.Models.TokensResponse result = await tokens.GetToken(id, publicKey, appId);

Errors

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

Back to List of Controllers

TransactionsController

Get singleton instance

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

TransactionsController transactions = client.Transactions;

GetTransaction

GetTransaction

Task<PCL.Models.GetTransactionResponse> GetTransaction(string transactionId)

Parameters

Parameter	Tags	Description
transactionId	`Required`	TODO: Add a parameter description

Example Usage

string transactionId = "transaction_id";

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

Errors

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

Back to List of Controllers

TransfersController

Get singleton instance

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

TransfersController transfers = client.Transfers;

PostCreateTransfer

CreateTransfer

Task<PCL.Models.GetTransfer> PostCreateTransfer(PCL.Models.CreateTransfer body)

Parameters

Parameter	Tags	Description
body	`Required`	TODO: Add a parameter description

Example Usage

var body = new PCL.Models.CreateTransfer();

PCL.Models.GetTransfer result = await transfers.PostCreateTransfer(body);

Errors

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

GetTransferById

GetTransferById

Task<PCL.Models.GetTransfer> GetTransferById(string transferId)

Parameters

Parameter	Tags	Description
transferId	`Required`	TODO: Add a parameter description

Example Usage

string transferId = "transfer_id";

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

Errors

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

GetTransfers1

Gets all transfers

Task<PCL.Models.ListTransfers> GetTransfers1()

Example Usage


PCL.Models.ListTransfers result = await transfers.GetTransfers1();

Errors

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

Back to List of Controllers

Name		Name	Last commit message	Last commit date
Latest commit History 172 Commits
MundiAPI.PCL		MundiAPI.PCL
MundiAPI.Tests		MundiAPI.Tests
LICENSE		LICENSE
MundiAPI.sln		MundiAPI.sln
README.md		README.md

Folders and files

Latest commit

History

Repository files navigation

Getting started

How to Build

How to Use

1. Starting a new project

2. Set as startup project

3. Add reference of the library project

4. Write sample code

How to Test

Initialization

Authentication

Class Reference

List of Controllers

SubscriptionsController

Get singleton instance

CreateDiscount

Parameters

Example Usage

Errors

GetSubscriptionItem

Parameters

Example Usage

Errors

UpdateSubscriptionItem

Parameters

Example Usage

Errors

DeleteUsage

Parameters

Example Usage

Errors

CancelSubscription

Parameters

Example Usage

Errors

GetSubscription

Parameters

Example Usage

Errors

DeleteIncrement

Parameters

Example Usage

Errors

GetIncrementById

Parameters

Example Usage

Errors

GetSubscriptionCycleById

Parameters

Example Usage

Errors

UpdateSubscriptionStartAt

Parameters

Example Usage

Errors

UpdateSubscriptionPaymentMethod

Parameters

Example Usage

Errors

UpdateCurrentCycleStatus

Parameters

Example Usage

Errors

CreateSubscription

Parameters

Example Usage

Errors

GetSubscriptions

Parameters

Example Usage

Errors

GetUsagesDetails

Parameters

Example Usage

Errors

RenewSubscription

Parameters