openapi-client

Rvvup Public API

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

• API version: 2024-03-01
• Package version: 1.0.0
• Generator version: 7.7.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://rvvup.com

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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importopenapi_client

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:

importopenapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importopenapi_clientfromopenapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=openapi_client.Configuration(
host="http://localhost"
)
# 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 (JWT): apiKeyconfiguration=openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithopenapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=openapi_client.CheckoutTemplatesApi(api_client)
merchant_id='merchant_id_example'# str | merchant idcheckout_template_create_input=openapi_client.CheckoutTemplateCreateInput() # CheckoutTemplateCreateInput | The checkout template to createtry:
# Create new checkout templateapi_response=api_instance.create_checkout_template(merchant_id, checkout_template_create_input)
print("The response of CheckoutTemplatesApi->create_checkout_template:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling CheckoutTemplatesApi->create_checkout_template: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CheckoutTemplatesApi	create_checkout_template	POST /api/2024-03-01/{merchantId}/checkout-templates	Create new checkout template
CheckoutTemplatesApi	get_checkout_template	GET /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId}	Get a checkout template
CheckoutTemplatesApi	list_checkout_templates	GET /api/2024-03-01/{merchantId}/checkout-templates	List checkout templates
CheckoutTemplatesApi	update_checkout_template	PATCH /api/2024-03-01/{merchantId}/checkout-templates/{checkoutTemplateId}	Update a checkout template
CheckoutsApi	create_checkout	POST /api/2024-03-01/{merchantId}/checkouts	Create new checkout
CheckoutsApi	get_checkout	GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}	Get a checkout
CheckoutsApi	list_checkout_payment_methods	GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-methods	Get payment methods for a checkout
CheckoutsApi	list_checkouts	GET /api/2024-03-01/{merchantId}/checkouts	List checkouts
PaymentLinksApi	create_payment_link	POST /api/2024-03-01/{merchantId}/payment-links	Create new payment link
PaymentLinksApi	deactivate_payment_link	DELETE /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId}	Deactivate a payment link
PaymentLinksApi	get_payment_link	GET /api/2024-03-01/{merchantId}/payment-links/{paymentLinkId}	Get a payment link
PaymentLinksApi	list_payment_links	GET /api/2024-03-01/{merchantId}/payment-links	List payment links
PaymentSessionsApi	create_payment_session	POST /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions	Create a payment session
PaymentSessionsApi	get_payment_session	GET /api/2024-03-01/{merchantId}/checkouts/{checkoutId}/payment-sessions/{paymentSessionId}	Get a payment session
StatementExportsApi	export_statement	POST /api/2024-03-01/{merchantId}/statements/export	Export a statement
WebhooksApi	create_webhook	POST /api/2024-03-01/{merchantId}/webhooks	Create a new webhook
WebhooksApi	get_webhook	GET /api/2024-03-01/{merchantId}/webhooks/{webhookId}	Get a webhook by id
WebhooksApi	list_webhooks	GET /api/2024-03-01/{merchantId}/webhooks	Get all webhook
WebhooksApi	update_webhook	PATCH /api/2024-03-01/{merchantId}/webhooks/{webhookId}	Update a webhook

Documentation For Models

• Address
• AddressInput
• ApplicationSource
• Checkout
• CheckoutAmountType
• CheckoutApplePaySettings
• CheckoutApplePaySettingsInput
• CheckoutApplePaySettingsUpdateInput
• CheckoutCardSettings
• CheckoutCardSettingsInput
• CheckoutCardSettingsUpdateInput
• CheckoutCreateInput
• CheckoutCustomerFieldType
• CheckoutCustomerFields
• CheckoutCustomerFieldsInput
• CheckoutCustomerFieldsUpdateInput
• CheckoutPage
• CheckoutPayByBankSettings
• CheckoutPayByBankSettingsInput
• CheckoutPayByBankSettingsUpdateInput
• CheckoutPaymentMethodSettings
• CheckoutPaymentMethodSettingsInput
• CheckoutPaymentMethodSettingsUpdateInput
• CheckoutStatus
• CheckoutTemplate
• CheckoutTemplateCreateInput
• CheckoutTemplatePage
• CheckoutTemplateUpdateInput
• Customer
• CustomerInput
• Item
• ItemInput
• ItemRestriction
• Money
• MoneyInput
• PageCheckout
• PageCheckoutTemplate
• PagePaymentLink
• PagePaymentMethodDetail
• PageWebhook
• Pageable
• Payment
• PaymentAction
• PaymentActionMethod
• PaymentActionType
• PaymentCaptureType
• PaymentDeclineReason
• PaymentLink
• PaymentLinkCreateInput
• PaymentLinkPage
• PaymentLinkStatus
• PaymentMethod
• PaymentMethodAsset
• PaymentMethodAssetType
• PaymentMethodDetail
• PaymentMethodDetailsPage
• PaymentMethodLimit
• PaymentMethodSettings
• PaymentMethodStatus
• PaymentMethodTotalLimit
• PaymentSession
• PaymentSessionCreateInput
• PaymentSessionStatus
• PaymentSettlementStatus
• PaymentStatus
• PaymentSummary
• PaymentVoidReason
• StartEnd
• StatementExportRequest
• Webhook
• WebhookCreateInput
• WebhookEventType
• WebhookPage
• WebhookStatus
• WebhookUpdateInput

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

• Type: Bearer authentication (JWT)

Author

info@rvvup.com