Mundipagg API
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.
The following section explains how to use the Mundiapi SDK package in a new project.
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on Open in PyCharm to browse to your generated SDK directory and then click OK.
The project files will be displayed in the side bar as follows:
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a python file to this project with the name "testsdk"
Name it "testsdk"
In your python file you will be required to import the generated python library using the following code lines
from mundiapi.mundiapi_client import MundiapiClientAfter 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.
To run the file within your test project, right click on your Python file inside your Test project and click on Run
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:
- From terminal/cmd navigate to the root directory of the SDK.
- Invoke
pip install -r test-requirements.txt - Invoke
nosetests
In order to setup authentication and initialization of the API client, you need the following information.
| Parameter | 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
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 = MundiapiClient(basic_auth_user_name, basic_auth_password)- CustomersController
- ChargesController
- RecipientsController
- SubscriptionsController
- InvoicesController
- OrdersController
- TokensController
- PlansController
- TransactionsController
- TransfersController
An instance of the CustomersController class can be accessed from the API Client.
customers_controller = client.customers
Creates a access token for a customer
def create_access_token(self,
customer_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| request | Required |
Request for creating a access token |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
request = CreateAccessTokenRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.create_access_token(customer_id, request, idempotency_key)Updates a customer
def update_customer(self,
customer_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| request | Required |
Request for updating a customer |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
request = UpdateCustomerRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.update_customer(customer_id, request, idempotency_key)Delete a Customer's access tokens
def delete_access_tokens(self,
customer_id)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
customer_id = 'customer_id'
result = customers_controller.delete_access_tokens(customer_id)Get a customer
def get_customer(self,
customer_id)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
customer_id = 'customer_id'
result = customers_controller.get_customer(customer_id)Gets all adressess from a customer
def get_addresses(self,
customer_id,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| page | Optional |
Page number |
| size | Optional |
Page size |
customer_id = 'customer_id'
page = 4
size = 4
result = customers_controller.get_addresses(customer_id, page, size)Get a Customer's access token
def get_access_token(self,
customer_id,
token_id)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| tokenId | Required |
Token Id |
customer_id = 'customer_id'
token_id = 'token_id'
result = customers_controller.get_access_token(customer_id, token_id)Get a customer's address
def get_address(self,
customer_id,
address_id)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| addressId | Required |
Address Id |
customer_id = 'customer_id'
address_id = 'address_id'
result = customers_controller.get_address(customer_id, address_id)Creates a new card for a customer
def create_card(self,
customer_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| request | Required |
Request for creating a card |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
request = CreateCardRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.create_card(customer_id, request, idempotency_key)Renew a card
def renew_card(self,
customer_id,
card_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| cardId | Required |
Card Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
card_id = 'card_id'
idempotency_key = 'idempotency-key'
result = customers_controller.renew_card(customer_id, card_id, idempotency_key)Creates a new customer
def create_customer(self,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| request | Required |
Request for creating a customer |
| idempotencyKey | Optional |
TODO: Add a parameter description |
request = CreateCustomerRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.create_customer(request, idempotency_key)Updates an address
def update_address(self,
customer_id,
address_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| addressId | Required |
Address Id |
| request | Required |
Request for updating an address |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
address_id = 'address_id'
request = UpdateAddressRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.update_address(customer_id, address_id, request, idempotency_key)Get all access tokens from a customer
def get_access_tokens(self,
customer_id,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| page | Optional |
Page number |
| size | Optional |
Page size |
customer_id = 'customer_id'
page = 4
size = 4
result = customers_controller.get_access_tokens(customer_id, page, size)Updates the metadata a customer
def update_customer_metadata(self,
customer_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
The customer id |
| request | Required |
Request for updating the customer metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.update_customer_metadata(customer_id, request, idempotency_key)Delete a Customer's address
def delete_address(self,
customer_id,
address_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| addressId | Required |
Address Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
address_id = 'address_id'
idempotency_key = 'idempotency-key'
result = customers_controller.delete_address(customer_id, address_id, idempotency_key)Updates a card
def update_card(self,
customer_id,
card_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| cardId | Required |
Card id |
| request | Required |
Request for updating a card |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
card_id = 'card_id'
request = UpdateCardRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.update_card(customer_id, card_id, request, idempotency_key)Get all cards from a customer
def get_cards(self,
customer_id,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| page | Optional |
Page number |
| size | Optional |
Page size |
customer_id = 'customer_id'
page = 4
size = 4
result = customers_controller.get_cards(customer_id, page, size)Delete a customer's card
def delete_card(self,
customer_id,
card_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| cardId | Required |
Card Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
card_id = 'card_id'
idempotency_key = 'idempotency-key'
result = customers_controller.delete_card(customer_id, card_id, idempotency_key)Get all Customers
def get_customers(self,
name=None,
document=None,
page=1,
size=10,
email=None,
code=None)| 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 |
Optional |
Customer's email | |
| code | Optional |
Customer's code |
name = 'name'
document = 'document'
page = 1
size = 10
email = 'email'
code = 'Code'
result = customers_controller.get_customers(name, document, page, size, email, code)Delete a customer's access token
def delete_access_token(self,
customer_id,
token_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| tokenId | Required |
Token Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
token_id = 'token_id'
idempotency_key = 'idempotency-key'
result = customers_controller.delete_access_token(customer_id, token_id, idempotency_key)Creates a new address for a customer
def create_address(self,
customer_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer Id |
| request | Required |
Request for creating an address |
| idempotencyKey | Optional |
TODO: Add a parameter description |
customer_id = 'customer_id'
request = CreateAddressRequest()
idempotency_key = 'idempotency-key'
result = customers_controller.create_address(customer_id, request, idempotency_key)Get a customer's card
def get_card(self,
customer_id,
card_id)| Parameter | Tags | Description |
|---|---|---|
| customerId | Required |
Customer id |
| cardId | Required |
Card id |
customer_id = 'customer_id'
card_id = 'card_id'
result = customers_controller.get_card(customer_id, card_id)An instance of the ChargesController class can be accessed from the API Client.
charges_controller = client.chargesGet a charge from its id
def get_charge(self,
charge_id)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
charge_id = 'charge_id'
result = charges_controller.get_charge(charge_id)TODO: Add a method description
def confirm_payment(self,
charge_id,
request=None,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
TODO: Add a parameter description |
| request | Optional |
Request for confirm payment |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = CreateConfirmPaymentRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.confirm_payment(charge_id, request, idempotency_key)Updates the card from a charge
def update_charge_card(self,
charge_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
| request | Required |
Request for updating a charge's card |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = UpdateChargeCardRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.update_charge_card(charge_id, request, idempotency_key)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)| 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 |
page = 4
size = 4
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)Cancel a charge
def cancel_charge(self,
charge_id,
request=None,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
| request | Optional |
Request for cancelling a charge |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = CreateCancelChargeRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.cancel_charge(charge_id, request, idempotency_key)Retries a charge
def retry_charge(self,
charge_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
idempotency_key = 'idempotency-key'
result = charges_controller.retry_charge(charge_id, idempotency_key)Updates a charge's payment method
def update_charge_payment_method(self,
charge_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
| request | Required |
Request for updating the payment method from a charge |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = UpdateChargePaymentMethodRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.update_charge_payment_method(charge_id, request, idempotency_key)Updates the metadata from a charge
def update_charge_metadata(self,
charge_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
The charge id |
| request | Required |
Request for updating the charge metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.update_charge_metadata(charge_id, request, idempotency_key)Captures a charge
def capture_charge(self,
charge_id,
request=None,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge id |
| request | Optional |
Request for capturing a charge |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = CreateCaptureChargeRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.capture_charge(charge_id, request, idempotency_key)Updates the due date from a charge
def update_charge_due_date(self,
charge_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge Id |
| request | Required |
Request for updating the due date |
| idempotencyKey | Optional |
TODO: Add a parameter description |
charge_id = 'charge_id'
request = UpdateChargeDueDateRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.update_charge_due_date(charge_id, request, idempotency_key)Creates a new charge
def create_charge(self,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| request | Required |
Request for creating a charge |
| idempotencyKey | Optional |
TODO: Add a parameter description |
request = CreateChargeRequest()
idempotency_key = 'idempotency-key'
result = charges_controller.create_charge(request, idempotency_key)TODO: Add a method description
def get_charge_transactions(self,
charge_id,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| chargeId | Required |
Charge Id |
| page | Optional |
Page number |
| size | Optional |
Page size |
charge_id = 'charge_id'
page = 4
size = 4
result = charges_controller.get_charge_transactions(charge_id, page, size)TODO: Add a method description
def get_charges_summary(self,
status,
created_since=None,
created_until=None)| Parameter | Tags | Description |
|---|---|---|
| status | Required |
TODO: Add a parameter description |
| createdSince | Optional |
TODO: Add a parameter description |
| createdUntil | Optional |
TODO: Add a parameter description |
status = 'status'
created_since = datetime.now()
created_until = datetime.now()
result = charges_controller.get_charges_summary(status, created_since, created_until)An instance of the RecipientsController class can be accessed from the API Client.
recipients_controller = client.recipientsUpdates recipient metadata
def update_recipient_metadata(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| request | Required |
Metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.update_recipient_metadata(recipient_id, request, idempotency_key)TODO: Add a method description
def update_recipient_transfer_settings(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient Identificator |
| request | Required |
TODO: Add a parameter description |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = UpdateTransferSettingsRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.update_recipient_transfer_settings(recipient_id, request, idempotency_key)Gets an anticipation
def get_anticipation(self,
recipient_id,
anticipation_id)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| anticipationId | Required |
Anticipation id |
recipient_id = 'recipient_id'
anticipation_id = 'anticipation_id'
result = recipients_controller.get_anticipation(recipient_id, anticipation_id)Retrieves paginated recipients information
def get_recipients(self,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| page | Optional |
Page number |
| size | Optional |
Page size |
page = 4
size = 4
result = recipients_controller.get_recipients(page, size)Get balance information for a recipient
def get_balance(self,
recipient_id)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
recipient_id = 'recipient_id'
result = recipients_controller.get_balance(recipient_id)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)| 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 |
recipient_id = 'recipient_id'
page = 4
size = 4
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)Creates an anticipation
def create_anticipation(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| request | Required |
Anticipation data |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = CreateAnticipationRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.create_anticipation(recipient_id, request, idempotency_key)Updates the default bank account from a recipient
def update_recipient_default_bank_account(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| request | Required |
Bank account data |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = UpdateRecipientBankAccountRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.update_recipient_default_bank_account(recipient_id, request, idempotency_key)Retrieves recipient information
def get_recipient(self,
recipient_id)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipiend id |
recipient_id = 'recipient_id'
result = recipients_controller.get_recipient(recipient_id)Gets a transfer
def get_transfer(self,
recipient_id,
transfer_id)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| transferId | Required |
Transfer id |
recipient_id = 'recipient_id'
transfer_id = 'transfer_id'
result = recipients_controller.get_transfer(recipient_id, transfer_id)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)| 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 |
recipient_id = 'recipient_id'
page = 4
size = 4
status = 'status'
created_since = datetime.now()
created_until = datetime.now()
result = recipients_controller.get_transfers(recipient_id, page, size, status, created_since, created_until)Updates a recipient
def update_recipient(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| request | Required |
Recipient data |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = UpdateRecipientRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.update_recipient(recipient_id, request, idempotency_key)Creates a new recipient
def create_recipient(self,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| request | Required |
Recipient data |
| idempotencyKey | Optional |
TODO: Add a parameter description |
request = CreateRecipientRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.create_recipient(request, idempotency_key)Creates a transfer for a recipient
def create_transfer(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient Id |
| request | Required |
Transfer data |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = CreateTransferRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.create_transfer(recipient_id, request, idempotency_key)Gets the anticipation limits for a recipient
def get_anticipation_limits(self,
recipient_id,
timeframe,
payment_date)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| timeframe | Required |
Timeframe |
| paymentDate | Required |
Anticipation payment date |
recipient_id = 'recipient_id'
timeframe = 'timeframe'
payment_date = datetime.now()
result = recipients_controller.get_anticipation_limits(recipient_id, timeframe, payment_date)TODO: Add a method description
def create_withdraw(self,
recipient_id,
request)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
TODO: Add a parameter description |
| request | Required |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = CreateWithdrawRequest()
result = recipients_controller.create_withdraw(recipient_id, request)TODO: Add a method description
def get_withdraw_by_id(self,
recipient_id,
withdrawal_id)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
TODO: Add a parameter description |
| withdrawalId | Required |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
withdrawal_id = 'withdrawal_id'
result = recipients_controller.get_withdraw_by_id(recipient_id, withdrawal_id)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)| 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 |
recipient_id = 'recipient_id'
page = 4
size = 4
status = 'status'
created_since = datetime.now()
created_until = datetime.now()
result = recipients_controller.get_withdrawals(recipient_id, page, size, status, created_since, created_until)Updates recipient metadata
def update_automatic_anticipation_settings(self,
recipient_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| recipientId | Required |
Recipient id |
| request | Required |
Metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
recipient_id = 'recipient_id'
request = UpdateAutomaticAnticipationSettingsRequest()
idempotency_key = 'idempotency-key'
result = recipients_controller.update_automatic_anticipation_settings(recipient_id, request, idempotency_key)Retrieves recipient information
def get_recipient_by_code(self,
code)| Parameter | Tags | Description |
|---|---|---|
| code | Required |
Recipient code |
code = 'code'
result = recipients_controller.get_recipient_by_code(code)An instance of the SubscriptionsController class can be accessed from the API Client.
subscriptions_controller = client.subscriptionsCreates a discount
def create_discount(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Required |
Request for creating a discount |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = CreateDiscountRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_discount(subscription_id, request, idempotency_key)Get Subscription Item
def get_subscription_item(self,
subscription_id,
item_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| itemId | Required |
Item id |
subscription_id = 'subscription_id'
item_id = 'item_id'
result = subscriptions_controller.get_subscription_item(subscription_id, item_id)Deletes a usage
def delete_usage(self,
subscription_id,
item_id,
usage_id,
idempotency_key=None)| 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 |
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)Cancels a subscription
def cancel_subscription(self,
subscription_id,
request=None,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Optional |
Request for cancelling a subscription |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = CreateCancelSubscriptionRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.cancel_subscription(subscription_id, request, idempotency_key)Deletes a increment
def delete_increment(self,
subscription_id,
increment_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| incrementId | Required |
Increment id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
increment_id = 'increment_id'
idempotency_key = 'idempotency-key'
result = subscriptions_controller.delete_increment(subscription_id, increment_id, idempotency_key)TODO: Add a method description
def get_subscription_cycle_by_id(self,
subscription_id,
cycle_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| cycleId | Required |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
cycle_id = 'cycleId'
result = subscriptions_controller.get_subscription_cycle_by_id(subscription_id, cycle_id)Updates the start at date from a subscription
def update_subscription_start_at(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| request | Required |
Request for updating the subscription start date |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionStartAtRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_start_at(subscription_id, request, idempotency_key)Updates the payment method from a subscription
def update_subscription_payment_method(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Required |
Request for updating the paymentmethod from a subscription |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionPaymentMethodRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_payment_method(subscription_id, request, idempotency_key)TODO: Add a method description
def update_current_cycle_status(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| request | Required |
Request for updating the end date of the subscription current status |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateCurrentCycleStatusRequest()
idempotency_key = 'idempotency-key'
subscriptions_controller.update_current_cycle_status(subscription_id, request, idempotency_key)Creates a new subscription
def create_subscription(self,
body,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| body | Required |
Request for creating a subscription |
| idempotencyKey | Optional |
TODO: Add a parameter description |
body = CreateSubscriptionRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_subscription(body, idempotency_key)TODO: Add a method description
def get_usages_details(self,
subscription_id,
cycle_id=None,
size=None,
page=None,
item_id=None,
group=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Identifier |
| cycleId | Optional |
Cycle id |
| size | Optional |
Page size |
| page | Optional |
Page number |
| itemId | Optional |
Identificador do item |
| group | Optional |
identificador da loja (account) de cada item |
subscription_id = 'subscription_id'
cycle_id = 'cycle_id'
size = 217
page = 217
item_id = 'item_id'
group = 'group'
result = subscriptions_controller.get_usages_details(subscription_id, cycle_id, size, page, item_id, group)TODO: Add a method description
def renew_subscription(self,
subscription_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
TODO: Add a parameter description |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
idempotency_key = 'idempotency-key'
result = subscriptions_controller.renew_subscription(subscription_id, idempotency_key)Updates a subscription item
def update_subscription_item(self,
subscription_id,
item_id,
body,
idempotency_key=None)| 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 |
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)Create Usage
def create_an_usage(self,
subscription_id,
item_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| itemId | Required |
Item id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
item_id = 'item_id'
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_an_usage(subscription_id, item_id, idempotency_key)TODO: Add a method description
def get_increment_by_id(self,
subscription_id,
increment_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription Id |
| incrementId | Required |
The increment Id |
subscription_id = 'subscription_id'
increment_id = 'increment_id'
result = subscriptions_controller.get_increment_by_id(subscription_id, increment_id)Deletes a discount
def delete_discount(self,
subscription_id,
discount_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| discountId | Required |
Discount Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
discount_id = 'discount_id'
idempotency_key = 'idempotency-key'
result = subscriptions_controller.delete_discount(subscription_id, discount_id, idempotency_key)TODO: Add a method description
def get_increments(self,
subscription_id,
page=None,
size=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| page | Optional |
Page number |
| size | Optional |
Page size |
subscription_id = 'subscription_id'
page = 217
size = 217
result = subscriptions_controller.get_increments(subscription_id, page, size)Creates a usage
def create_usage(self,
subscription_id,
item_id,
body,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| itemId | Required |
Item id |
| body | Required |
Request for creating a usage |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
item_id = 'item_id'
body = CreateUsageRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_usage(subscription_id, item_id, body, idempotency_key)Creates a new Subscription item
def create_subscription_item(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Required |
Request for creating a subscription item |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = CreateSubscriptionItemRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_subscription_item(subscription_id, request, idempotency_key)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)| 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 |
subscription_id = 'subscription_id'
item_id = 'item_id'
page = 217
size = 217
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)Updates the billing date from a subscription
def update_subscription_billing_date(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| request | Required |
Request for updating the subscription billing date |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionBillingDateRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_billing_date(subscription_id, request, idempotency_key)TODO: Add a method description
def update_latest_period_end_at(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
TODO: Add a parameter description |
| request | Required |
Request for updating the end date of the current signature cycle |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateCurrentCycleEndDateRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_latest_period_end_at(subscription_id, request, idempotency_key)TODO: Add a method description
def get_subscription_cycles(self,
subscription_id,
page,
size)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| page | Required |
Page number |
| size | Required |
Page size |
subscription_id = 'subscription_id'
page = 'page'
size = 'size'
result = subscriptions_controller.get_subscription_cycles(subscription_id, page, size)Gets a subscription
def get_subscription(self,
subscription_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
subscription_id = 'subscription_id'
result = subscriptions_controller.get_subscription(subscription_id)TODO: Add a method description
def update_subscription_affiliation_id(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
TODO: Add a parameter description |
| request | Required |
Request for updating a subscription affiliation id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionAffiliationIdRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_affiliation_id(subscription_id, request, idempotency_key)Deletes a subscription item
def delete_subscription_item(self,
subscription_id,
subscription_item_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| subscriptionItemId | Required |
Subscription item id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
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)Updates the credit card from a subscription
def update_subscription_card(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Required |
Request for updating a card |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionCardRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_card(subscription_id, request, idempotency_key)Updates the metadata from a subscription
def update_subscription_metadata(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| request | Required |
Request for updating the subscrption metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_metadata(subscription_id, request, idempotency_key)Updates the boleto due days from a subscription
def update_subscription_due_days(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| request | Required |
TODO: Add a parameter description |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionDueDaysRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_due_days(subscription_id, request, idempotency_key)TODO: Add a method description
def get_discounts(self,
subscription_id,
page,
size)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| page | Required |
Page number |
| size | Required |
Page size |
subscription_id = 'subscription_id'
page = 217
size = 217
result = subscriptions_controller.get_discounts(subscription_id, page, size)Creates a increment
def create_increment(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription id |
| request | Required |
Request for creating a increment |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = CreateIncrementRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.create_increment(subscription_id, request, idempotency_key)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)| 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 |
page = 217
size = 217
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)TODO: Add a method description
def get_discount_by_id(self,
subscription_id,
discount_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription id |
| discountId | Required |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
discount_id = 'discountId'
result = subscriptions_controller.get_discount_by_id(subscription_id, discount_id)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)| 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 |
subscription_id = 'subscription_id'
page = 217
size = 217
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)Atualização do valor mĂnimo da assinatura
def update_subscription_minium_price(self,
subscription_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| request | Required |
Request da requisição com o valor mĂnimo que será configurado |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
request = UpdateSubscriptionMinimumPriceRequest()
idempotency_key = 'idempotency-key'
result = subscriptions_controller.update_subscription_minium_price(subscription_id, request, idempotency_key)TODO: Add a method description
def get_usage_report(self,
subscription_id,
period_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
The subscription Id |
| periodId | Required |
The period Id |
subscription_id = 'subscription_id'
period_id = 'period_id'
result = subscriptions_controller.get_usage_report(subscription_id, period_id)TODO: Add a method description
def update_split_subscription(self,
id,
request)| Parameter | Tags | Description |
|---|---|---|
| id | Required |
Subscription's id |
| request | Required |
TODO: Add a parameter description |
id = 'id'
request = UpdateSubscriptionSplitRequest()
result = subscriptions_controller.update_split_subscription(id, request)An instance of the InvoicesController class can be accessed from the API Client.
invoices_controller = client.invoicesCreate an Invoice
def create_invoice(self,
subscription_id,
cycle_id,
request=None,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
| cycleId | Required |
Cycle Id |
| request | Optional |
TODO: Add a parameter description |
| idempotencyKey | Optional |
TODO: Add a parameter description |
subscription_id = 'subscription_id'
cycle_id = 'cycle_id'
request = CreateInvoiceRequest()
idempotency_key = 'idempotency-key'
result = invoices_controller.create_invoice(subscription_id, cycle_id, request, idempotency_key)TODO: Add a method description
def get_partial_invoice(self,
subscription_id)| Parameter | Tags | Description |
|---|---|---|
| subscriptionId | Required |
Subscription Id |
subscription_id = 'subscription_id'
result = invoices_controller.get_partial_invoice(subscription_id)Updates the status from an invoice
def update_invoice_status(self,
invoice_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| invoiceId | Required |
Invoice Id |
| request | Required |
Request for updating an invoice's status |
| idempotencyKey | Optional |
TODO: Add a parameter description |
invoice_id = 'invoice_id'
request = UpdateInvoiceStatusRequest()
idempotency_key = 'idempotency-key'
result = invoices_controller.update_invoice_status(invoice_id, request, idempotency_key)Gets an invoice
def get_invoice(self,
invoice_id)| Parameter | Tags | Description |
|---|---|---|
| invoiceId | Required |
Invoice Id |
invoice_id = 'invoice_id'
result = invoices_controller.get_invoice(invoice_id)Updates the metadata from an invoice
def update_invoice_metadata(self,
invoice_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| invoiceId | Required |
The invoice id |
| request | Required |
Request for updating the invoice metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
invoice_id = 'invoice_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = invoices_controller.update_invoice_metadata(invoice_id, request, idempotency_key)Cancels an invoice
def cancel_invoice(self,
invoice_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| invoiceId | Required |
Invoice id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
invoice_id = 'invoice_id'
idempotency_key = 'idempotency-key'
result = invoices_controller.cancel_invoice(invoice_id, idempotency_key)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)| Parameter | Tags | Description |
|---|---|---|
| page | Optional |
Page number |
| size | Optional |
Page size |
| code | Optional |
Filter for Invoice's code |
| customerId | Optional |
Filter for Invoice's customer id |
| subscriptionId | Optional |
Filter for Invoice's subscription id |
| createdSince | Optional |
Filter for Invoice's creation date start range |
| createdUntil | Optional |
Filter for Invoices creation date end range |
| status | Optional |
Filter for Invoice's status |
| dueSince | Optional |
Filter for Invoice's due date start range |
| dueUntil | Optional |
Filter for Invoice's due date end range |
| customerDocument | Optional |
Fillter for invoice's document |
page = 53
size = 53
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)An instance of the OrdersController class can be accessed from the API Client.
orders_controller = client.ordersTODO: Add a method description
def update_order_status(self,
id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| id | Required |
Order Id |
| request | Required |
Update Order Model |
| idempotencyKey | Optional |
TODO: Add a parameter description |
id = 'id'
request = UpdateOrderStatusRequest()
idempotency_key = 'idempotency-key'
result = orders_controller.update_order_status(id, request, idempotency_key)TODO: Add a method description
def delete_all_order_items(self,
order_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
order_id = 'orderId'
idempotency_key = 'idempotency-key'
result = orders_controller.delete_all_order_items(order_id, idempotency_key)Updates the metadata from an order
def update_order_metadata(self,
order_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
The order id |
| request | Required |
Request for updating the order metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
order_id = 'order_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = orders_controller.update_order_metadata(order_id, request, idempotency_key)Gets all orders
def get_orders(self,
page=None,
size=None,
code=None,
status=None,
created_since=None,
created_until=None,
customer_id=None)| 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 |
page = 53
size = 53
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)TODO: Add a method description
def create_order_item(self,
order_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order Id |
| request | Required |
Order Item Model |
| idempotencyKey | Optional |
TODO: Add a parameter description |
order_id = 'orderId'
request = CreateOrderItemRequest()
idempotency_key = 'idempotency-key'
result = orders_controller.create_order_item(order_id, request, idempotency_key)TODO: Add a method description
def delete_order_item(self,
order_id,
item_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order Id |
| itemId | Required |
Item Id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
order_id = 'orderId'
item_id = 'itemId'
idempotency_key = 'idempotency-key'
result = orders_controller.delete_order_item(order_id, item_id, idempotency_key)Gets an order
def get_order(self,
order_id)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order id |
order_id = 'order_id'
result = orders_controller.get_order(order_id)Creates a new Order
def create_order(self,
body,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| body | Required |
Request for creating an order |
| idempotencyKey | Optional |
TODO: Add a parameter description |
body = CreateOrderRequest()
idempotency_key = 'idempotency-key'
result = orders_controller.create_order(body, idempotency_key)TODO: Add a method description
def get_order_item(self,
order_id,
item_id)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order Id |
| itemId | Required |
Item Id |
order_id = 'orderId'
item_id = 'itemId'
result = orders_controller.get_order_item(order_id, item_id)TODO: Add a method description
def update_order_item(self,
order_id,
item_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| orderId | Required |
Order Id |
| itemId | Required |
Item Id |
| request | Required |
Item Model |
| idempotencyKey | Optional |
TODO: Add a parameter description |
order_id = 'orderId'
item_id = 'itemId'
request = UpdateOrderItemRequest()
idempotency_key = 'idempotency-key'
result = orders_controller.update_order_item(order_id, item_id, request, idempotency_key)An instance of the TokensController class can be accessed from the API Client.
tokens_controller = client.tokensTags:
Skips Authentication
TODO: Add a method description
def create_token(self,
public_key,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| publicKey | Required |
Public key |
| request | Required |
Request for creating a token |
| idempotencyKey | Optional |
TODO: Add a parameter description |
public_key = 'public_key'
request = CreateTokenRequest()
idempotency_key = 'idempotency-key'
result = tokens_controller.create_token(public_key, request, idempotency_key)Tags:
Skips Authentication
Gets a token from its id
def get_token(self,
id,
public_key)| Parameter | Tags | Description |
|---|---|---|
| id | Required |
Token id |
| publicKey | Required |
Public key |
id = 'id'
public_key = 'public_key'
result = tokens_controller.get_token(id, public_key)An instance of the PlansController class can be accessed from the API Client.
plans_controller = client.plansUpdates a plan item
def update_plan_item(self,
plan_id,
plan_item_id,
body,
idempotency_key=None)| 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 |
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)Adds a new item to a plan
def create_plan_item(self,
plan_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
| request | Required |
Request for creating a plan item |
| idempotencyKey | Optional |
TODO: Add a parameter description |
plan_id = 'plan_id'
request = CreatePlanItemRequest()
idempotency_key = 'idempotency-key'
result = plans_controller.create_plan_item(plan_id, request, idempotency_key)Gets all plans
def get_plans(self,
page=None,
size=None,
name=None,
status=None,
billing_type=None,
created_since=None,
created_until=None)| 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 |
page = 53
size = 53
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)Gets a plan
def get_plan(self,
plan_id)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
plan_id = 'plan_id'
result = plans_controller.get_plan(plan_id)Updates a plan
def update_plan(self,
plan_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
| request | Required |
Request for updating a plan |
| idempotencyKey | Optional |
TODO: Add a parameter description |
plan_id = 'plan_id'
request = UpdatePlanRequest()
idempotency_key = 'idempotency-key'
result = plans_controller.update_plan(plan_id, request, idempotency_key)Updates the metadata from a plan
def update_plan_metadata(self,
plan_id,
request,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
The plan id |
| request | Required |
Request for updating the plan metadata |
| idempotencyKey | Optional |
TODO: Add a parameter description |
plan_id = 'plan_id'
request = UpdateMetadataRequest()
idempotency_key = 'idempotency-key'
result = plans_controller.update_plan_metadata(plan_id, request, idempotency_key)Creates a new plan
def create_plan(self,
body,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| body | Required |
Request for creating a plan |
| idempotencyKey | Optional |
TODO: Add a parameter description |
body = CreatePlanRequest()
idempotency_key = 'idempotency-key'
result = plans_controller.create_plan(body, idempotency_key)Removes an item from a plan
def delete_plan_item(self,
plan_id,
plan_item_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
| planItemId | Required |
Plan item id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
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)Gets a plan item
def get_plan_item(self,
plan_id,
plan_item_id)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
| planItemId | Required |
Plan item id |
plan_id = 'plan_id'
plan_item_id = 'plan_item_id'
result = plans_controller.get_plan_item(plan_id, plan_item_id)Deletes a plan
def delete_plan(self,
plan_id,
idempotency_key=None)| Parameter | Tags | Description |
|---|---|---|
| planId | Required |
Plan id |
| idempotencyKey | Optional |
TODO: Add a parameter description |
plan_id = 'plan_id'
idempotency_key = 'idempotency-key'
result = plans_controller.delete_plan(plan_id, idempotency_key)An instance of the TransactionsController class can be accessed from the API Client.
transactions_controller = client.transactionsTODO: Add a method description
def get_transaction(self,
transaction_id)| Parameter | Tags | Description |
|---|---|---|
| transactionId | Required |
TODO: Add a parameter description |
transaction_id = 'transaction_id'
result = transactions_controller.get_transaction(transaction_id)An instance of the TransfersController class can be accessed from the API Client.
transfers_controller = client.transfersTODO: Add a method description
def create_transfer(self,
request)| Parameter | Tags | Description |
|---|---|---|
| request | Required |
TODO: Add a parameter description |
request = CreateTransfer()
result = transfers_controller.create_transfer(request)TODO: Add a method description
def get_transfer_by_id(self,
transfer_id)| Parameter | Tags | Description |
|---|---|---|
| transferId | Required |
TODO: Add a parameter description |
transfer_id = 'transfer_id'
result = transfers_controller.get_transfer_by_id(transfer_id)Gets all transfers
def get_transfers(self)result = transfers_controller.get_transfers()