Skip to main content

Synctera API Client generated by openapi-generator

Project description

synctera-client-v1

Let's build something great.

Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.

We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.41.1
  • Package version: 1.41.1
  • Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/SwadeshInc/synctera-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/SwadeshInc/synctera-client.git)

Then import the package:

import synctera_client_v1

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import synctera_client_v1

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import synctera_client_v1
from synctera_client_v1.rest import ApiException
from pprint import pprint

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

# 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 (api_key): bearerAuth
configuration = synctera_client_v1.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with synctera_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = synctera_client_v1.ApplicationsBetaApi(api_client)
    application = synctera_client_v1.Application() # Application | Application model.

    try:
        # Create an application
        api_response = api_instance.create_application(application)
        print("The response of ApplicationsBetaApi->create_application:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplicationsBetaApi->create_application: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.synctera.com/v1

Class Method HTTP request Description
ApplicationsBetaApi create_application POST /applications Create an application
ApplicationsBetaApi get_application GET /applications/{application_id} Get an application
ApplicationsBetaApi list_applications GET /applications List applications
ApplicationsBetaApi patch_application PATCH /applications/{application_id} Modify an application
CardTransactionSimulationsBetaApi simulate_authorization POST /cards/transaction_simulations/authorization Simulate authorization
CardTransactionSimulationsBetaApi simulate_authorization_advice POST /cards/transaction_simulations/authorization/advice Simulate authorization advice
CardTransactionSimulationsBetaApi simulate_balance_inquiry POST /cards/transaction_simulations/financial/balance_inquiry Simulate balance inquiry
CardTransactionSimulationsBetaApi simulate_clearing POST /cards/transaction_simulations/clearing Simulate clearing or refund
CardTransactionSimulationsBetaApi simulate_financial POST /cards/transaction_simulations/financial Simulate financial
CardTransactionSimulationsBetaApi simulate_financial_advice POST /cards/transaction_simulations/financial/advice Simulate financial advice
CardTransactionSimulationsBetaApi simulate_original_credit POST /cards/transaction_simulations/financial/original_credit Simulate OCT
CardTransactionSimulationsBetaApi simulate_reversal POST /cards/transaction_simulations/reversal Simulate reversal
CardTransactionSimulationsBetaApi simulate_withdrawal POST /cards/transaction_simulations/financial/withdrawal Simulate ATM withdrawal
CardWebhookSimulationsBetaApi simulate_card_fulfillment_event POST /cards/{card_id}/webhook_simulations/fulfillment Simulate Card Fulfillment Event
CardsBetaApi activate_card POST /cards/activate Activate a card
CardsBetaApi create_card_image POST /cards/images Create Card Image
CardsBetaApi create_gateway POST /cards/gateways Create Gateway
CardsBetaApi get_card GET /cards/{card_id} Get Card
CardsBetaApi get_card_barcode GET /cards/{card_id}/barcodes Get Card Barcode
CardsBetaApi get_card_image_data GET /cards/images/{card_image_id}/data Get Card Image Data
CardsBetaApi get_card_image_details GET /cards/images/{card_image_id} Get Card Image Details
CardsBetaApi get_card_widget_url GET /cards/card_widget_url Get card widget URL
CardsBetaApi get_client_access_token POST /cards/{card_id}/client_token Get a client token
CardsBetaApi get_gateway GET /cards/gateways/{gateway_id} Get Gateway
CardsBetaApi issue_card POST /cards Issue a Card
CardsBetaApi list_card_image_details GET /cards/images List Card Image Details
CardsBetaApi list_card_products GET /cards/products List Card Products
CardsBetaApi list_cards GET /cards List Cards
CardsBetaApi list_changes GET /cards/{card_id}/changes List Card Changes
CardsBetaApi list_gateways GET /cards/gateways List Gateways
CardsBetaApi update_card PATCH /cards/{card_id} Update Card
CardsBetaApi update_card_image_details PATCH /cards/images/{card_image_id} Update Card Image Details
CardsBetaApi update_gateway PATCH /cards/gateways/{gateway_id} Update Gateway
CardsBetaApi upload_card_image_data POST /cards/images/{card_image_id}/data Upload Card Image
DigitalWalletTokensBetaApi create_digital_wallet_apple POST /cards/{card_id}/digital_wallet_tokens/applepay Create digital wallet token provision request for Apple Pay
DigitalWalletTokensBetaApi create_digital_wallet_google POST /cards/{card_id}/digital_wallet_tokens/googlepay Create digital wallet token provision request for Google Pay
DigitalWalletTokensBetaApi get_digital_wallet_token GET /cards/digital_wallet_tokens/{digital_wallet_token_id} Get Digital Wallet Token
DigitalWalletTokensBetaApi list_digital_wallet_tokens GET /cards/digital_wallet_tokens List Digital Wallet Tokens
DigitalWalletTokensBetaApi update_digital_wallet_token_status PATCH /cards/digital_wallet_tokens/{digital_wallet_token_id} Update Digital Wallet Token's life cycle status
ExternalCardsBetaApi create_external_card_from_token POST /external_cards/tokens Create External Card from token
ExternalCardsBetaApi create_external_card_transfer POST /external_cards/transfers Create External Card Transfer
ExternalCardsBetaApi create_external_card_transfer_reversal POST /external_cards/transfers/{transfer_id}/reversals Create External Card Transfer Reversal
ExternalCardsBetaApi delete_external_card DELETE /external_cards/{external_card_id} Delete External Card
ExternalCardsBetaApi get_external_card GET /external_cards/{external_card_id} Get External Card
ExternalCardsBetaApi get_external_card_transfer GET /external_cards/transfers/{transfer_id} Get External Card Transfer
ExternalCardsBetaApi list_external_card_transfers GET /external_cards/transfers List External Transfers
ExternalCardsBetaApi list_external_cards GET /external_cards List External Cards
ExternalCardsBetaApi update_external_card PATCH /external_cards/{external_card_id} Update External Card
SpendControlsBetaApi create_spend_control POST /spend_controls Create Spend Control
SpendControlsBetaApi get_spend_control GET /spend_controls/{spend_control_id} Get Spend Control
SpendControlsBetaApi list_spend_controls GET /spend_controls List Spend Controls
SpendControlsBetaApi update_spend_control PATCH /spend_controls/{spend_control_id} Update Spend Control
StatementsApi get_statement GET /statements/{statement_id} Get a statement
StatementsApi get_statement_transactions GET /statements/{statement_id}/transactions Get a statement's transactions
StatementsApi list_statements GET /statements List statements
TransactionsBetaApi get_transaction_by_id GET /transactions/{id} Get a transaction by ID
TransactionsBetaApi list_transactions GET /transactions List Transactions
WebhooksApi create_webhook POST /webhooks Create a webhook
WebhooksApi delete_webhook DELETE /webhooks/{webhook_id} Delete a webhook
WebhooksApi get_event GET /webhooks/{webhook_id}/events/{event_id} Get webhook event
WebhooksApi get_webhook GET /webhooks/{webhook_id} Get a webhook
WebhooksApi list_events GET /webhooks/{webhook_id}/events List webhook events
WebhooksApi list_webhooks GET /webhooks List webhooks
WebhooksApi resend_event POST /webhooks/{webhook_id}/events/{event_id}/resend Resend an event
WebhooksApi trigger_event POST /webhooks/trigger Trigger an event
WebhooksApi update_webhook PUT /webhooks/{webhook_id} Update a webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (api_key)

Author

dev@swadesh.co

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synctera_client_v1-1.41.1.tar.gz (170.1 kB view hashes)

Uploaded Source

Built Distribution

synctera_client_v1-1.41.1-py3-none-any.whl (534.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page