pagarme-python

Release 5.7.0

Pagarme API

Homepage PyPI Python

License
Other
Install
pip install pagarme-python==5.7.0

Documentation

Getting started

Pagarme API

How to Build

You must have Python 2 >=2.7.9 or Python 3 >=3.4 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

  • Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
  • Run the command pip install -r requirements.txt. This should install all the required dependencies.

Building SDK - Step 1

How to Use

The following section explains how to use the Pagarmecoreapi SDK package in a new project.

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1

Name the directory as "test"

Add a new project in PyCharm - Step 2

Add a python file to this project with the name "testsdk"

Add a new project in PyCharm - Step 3

Name it "testsdk"

Add a new project in PyCharm - Step 4

In your python file you will be required to import the generated python library using the following code lines

from pagarmecoreapi.pagarmecoreapi_client import PagarmecoreapiClient

Add a new project in PyCharm - Step 4

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

Run Test Project - Step 1

How to Test

You can test the generated SDK and the server with automatically generated test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke pip install -r test-requirements.txt
  3. Invoke nosetests

Initialization

Authentication

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

Parameter Description
service_referer_name TODO: add a description
basic_auth_user_name The username to use with basic authentication
basic_auth_password The password to use with basic authentication

API client can be initialized as following.

# Configuration parameters and credentials
service_referer_name = 'service_referer_name'
basic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication
basic_auth_password = 'basic_auth_password' # The password to use with basic authentication

client = PagarmecoreapiClient(service_referer_name, basic_auth_user_name, basic_auth_password)

Class Reference

List of Controllers

Class: SubscriptionsController

Get controller instance

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

 subscriptions_controller = client.subscriptions

Method: update_subscription_card

Updates the credit card from a subscription

