Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 2.87 KB

BalancesApi.md

File metadata and controls

89 lines (60 loc) · 2.87 KB
Raw

conekta.BalancesApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
get_balance GET /balance Get a company's balance

get_balance

BalanceResponse get_balance(accept_language=accept_language)

Get a company's balance

Get a company's balance

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.balance_response import BalanceResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.BalancesApi(api_client)
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)

    try:
        # Get a company's balance
        api_response = api_instance.get_balance(accept_language=accept_language)
        print("The response of BalancesApi->get_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BalancesApi->get_balance: %s\n" % e)

Parameters

Name Type Description Notes
accept_language str Use for knowing which language to use [optional] [default to es]

Return type

BalanceResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful * Date - The date and time that the response was sent
* Content-Type - The format of the response body
* Content-Length - The length of the response body in bytes
* Connection - The type of connection used to transfer the response
* Conekta-Media-Type -
401 authentication error -
500 internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]