def update_subscription_card(self,
                                 subscription_id,
                                 body,
                                 idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
body = UpdateSubscriptionCardRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_card(subscription_id, body, idempotency_key)

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

Method: create_an_usage

Create Usage

def create_an_usage(self,
                        subscription_id,
                        item_id,
                        idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
item_id = 'item_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.create_an_usage(subscription_id, item_id, idempotency_key)

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

Method: update_subscription_payment_method

Updates the payment method from a subscription

def update_subscription_payment_method(self,
                                           subscription_id,
                                           body,
                                           idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateSubscriptionPaymentMethodRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_payment_method(subscription_id, body, idempotency_key)

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

Method: create_subscription_item

Creates a new Subscription item

def create_subscription_item(self,
                                 subscription_id,
                                 body,
                                 idempotency_key=None)

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

subscription_id = 'subscription_id'
body = CreateSubscriptionItemRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.create_subscription_item(subscription_id, body, idempotency_key)

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

Method: get_subscription_item

Get Subscription Item

def get_subscription_item(self,
                              subscription_id,
                              item_id)

Parameters

Parameter Tags Description
subscriptionId Required Subscription Id
itemId Required Item id

Example Usage

subscription_id = 'subscription_id'
item_id = 'item_id'

result = subscriptions_controller.get_subscription_item(subscription_id, item_id)

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

Method: update_subscription_affiliation_id

UpdateSubscriptionAffiliationId

def update_subscription_affiliation_id(self,
                                           subscription_id,
                                           body,
                                           idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateSubscriptionAffiliationIdRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_affiliation_id(subscription_id, body, idempotency_key)

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

Method: get_increments

GetIncrements

def get_increments(self,
                       subscription_id,
                       page=None,
                       size=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
page = 185
size = 185

result = subscriptions_controller.get_increments(subscription_id, 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

Method: update_subscription_due_days

Updates the boleto due days from a subscription

def update_subscription_due_days(self,
                                     subscription_id,
                                     body,
                                     idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
body = UpdateSubscriptionDueDaysRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_due_days(subscription_id, body, idempotency_key)

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

Method: update_subscription_start_at

Updates the start at date from a subscription

def update_subscription_start_at(self,
                                     subscription_id,
                                     body,
                                     idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateSubscriptionStartAtRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_start_at(subscription_id, body, idempotency_key)

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

Method: get_subscription_cycle_by_id

GetSubscriptionCycleById

def get_subscription_cycle_by_id(self,
                                     subscription_id,
                                     cycle_id)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
cycle_id = 'cycleId'

result = subscriptions_controller.get_subscription_cycle_by_id(subscription_id, cycle_id)

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

Method: delete_discount

Deletes a discount

def delete_discount(self,
                        subscription_id,
                        discount_id,
                        idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
discount_id = 'discount_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.delete_discount(subscription_id, discount_id, idempotency_key)

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

Method: get_subscription_items

Get Subscription Items

def get_subscription_items(self,
                               subscription_id,
                               page=None,
                               size=None,
                               name=None,
                               code=None,
                               status=None,
                               description=None,
                               created_since=None,
                               created_until=None)

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

subscription_id = 'subscription_id'
page = 185
size = 185
name = 'name'
code = 'code'
status = 'status'
description = 'description'
created_since = 'created_since'
created_until = 'created_until'

result = subscriptions_controller.get_subscription_items(subscription_id, page, size, name, code, status, description, created_since, created_until)

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

Method: update_subscription_item

Updates a subscription item

def update_subscription_item(self,
                                 subscription_id,
                                 item_id,
                                 body,
                                 idempotency_key=None)

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

subscription_id = 'subscription_id'
item_id = 'item_id'
body = UpdateSubscriptionItemRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_item(subscription_id, item_id, body, idempotency_key)

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

Method: create_subscription

Creates a new subscription

def create_subscription(self,
                            body,
                            idempotency_key=None)

Parameters

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

Example Usage

body = CreateSubscriptionRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.create_subscription(body, idempotency_key)

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

Method: get_discount_by_id

GetDiscountById

def get_discount_by_id(self,
                           subscription_id,
                           discount_id)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
discount_id = 'discountId'

result = subscriptions_controller.get_discount_by_id(subscription_id, discount_id)

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

Method: update_subscription_billing_date

Updates the billing date from a subscription

def update_subscription_billing_date(self,
                                         subscription_id,
                                         body,
                                         idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateSubscriptionBillingDateRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_billing_date(subscription_id, body, idempotency_key)

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

Method: update_latest_period_end_at

UpdateLatestPeriodEndAt

def update_latest_period_end_at(self,
                                    subscription_id,
                                    body,
                                    idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateCurrentCycleEndDateRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_latest_period_end_at(subscription_id, body, idempotency_key)

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

Method: create_discount

Creates a discount

def create_discount(self,
                        subscription_id,
                        body,
                        idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
body = CreateDiscountRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.create_discount(subscription_id, body, idempotency_key)

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

Method: delete_usage

Deletes a usage

def delete_usage(self,
                     subscription_id,
                     item_id,
                     usage_id,
                     idempotency_key=None)

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

subscription_id = 'subscription_id'
item_id = 'item_id'
usage_id = 'usage_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.delete_usage(subscription_id, item_id, usage_id, idempotency_key)

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

Method: get_usages

Lists all usages from a subscription item

def get_usages(self,
                   subscription_id,
                   item_id,
                   page=None,
                   size=None,
                   code=None,
                   group=None,
                   used_since=None,
                   used_until=None)

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
group Optional Identification group in the client system
usedSince Optional TODO: Add a parameter description
usedUntil Optional TODO: Add a parameter description

Example Usage

subscription_id = 'subscription_id'
item_id = 'item_id'
page = 185
size = 185
code = 'code'
group = 'group'
used_since = datetime.now()
used_until = datetime.now()

result = subscriptions_controller.get_usages(subscription_id, item_id, page, size, code, group, used_since, used_until)

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

Method: update_current_cycle_status

UpdateCurrentCycleStatus

def update_current_cycle_status(self,
                                    subscription_id,
                                    body,
                                    idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateCurrentCycleStatusRequest()
idempotency_key = 'idempotency-key'

subscriptions_controller.update_current_cycle_status(subscription_id, body, idempotency_key)

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

Method: cancel_subscription

Cancels a subscription

def cancel_subscription(self,
                            subscription_id,
                            idempotency_key=None,
                            body=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
idempotency_key = 'idempotency-key'
body = CreateCancelSubscriptionRequest()

result = subscriptions_controller.cancel_subscription(subscription_id, idempotency_key, 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

Method: create_increment

Creates a increment

def create_increment(self,
                         subscription_id,
                         body,
                         idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
body = CreateIncrementRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.create_increment(subscription_id, body, idempotency_key)

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

Method: update_subscription_metadata

Updates the metadata from a subscription

def update_subscription_metadata(self,
                                     subscription_id,
                                     body,
                                     idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_metadata(subscription_id, body, idempotency_key)

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

Method: get_discounts

GetDiscounts

def get_discounts(self,
                      subscription_id,
                      page,
                      size)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
page = 185
size = 185

result = subscriptions_controller.get_discounts(subscription_id, 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

Method: update_subscription_minium_price

AtualizaĂ§Ă£o do valor mĂ­nimo da assinatura

def update_subscription_minium_price(self,
                                         subscription_id,
                                         body,
                                         idempotency_key=None)

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

subscription_id = 'subscription_id'
body = UpdateSubscriptionMinimumPriceRequest()
idempotency_key = 'idempotency-key'

result = subscriptions_controller.update_subscription_minium_price(subscription_id, body, idempotency_key)

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

Method: update_split_subscription

UpdateSplitSubscription

def update_split_subscription(self,
                                  id,
                                  body)

Parameters

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

Example Usage

id = 'id'
body = UpdateSubscriptionSplitRequest()

result = subscriptions_controller.update_split_subscription(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

Method: get_subscriptions

Gets all subscriptions

def get_subscriptions(self,
                          page=None,
                          size=None,
                          code=None,
                          billing_type=None,
                          customer_id=None,
                          plan_id=None,
                          card_id=None,
                          status=None,
                          next_billing_since=None,
                          next_billing_until=None,
                          created_since=None,
                          created_until=None)

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

page = 185
size = 185
code = 'code'
billing_type = 'billing_type'
customer_id = 'customer_id'
plan_id = 'plan_id'
card_id = 'card_id'
status = 'status'
next_billing_since = datetime.now()
next_billing_until = datetime.now()
created_since = datetime.now()
created_until = datetime.now()

result = subscriptions_controller.get_subscriptions(page, size, code, billing_type, customer_id, plan_id, card_id, status, next_billing_since, next_billing_until, created_since, created_until)

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

Method: get_subscription

Gets a subscription

def get_subscription(self,
                         subscription_id)

Parameters

Parameter Tags Description
subscriptionId Required Subscription id

Example Usage

subscription_id = 'subscription_id'

result = subscriptions_controller.get_subscription(subscription_id)

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

Method: delete_increment

Deletes a increment

def delete_increment(self,
                         subscription_id,
                         increment_id,
                         idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
increment_id = 'increment_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.delete_increment(subscription_id, increment_id, idempotency_key)

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

Method: get_increment_by_id

GetIncrementById

def get_increment_by_id(self,
                            subscription_id,
                            increment_id)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
increment_id = 'increment_id'

result = subscriptions_controller.get_increment_by_id(subscription_id, increment_id)

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

Method: get_subscription_cycles

GetSubscriptionCycles

def get_subscription_cycles(self,
                                subscription_id,
                                page,
                                size)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
page = 'page'
size = 'size'

result = subscriptions_controller.get_subscription_cycles(subscription_id, 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

Method: renew_subscription

RenewSubscription

def renew_subscription(self,
                           subscription_id,
                           idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.renew_subscription(subscription_id, idempotency_key)

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

Method: delete_subscription_item

Deletes a subscription item

def delete_subscription_item(self,
                                 subscription_id,
                                 subscription_item_id,
                                 idempotency_key=None)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
subscription_item_id = 'subscription_item_id'
idempotency_key = 'idempotency-key'

result = subscriptions_controller.delete_subscription_item(subscription_id, subscription_item_id, idempotency_key)

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

Method: get_usage_report

GetUsageReport

def get_usage_report(self,
                         subscription_id,
                         period_id)

Parameters

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

Example Usage

subscription_id = 'subscription_id'
period_id = 'period_id'

result = subscriptions_controller.get_usage_report(subscription_id, period_id)

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

Class: OrdersController

Get controller instance

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

 orders_controller = client.orders

Method: get_orders

Gets all orders

def get_orders(self,
                   page=None,
                   size=None,
                   code=None,
                   status=None,
                   created_since=None,
                   created_until=None,
                   customer_id=None)

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

page = 185
size = 185
code = 'code'
status = 'status'
created_since = datetime.now()
created_until = datetime.now()
customer_id = 'customer_id'

result = orders_controller.get_orders(page, size, code, status, created_since, created_until, customer_id)

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

Method: create_order

Creates a new Order

def create_order(self,
                     body,
                     idempotency_key=None)

Parameters

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

Example Usage

body = CreateOrderRequest()
idempotency_key = 'idempotency-key'

result = orders_controller.create_order(body, idempotency_key)

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

Method: create_order_item

CreateOrderItem

def create_order_item(self,
                          order_id,
                          body,
                          idempotency_key=None)

Parameters

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

Example Usage

order_id = 'orderId'
body = CreateOrderItemRequest()
idempotency_key = 'idempotency-key'

result = orders_controller.create_order_item(order_id, body, idempotency_key)

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

Method: get_order_item

GetOrderItem

def get_order_item(self,
                       order_id,
                       item_id)

Parameters

Parameter Tags Description
orderId Required Order Id
itemId Required Item Id

Example Usage

order_id = 'orderId'
item_id = 'itemId'

result = orders_controller.get_order_item(order_id, item_id)

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

Method: delete_order_item

DeleteOrderItem

def delete_order_item(self,
                          order_id,
                          item_id,
                          idempotency_key=None)

Parameters

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

Example Usage

order_id = 'orderId'
item_id = 'itemId'
idempotency_key = 'idempotency-key'

result = orders_controller.delete_order_item(order_id, item_id, idempotency_key)

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

Method: update_order_metadata

Updates the metadata from an order

def update_order_metadata(self,
                              order_id,
                              body,
                              idempotency_key=None)

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

order_id = 'order_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = orders_controller.update_order_metadata(order_id, body, idempotency_key)

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

Method: delete_all_order_items

DeleteAllOrderItems

def delete_all_order_items(self,
                               order_id,
                               idempotency_key=None)

Parameters

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

Example Usage

order_id = 'orderId'
idempotency_key = 'idempotency-key'

result = orders_controller.delete_all_order_items(order_id, idempotency_key)

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

Method: update_order_item

UpdateOrderItem

def update_order_item(self,
                          order_id,
                          item_id,
                          body,
                          idempotency_key=None)

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

order_id = 'orderId'
item_id = 'itemId'
body = UpdateOrderItemRequest()
idempotency_key = 'idempotency-key'

result = orders_controller.update_order_item(order_id, item_id, body, idempotency_key)

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

Method: close_order

CloseOrder

def close_order(self,
                    id,
                    body,
                    idempotency_key=None)

Parameters

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

Example Usage

id = 'id'
body = UpdateOrderStatusRequest()
idempotency_key = 'idempotency-key'

result = orders_controller.close_order(id, body, idempotency_key)

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

Method: get_order

Gets an order

def get_order(self,
                  order_id)

Parameters

Parameter Tags Description
orderId Required Order id

Example Usage

order_id = 'order_id'

result = orders_controller.get_order(order_id)

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

Class: PlansController

Get controller instance

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

 plans_controller = client.plans

Method: get_plan

Gets a plan

def get_plan(self,
                 plan_id)

Parameters

Parameter Tags Description
planId Required Plan id

Example Usage

plan_id = 'plan_id'

result = plans_controller.get_plan(plan_id)

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

Method: create_plan

Creates a new plan

def create_plan(self,
                    body,
                    idempotency_key=None)

Parameters

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

Example Usage

body = CreatePlanRequest()
idempotency_key = 'idempotency-key'

result = plans_controller.create_plan(body, idempotency_key)

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

Method: update_plan

Updates a plan

def update_plan(self,
                    plan_id,
                    body,
                    idempotency_key=None)

Parameters

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

Example Usage

plan_id = 'plan_id'
body = UpdatePlanRequest()
idempotency_key = 'idempotency-key'

result = plans_controller.update_plan(plan_id, body, idempotency_key)

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

Method: get_plan_item

Gets a plan item

def get_plan_item(self,
                      plan_id,
                      plan_item_id)

Parameters

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

Example Usage

plan_id = 'plan_id'
plan_item_id = 'plan_item_id'

result = plans_controller.get_plan_item(plan_id, plan_item_id)

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

Method: create_plan_item

Adds a new item to a plan

def create_plan_item(self,
                         plan_id,
                         body,
                         idempotency_key=None)

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

plan_id = 'plan_id'
body = CreatePlanItemRequest()
idempotency_key = 'idempotency-key'

result = plans_controller.create_plan_item(plan_id, body, idempotency_key)

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

Method: get_plans

Gets all plans

def get_plans(self,
                  page=None,
                  size=None,
                  name=None,
                  status=None,
                  billing_type=None,
                  created_since=None,
                  created_until=None)

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

page = 94
size = 94
name = 'name'
status = 'status'
billing_type = 'billing_type'
created_since = datetime.now()
created_until = datetime.now()

result = plans_controller.get_plans(page, size, name, status, billing_type, created_since, created_until)

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

Method: delete_plan

Deletes a plan

def delete_plan(self,
                    plan_id,
                    idempotency_key=None)

Parameters

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

Example Usage

plan_id = 'plan_id'
idempotency_key = 'idempotency-key'

result = plans_controller.delete_plan(plan_id, idempotency_key)

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

Method: update_plan_metadata

Updates the metadata from a plan

def update_plan_metadata(self,
                             plan_id,
                             body,
                             idempotency_key=None)

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

plan_id = 'plan_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = plans_controller.update_plan_metadata(plan_id, body, idempotency_key)

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

Method: update_plan_item

Updates a plan item

def update_plan_item(self,
                         plan_id,
                         plan_item_id,
                         body,
                         idempotency_key=None)

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

plan_id = 'plan_id'
plan_item_id = 'plan_item_id'
body = UpdatePlanItemRequest()
idempotency_key = 'idempotency-key'

result = plans_controller.update_plan_item(plan_id, plan_item_id, body, idempotency_key)

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

Method: delete_plan_item

Removes an item from a plan

def delete_plan_item(self,
                         plan_id,
                         plan_item_id,
                         idempotency_key=None)

Parameters

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

Example Usage

plan_id = 'plan_id'
plan_item_id = 'plan_item_id'
idempotency_key = 'idempotency-key'

result = plans_controller.delete_plan_item(plan_id, plan_item_id, idempotency_key)

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

Class: InvoicesController

Get controller instance

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

 invoices_controller = client.invoices

Method: cancel_invoice

Cancels an invoice

def cancel_invoice(self,
                       invoice_id,
                       idempotency_key=None)

Parameters

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

Example Usage

invoice_id = 'invoice_id'
idempotency_key = 'idempotency-key'

result = invoices_controller.cancel_invoice(invoice_id, idempotency_key)

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

Method: get_invoice

Gets an invoice

def get_invoice(self,
                    invoice_id)

Parameters

Parameter Tags Description
invoiceId Required Invoice Id

Example Usage

invoice_id = 'invoice_id'

result = invoices_controller.get_invoice(invoice_id)

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

Method: create_invoice

Create an Invoice

def create_invoice(self,
                       subscription_id,
                       cycle_id,
                       idempotency_key=None,
                       body=None)

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

subscription_id = 'subscription_id'
cycle_id = 'cycle_id'
idempotency_key = 'idempotency-key'
body = CreateInvoiceRequest()

result = invoices_controller.create_invoice(subscription_id, cycle_id, idempotency_key, 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

Method: update_invoice_metadata

Updates the metadata from an invoice

def update_invoice_metadata(self,
                                invoice_id,
                                body,
                                idempotency_key=None)

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

invoice_id = 'invoice_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = invoices_controller.update_invoice_metadata(invoice_id, body, idempotency_key)

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

Method: get_invoices

Gets all invoices

def get_invoices(self,
                     page=None,
                     size=None,
                     code=None,
                     customer_id=None,
                     subscription_id=None,
                     created_since=None,
                     created_until=None,
                     status=None,
                     due_since=None,
                     due_until=None,
                     customer_document=None)

Parameters

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

Example Usage

page = 94
size = 94
code = 'code'
customer_id = 'customer_id'
subscription_id = 'subscription_id'
created_since = datetime.now()
created_until = datetime.now()
status = 'status'
due_since = datetime.now()
due_until = datetime.now()
customer_document = 'customer_document'

result = invoices_controller.get_invoices(page, size, code, customer_id, subscription_id, created_since, created_until, status, due_since, due_until, customer_document)

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

Method: get_partial_invoice

GetPartialInvoice

def get_partial_invoice(self,
                            subscription_id)

Parameters

Parameter Tags Description
subscriptionId Required Subscription Id

Example Usage

subscription_id = 'subscription_id'

result = invoices_controller.get_partial_invoice(subscription_id)

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

Method: update_invoice_status

Updates the status from an invoice

def update_invoice_status(self,
                              invoice_id,
                              body,
                              idempotency_key=None)

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

invoice_id = 'invoice_id'
body = UpdateInvoiceStatusRequest()
idempotency_key = 'idempotency-key'

result = invoices_controller.update_invoice_status(invoice_id, body, idempotency_key)

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

Class: CustomersController

Get controller instance

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

 customers_controller = client.customers

Method: delete_card

Delete a customer's card

def delete_card(self,
                    customer_id,
                    card_id,
                    idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
card_id = 'card_id'
idempotency_key = 'idempotency-key'

result = customers_controller.delete_card(customer_id, card_id, idempotency_key)

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

Method: update_address

Updates an address

def update_address(self,
                       customer_id,
                       address_id,
                       body,
                       idempotency_key=None)

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

customer_id = 'customer_id'
address_id = 'address_id'
body = UpdateAddressRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.update_address(customer_id, address_id, body, idempotency_key)

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

Method: get_address

Get a customer's address

def get_address(self,
                    customer_id,
                    address_id)

Parameters

Parameter Tags Description
customerId Required Customer id
addressId Required Address Id

Example Usage

customer_id = 'customer_id'
address_id = 'address_id'

result = customers_controller.get_address(customer_id, address_id)

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

Method: get_access_tokens

Get all access tokens from a customer

def get_access_tokens(self,
                          customer_id,
                          page=None,
                          size=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
page = 94
size = 94

result = customers_controller.get_access_tokens(customer_id, 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

Method: update_customer

Updates a customer

def update_customer(self,
                        customer_id,
                        body,
                        idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
body = UpdateCustomerRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.update_customer(customer_id, body, idempotency_key)

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

Method: renew_card

Renew a card

def renew_card(self,
                   customer_id,
                   card_id,
                   idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
card_id = 'card_id'
idempotency_key = 'idempotency-key'

result = customers_controller.renew_card(customer_id, card_id, idempotency_key)

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

Method: get_customers

Get all Customers

def get_customers(self,
                      name=None,
                      document=None,
                      page=1,
                      size=10,
                      email=None,
                      code=None)

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

name = 'name'
document = 'document'
page = 1
size = 10
email = 'email'
code = 'Code'

result = customers_controller.get_customers(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

Method: delete_access_tokens

Delete a Customer's access tokens

def delete_access_tokens(self,
                             customer_id)

Parameters

Parameter Tags Description
customerId Required Customer Id

Example Usage

customer_id = 'customer_id'

result = customers_controller.delete_access_tokens(customer_id)

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

Method: get_customer

Get a customer

def get_customer(self,
                     customer_id)

Parameters

Parameter Tags Description
customerId Required Customer Id

Example Usage

customer_id = 'customer_id'

result = customers_controller.get_customer(customer_id)

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

Method: update_card

Updates a card

def update_card(self,
                    customer_id,
                    card_id,
                    body,
                    idempotency_key=None)

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

customer_id = 'customer_id'
card_id = 'card_id'
body = UpdateCardRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.update_card(customer_id, card_id, body, idempotency_key)

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

Method: delete_address

Delete a Customer's address

def delete_address(self,
                       customer_id,
                       address_id,
                       idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
address_id = 'address_id'
idempotency_key = 'idempotency-key'

result = customers_controller.delete_address(customer_id, address_id, idempotency_key)

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

Method: create_access_token

Creates a access token for a customer

def create_access_token(self,
                            customer_id,
                            body,
                            idempotency_key=None)

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

customer_id = 'customer_id'
body = CreateAccessTokenRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.create_access_token(customer_id, body, idempotency_key)

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

Method: create_address

Creates a new address for a customer

def create_address(self,
                       customer_id,
                       body,
                       idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
body = CreateAddressRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.create_address(customer_id, body, idempotency_key)

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

Method: get_cards

Get all cards from a customer

def get_cards(self,
                  customer_id,
                  page=None,
                  size=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
page = 94
size = 94

result = customers_controller.get_cards(customer_id, 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

Method: update_customer_metadata

Updates the metadata a customer

def update_customer_metadata(self,
                                 customer_id,
                                 body,
                                 idempotency_key=None)

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

customer_id = 'customer_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.update_customer_metadata(customer_id, body, idempotency_key)

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

Method: get_card

Get a customer's card

def get_card(self,
                 customer_id,
                 card_id)

Parameters

Parameter Tags Description
customerId Required Customer id
cardId Required Card id

Example Usage

customer_id = 'customer_id'
card_id = 'card_id'

result = customers_controller.get_card(customer_id, card_id)

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

Method: delete_access_token

Delete a customer's access token

def delete_access_token(self,
                            customer_id,
                            token_id,
                            idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
token_id = 'token_id'
idempotency_key = 'idempotency-key'

result = customers_controller.delete_access_token(customer_id, token_id, idempotency_key)

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

Method: get_access_token

Get a Customer's access token

def get_access_token(self,
                         customer_id,
                         token_id)

Parameters

Parameter Tags Description
customerId Required Customer Id
tokenId Required Token Id

Example Usage

customer_id = 'customer_id'
token_id = 'token_id'

result = customers_controller.get_access_token(customer_id, token_id)

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

Method: get_addresses

Gets all adressess from a customer

def get_addresses(self,
                      customer_id,
                      page=None,
                      size=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
page = 136
size = 136

result = customers_controller.get_addresses(customer_id, 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

Method: create_customer

Creates a new customer

def create_customer(self,
                        body,
                        idempotency_key=None)

Parameters

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

Example Usage

body = CreateCustomerRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.create_customer(body, idempotency_key)

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

Method: create_card

Creates a new card for a customer

def create_card(self,
                    customer_id,
                    body,
                    idempotency_key=None)

Parameters

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

Example Usage

customer_id = 'customer_id'
body = CreateCardRequest()
idempotency_key = 'idempotency-key'

result = customers_controller.create_card(customer_id, body, idempotency_key)

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

Class: ChargesController

Get controller instance

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

 charges_controller = client.charges

Method: capture_charge

Captures a charge

def capture_charge(self,
                       charge_id,
                       idempotency_key=None,
                       body=None)

Parameters

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

Example Usage

charge_id = 'charge_id'
idempotency_key = 'idempotency-key'
body = CreateCaptureChargeRequest()

result = charges_controller.capture_charge(charge_id, idempotency_key, 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

Method: get_charge_transactions

GetChargeTransactions

def get_charge_transactions(self,
                                charge_id,
                                page=None,
                                size=None)

Parameters

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

Example Usage

charge_id = 'charge_id'
page = 136
size = 136

result = charges_controller.get_charge_transactions(charge_id, 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

Method: get_charges

Lists all charges

def get_charges(self,
                    page=None,
                    size=None,
                    code=None,
                    status=None,
                    payment_method=None,
                    customer_id=None,
                    order_id=None,
                    created_since=None,
                    created_until=None)

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

page = 136
size = 136
code = 'code'
status = 'status'
payment_method = 'payment_method'
customer_id = 'customer_id'
order_id = 'order_id'
created_since = datetime.now()
created_until = datetime.now()

result = charges_controller.get_charges(page, size, code, status, payment_method, customer_id, order_id, created_since, created_until)

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

Method: update_charge_payment_method

Updates a charge's payment method

def update_charge_payment_method(self,
                                     charge_id,
                                     body,
                                     idempotency_key=None)

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

charge_id = 'charge_id'
body = UpdateChargePaymentMethodRequest()
idempotency_key = 'idempotency-key'

result = charges_controller.update_charge_payment_method(charge_id, body, idempotency_key)

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

Method: update_charge_due_date

Updates the due date from a charge

def update_charge_due_date(self,
                               charge_id,
                               body,
                               idempotency_key=None)

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

charge_id = 'charge_id'
body = UpdateChargeDueDateRequest()
idempotency_key = 'idempotency-key'

result = charges_controller.update_charge_due_date(charge_id, body, idempotency_key)

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

Method: confirm_payment

ConfirmPayment

def confirm_payment(self,
                        charge_id,
                        idempotency_key=None,
                        body=None)

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

charge_id = 'charge_id'
idempotency_key = 'idempotency-key'
body = CreateConfirmPaymentRequest()

result = charges_controller.confirm_payment(charge_id, idempotency_key, 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

Method: get_charge

Get a charge from its id

def get_charge(self,
                   charge_id)

Parameters

Parameter Tags Description
chargeId Required Charge id

Example Usage

charge_id = 'charge_id'

result = charges_controller.get_charge(charge_id)

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

Method: retry_charge

Retries a charge

def retry_charge(self,
                     charge_id,
                     idempotency_key=None)

Parameters

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

Example Usage

charge_id = 'charge_id'
idempotency_key = 'idempotency-key'

result = charges_controller.retry_charge(charge_id, idempotency_key)

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

Method: update_charge_metadata

Updates the metadata from a charge

def update_charge_metadata(self,
                               charge_id,
                               body,
                               idempotency_key=None)

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

charge_id = 'charge_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = charges_controller.update_charge_metadata(charge_id, body, idempotency_key)

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

Method: update_charge_card

Updates the card from a charge

def update_charge_card(self,
                           charge_id,
                           body,
                           idempotency_key=None)

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

charge_id = 'charge_id'
body = UpdateChargeCardRequest()
idempotency_key = 'idempotency-key'

result = charges_controller.update_charge_card(charge_id, body, idempotency_key)

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

Method: cancel_charge

Cancel a charge

def cancel_charge(self,
                      charge_id,
                      idempotency_key=None,
                      body=None)

Parameters

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

Example Usage

charge_id = 'charge_id'
idempotency_key = 'idempotency-key'
body = CreateCancelChargeRequest()

result = charges_controller.cancel_charge(charge_id, idempotency_key, 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

Method: get_charges_summary

GetChargesSummary

def get_charges_summary(self,
                            status,
                            created_since=None,
                            created_until=None)

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

status = 'status'
created_since = datetime.now()
created_until = datetime.now()

result = charges_controller.get_charges_summary(status, created_since, created_until)

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

Method: create_charge

Creates a new charge

def create_charge(self,
                      body,
                      idempotency_key=None)

Parameters

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

Example Usage

body = CreateChargeRequest()
idempotency_key = 'idempotency-key'

result = charges_controller.create_charge(body, idempotency_key)

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

Class: RecipientsController

Get controller instance

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

 recipients_controller = client.recipients

Method: get_transfer

Gets a transfer

def get_transfer(self,
                     recipient_id,
                     transfer_id)

Parameters

Parameter Tags Description
recipientId Required Recipient id
transferId Required Transfer id

Example Usage

recipient_id = 'recipient_id'
transfer_id = 'transfer_id'

result = recipients_controller.get_transfer(recipient_id, transfer_id)

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

Method: get_recipient

Retrieves recipient information

def get_recipient(self,
                      recipient_id)

Parameters

Parameter Tags Description
recipientId Required Recipiend id

Example Usage

recipient_id = 'recipient_id'

result = recipients_controller.get_recipient(recipient_id)

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

Method: update_recipient_metadata

Updates recipient metadata

def update_recipient_metadata(self,
                                  recipient_id,
                                  body,
                                  idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.update_recipient_metadata(recipient_id, body, idempotency_key)

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

Method: create_transfer

Creates a transfer for a recipient

def create_transfer(self,
                        recipient_id,
                        body,
                        idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = CreateTransferRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.create_transfer(recipient_id, body, idempotency_key)

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

Method: update_automatic_anticipation_settings

Updates recipient metadata

def update_automatic_anticipation_settings(self,
                                               recipient_id,
                                               body,
                                               idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = UpdateAutomaticAnticipationSettingsRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.update_automatic_anticipation_settings(recipient_id, body, idempotency_key)

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

Method: get_balance

Get balance information for a recipient

def get_balance(self,
                    recipient_id)

Parameters

Parameter Tags Description
recipientId Required Recipient id

Example Usage

recipient_id = 'recipient_id'

result = recipients_controller.get_balance(recipient_id)

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

Method: get_anticipations

Retrieves a paginated list of anticipations from a recipient

def get_anticipations(self,
                          recipient_id,
                          page=None,
                          size=None,
                          status=None,
                          timeframe=None,
                          payment_date_since=None,
                          payment_date_until=None,
                          created_since=None,
                          created_until=None)

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

recipient_id = 'recipient_id'
page = 136
size = 136
status = 'status'
timeframe = 'timeframe'
payment_date_since = datetime.now()
payment_date_until = datetime.now()
created_since = datetime.now()
created_until = datetime.now()

result = recipients_controller.get_anticipations(recipient_id, page, size, status, timeframe, payment_date_since, payment_date_until, created_since, created_until)

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

Method: get_withdraw_by_id

GetWithdrawById

def get_withdraw_by_id(self,
                           recipient_id,
                           withdrawal_id)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
withdrawal_id = 'withdrawal_id'

result = recipients_controller.get_withdraw_by_id(recipient_id, withdrawal_id)

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

Method: create_withdraw

CreateWithdraw

def create_withdraw(self,
                        recipient_id,
                        body)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = CreateWithdrawRequest()

result = recipients_controller.create_withdraw(recipient_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

Method: update_recipient

Updates a recipient

def update_recipient(self,
                         recipient_id,
                         body,
                         idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = UpdateRecipientRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.update_recipient(recipient_id, body, idempotency_key)

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

Method: create_anticipation

Creates an anticipation

def create_anticipation(self,
                            recipient_id,
                            body,
                            idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = CreateAnticipationRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.create_anticipation(recipient_id, body, idempotency_key)

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

Method: update_recipient_default_bank_account

Updates the default bank account from a recipient

def update_recipient_default_bank_account(self,
                                              recipient_id,
                                              body,
                                              idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = UpdateRecipientBankAccountRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.update_recipient_default_bank_account(recipient_id, body, idempotency_key)

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

Method: get_recipient_by_code

Retrieves recipient information

def get_recipient_by_code(self,
                              code)

Parameters

Parameter Tags Description
code Required Recipient code

Example Usage

code = 'code'

result = recipients_controller.get_recipient_by_code(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

Method: get_anticipation_limits

Gets the anticipation limits for a recipient

def get_anticipation_limits(self,
                                recipient_id,
                                timeframe,
                                payment_date)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
timeframe = 'timeframe'
payment_date = datetime.now()

result = recipients_controller.get_anticipation_limits(recipient_id, timeframe, payment_date)

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

Method: get_recipients

Retrieves paginated recipients information

def get_recipients(self,
                       page=None,
                       size=None)

Parameters

Parameter Tags Description
page Optional Page number
size Optional Page size

Example Usage

page = 136
size = 136

result = recipients_controller.get_recipients(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

Method: create_recipient

Creates a new recipient

def create_recipient(self,
                         body,
                         idempotency_key=None)

Parameters

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

Example Usage

body = CreateRecipientRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.create_recipient(body, idempotency_key)

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

Method: get_transfers

Gets a paginated list of transfers for the recipient

def get_transfers(self,
                      recipient_id,
                      page=None,
                      size=None,
                      status=None,
                      created_since=None,
                      created_until=None)

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

recipient_id = 'recipient_id'
page = 136
size = 136
status = 'status'
created_since = datetime.now()
created_until = datetime.now()

result = recipients_controller.get_transfers(recipient_id, page, size, status, created_since, created_until)

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

Method: get_withdrawals

Gets a paginated list of transfers for the recipient

def get_withdrawals(self,
                        recipient_id,
                        page=None,
                        size=None,
                        status=None,
                        created_since=None,
                        created_until=None)

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

recipient_id = 'recipient_id'
page = 136
size = 136
status = 'status'
created_since = datetime.now()
created_until = datetime.now()

result = recipients_controller.get_withdrawals(recipient_id, page, size, status, created_since, created_until)

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

Method: get_anticipation

Gets an anticipation

def get_anticipation(self,
                         recipient_id,
                         anticipation_id)

Parameters

Parameter Tags Description
recipientId Required Recipient id
anticipationId Required Anticipation id

Example Usage

recipient_id = 'recipient_id'
anticipation_id = 'anticipation_id'

result = recipients_controller.get_anticipation(recipient_id, anticipation_id)

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

Method: update_recipient_transfer_settings

UpdateRecipientTransferSettings

def update_recipient_transfer_settings(self,
                                           recipient_id,
                                           body,
                                           idempotency_key=None)

Parameters

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

Example Usage

recipient_id = 'recipient_id'
body = UpdateTransferSettingsRequest()
idempotency_key = 'idempotency-key'

result = recipients_controller.update_recipient_transfer_settings(recipient_id, body, idempotency_key)

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

Method: get_default_recipient

GetDefaultRecipient

def get_default_recipient(self)

Example Usage

result = recipients_controller.get_default_recipient()

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

Class: TokensController

Get controller instance

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

 tokens_controller = client.tokens

Method: create_token

Tags: Skips Authentication

CreateToken

def create_token(self,
                     public_key,
                     body,
                     idempotency_key=None,
                     app_id=None)

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

public_key = 'public_key'
body = CreateTokenRequest()
idempotency_key = 'idempotency-key'
app_id = 'appId'

result = tokens_controller.create_token(public_key, body, idempotency_key, app_id)

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

Method: get_token

Tags: Skips Authentication

Gets a token from its id

def get_token(self,
                  id,
                  public_key,
                  app_id=None)

Parameters

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

Example Usage

id = 'id'
public_key = 'public_key'
app_id = 'appId'

result = tokens_controller.get_token(id, public_key, app_id)

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

Class: TransfersController

Get controller instance

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

 transfers_controller = client.transfers

Method: get_transfers_1

Gets all transfers

def get_transfers_1(self)

Example Usage

result = transfers_controller.get_transfers_1()

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

Method: get_transfer_by_id

GetTransferById

def get_transfer_by_id(self,
                           transfer_id)

Parameters

Parameter Tags Description
transferId Required TODO: Add a parameter description

Example Usage

transfer_id = 'transfer_id'

result = transfers_controller.get_transfer_by_id(transfer_id)

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

Method: post_create_transfer

CreateTransfer

def post_create_transfer(self,
                             body)

Parameters

Parameter Tags Description
body Required TODO: Add a parameter description

Example Usage

body = CreateTransfer()

result = transfers_controller.post_create_transfer(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

Class: TransactionsController

Get controller instance

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

 transactions_controller = client.transactions

Method: get_transaction

GetTransaction

def get_transaction(self,
                        transaction_id)

Parameters

Parameter Tags Description
transactionId Required TODO: Add a parameter description

Example Usage

transaction_id = 'transaction_id'

result = transactions_controller.get_transaction(transaction_id)

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

Stats

Dependencies
0
Dependent packages
1
Dependent repositories
1
Total releases
28
Latest release
First release
Stars
8
Forks
7
Watchers
12
Contributors
8
Repository size
289 KB
SourceRank
10

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

5.7.5
5.7.4
5.7.1
5.7.3
3.0.0
5.7.2
3.3.0
4.0.0
5.7.6
5.7.0
See all 28 releases

Contributors

Magno Jeferson Thiago Barradas grazielcosta Gustavo Bedasi André Machado samuelleitemundipagg Robson Junior


See all contributors

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-06-28 21:35:00 UTC

Login to resync this project