From 3520924932b22d90e0d5ea3d96dd00f676d20b96 Mon Sep 17 00:00:00 2001
From: kmehta951 <98618440+kmehta951@users.noreply.github.com>
Date: Fri, 29 Sep 2023 16:27:21 -0700
Subject: [PATCH 1/2] Generate 5.0.0
Generate 5.0.0
---
finix/api/authorizations_api.py | 233 +-
finix/api/balance_transfers_api.py | 32 +-
finix/api/compliance_forms_api.py | 162 +-
finix/api/default_api.py | 604 +
finix/api/devices_api.py | 183 +-
finix/api/disputes_api.py | 966 +-
finix/api/fee_profiles_api.py | 20 +-
finix/api/files_api.py | 103 +-
finix/api/identities_api.py | 224 +-
finix/api/instrument_updates_api.py | 29 +-
finix/api/merchant_profiles_api.py | 26 +-
finix/api/merchants_api.py | 120 +-
finix/api/onboarding_forms_api.py | 25 +-
finix/api/payment_instruments_api.py | 230 +-
finix/api/payout_profiles_api.py | 608 +
finix/api/settlements_api.py | 216 +-
finix/api/split_transfers_api.py | 333 +
finix/api/transfers_api.py | 94 +-
finix/api/verifications_api.py | 181 +-
finix/api/webhooks_api.py | 44 +-
finix/api_client.py | 6 +
finix/model/accept_dispute.py | 256 +
finix/model/additional_healthcare_data.py | 262 +
finix/model/additional_purchase_data.py | 50 +-
.../additional_purchase_data_item_data.py | 298 +
.../additional_purchase_data_order_date.py | 3 +
finix/model/application.py | 21 +-
finix/model/application_links.py | 90 +-
.../model/application_links_authorizations.py | 250 +
finix/model/application_profile.py | 8 +-
finix/model/application_profile_links.py | 16 +-
finix/model/application_profiles_list.py | 10 +-
finix/model/associated_identity.py | 8 +-
finix/model/associated_identity_entity.py | 30 +-
finix/model/authorization.py | 56 +-
finix/model/authorization_captured.py | 36 +-
...thorization_captured_external_responses.py | 254 +
finix/model/balance_transfer.py | 8 +-
finix/model/card_present_details_emv_data.py | 12 +-
finix/model/close_settlement.py | 261 +
finix/model/compliance_form.py | 58 +-
finix/model/compliance_form_files.py | 8 +-
finix/model/compliance_form_list.py | 268 +
finix/model/compliance_form_list_embedded.py | 256 +
finix/model/compliance_form_pci_saq_a.py | 24 +-
finix/model/configuration_details.py | 36 -
finix/model/create_application_request.py | 8 +-
.../create_associated_identity_request.py | 8 +-
...eate_associated_identity_request_entity.py | 24 +-
...dentity_request_entity_business_address.py | 14 +-
..._associated_identity_request_entity_dob.py | 8 +-
...dentity_request_entity_personal_address.py | 22 +-
finix/model/create_authorization_request.py | 76 +-
...ization_request3d_secure_authentication.py | 32 +-
.../model/create_balance_transfer_request.py | 8 +-
finix/model/create_device.py | 27 +-
finix/model/create_external_link_request.py | 12 +-
finix/model/create_fee_profile_request.py | 22 +-
finix/model/create_fee_request.py | 18 +-
finix/model/create_file_request.py | 12 +-
finix/model/create_identity_request.py | 8 +-
...ty_request_additional_underwriting_data.py | 9 +-
finix/model/create_identity_request_entity.py | 173 +-
...dentity_request_entity_business_address.py | 302 +
.../create_identity_request_entity_dob.py | 268 +
...ntity_request_entity_incorporation_date.py | 268 +
...dentity_request_entity_personal_address.py | 42 +-
.../create_merchant_underwriting_request.py | 18 +-
.../create_onboarding_form_link_request.py | 32 +-
finix/model/create_onboarding_form_request.py | 24 +-
...arding_form_request_merchant_processors.py | 250 +
...ng_form_request_onboarding_link_details.py | 24 +-
.../create_payment_instrument_request.py | 50 +-
finix/model/create_processor_request.py | 18 +-
finix/model/create_reversal_request.py | 18 +-
...create_reversal_request_split_transfers.py | 254 +
finix/model/create_settlement_request.py | 8 +-
finix/model/create_split_transfer_request.py | 250 +
.../create_subscription_amount_request.py | 8 +-
.../create_subscription_enrollment_request.py | 12 +-
.../create_subscription_schedule_request.py | 8 +-
finix/model/create_transfer_request.py | 105 +-
...ransfer_request3d_secure_authentication.py | 32 +-
...create_transfer_request_split_transfers.py | 258 +
finix/model/create_user_request.py | 12 +-
finix/model/create_verification_request.py | 41 +-
finix/model/create_webhook_request.py | 6 +
finix/model/device.py | 18 +-
finix/model/device_links.py | 16 +-
finix/model/dispute.py | 67 +-
finix/model/dispute_dispute_details.py | 258 +
finix/model/dispute_evidence.py | 24 +-
finix/model/dispute_links.py | 16 +-
finix/model/error401_unauthorized_embedded.py | 12 +-
.../error402_payment_required_embedded.py | 12 +-
.../model/error403_forbidden_list_embedded.py | 12 +-
.../model/error404_not_found_list_embedded.py | 12 +-
.../error422_invalid_field_list_embedded.py | 10 +-
...r422_invalid_field_list_embedded_errors.py | 277 +
...or422_invalid_field_list_embedded_links.py | 256 +
finix/model/external_link.py | 12 +-
finix/model/fee.py | 8 +-
finix/model/fee_profile.py | 46 +-
finix/model/fee_profile_links.py | 22 +-
finix/model/fee_type.py | 8 +-
finix/model/file.py | 12 +-
.../get_device_connection_query_params.py | 250 +
finix/model/identity.py | 8 +-
.../identity_additional_underwriting_data.py | 16 +-
finix/model/identity_entity.py | 18 +-
finix/model/identity_entity_form.py | 15 +-
finix/model/identity_entity_form_dob.py | 8 +-
...identity_entity_form_incorporation_date.py | 10 +-
finix/model/l3_additional_purchase_data.py | 330 +
.../l3_additional_purchase_data_item_data.py | 320 +
.../model/list_authorizations_query_params.py | 28 +-
.../list_balance_transfers_query_params.py | 4 -
finix/model/list_disputes_query_params.py | 108 +-
.../model/list_external_links_query_params.py | 4 -
finix/model/list_fee_profiles_query_params.py | 4 +
finix/model/list_files_query_params.py | 4 -
finix/model/list_identities_query_params.py | 16 +-
.../list_merchant_profiles_query_params.py | 4 +
finix/model/list_merchants_query_params.py | 32 +-
.../list_payment_instruments_query_params.py | 20 +-
.../model/list_payoutprofiles_query_params.py | 254 +
...ttlement_funding_transfers_query_params.py | 12 +-
.../list_settlement_transfers_query_params.py | 8 -
finix/model/list_settlements_query_params.py | 60 +-
.../list_transfer_reversals_query_params.py | 4 +
finix/model/list_transfers_query_params.py | 28 +-
.../model/list_verifications_query_params.py | 4 +
finix/model/merchant.py | 48 +-
finix/model/merchant_profile.py | 30 +-
finix/model/merchant_profile_links.py | 40 +-
finix/model/messages.py | 12 +-
finix/model/onboarding_form.py | 36 +-
.../model/onboarding_form_onboarding_data.py | 40 +-
...rding_data_additional_underwriting_data.py | 344 +
.../onboarding_form_onboarding_data_entity.py | 407 +
...boarding_data_entity_incorporation_date.py | 258 +
...orm_onboarding_data_payment_instruments.py | 283 +
finix/model/operation_key.py | 8 +-
finix/model/payment_instrument.py | 109 +-
finix/model/payment_instrument_links.py | 30 +-
.../model/payment_instrument_links_updates.py | 250 +
finix/model/payment_instrument_token.py | 28 +-
finix/model/payment_instrument_token_links.py | 22 +-
finix/model/payout_profile.py | 305 +
finix/model/payout_profile_gross.py | 262 +
finix/model/payout_profile_gross_fees.py | 276 +
finix/model/payout_profile_gross_payouts.py | 272 +
finix/model/payout_profile_net.py | 272 +
finix/model/payout_profiles_list.py | 268 +
finix/model/payout_profiles_list_embedded.py | 256 +
finix/model/processor.py | 12 +-
finix/model/processor_config.py | 250 +
finix/model/processor_system_config.py | 6 +-
finix/model/settlement.py | 31 +-
finix/model/settlement_links.py | 52 +-
finix/model/split_transfer.py | 315 +
finix/model/split_transfer_tags.py | 250 +
finix/model/split_transfers_list.py | 268 +
finix/model/split_transfers_list_embedded.py | 256 +
finix/model/submit_dispute_evidence.py | 256 +
finix/model/subscription_amount.py | 8 +-
finix/model/subscription_enrollment.py | 8 +-
finix/model/subscription_schedule.py | 8 +-
.../subscription_schedules_list_links.py | 22 +-
finix/model/transfer.py | 86 +-
.../update_application_profile_request.py | 24 +-
finix/model/update_authorization_request.py | 12 +-
...pdate_compliance_form_request_pci_saq_a.py | 16 +-
finix/model/update_device_request.py | 35 +-
finix/model/update_dispute_evidence.py | 256 +
finix/model/update_identity_request.py | 8 +-
finix/model/update_identity_request_entity.py | 133 +
...dentity_request_entity_business_address.py | 288 +
.../update_identity_request_entity_dob.py | 258 +
...dentity_request_entity_personal_address.py | 30 +-
.../model/update_merchant_profile_request.py | 16 +-
finix/model/update_merchant_request.py | 29 +-
.../update_payment_instrument_request.py | 34 +-
finix/model/update_payout_profile_request.py | 275 +
.../update_payout_profile_request_gross.py | 262 +
...pdate_payout_profile_request_gross_fees.py | 276 +
...te_payout_profile_request_gross_payouts.py | 268 +
.../update_payout_profile_request_net.py | 272 +
finix/model/update_settlement_request.py | 12 +-
.../update_subscription_schedule_request.py | 12 +-
finix/model/update_transfer_request.py | 12 +-
finix/model/update_user_request.py | 12 +-
finix/model/update_webhook_request.py | 10 +
finix/model/user.py | 12 +-
finix/model/user_links.py | 10 +-
finix/model/verification.py | 18 +-
...payment_instrument_verification_details.py | 294 +
finix/model/void_authorization.py | 254 +
finix/model/void_authorization_request.py | 254 +
finix/model/webhook.py | 14 +
finix/model/webhook_enabled_events.py | 273 +
finix/models/__init__.py | 75 +-
openapitools.json | 7 +
spec/finix_openapi.yaml | 13735 +++++++++++-----
204 files changed, 29427 insertions(+), 6227 deletions(-)
create mode 100644 finix/api/default_api.py
create mode 100644 finix/api/payout_profiles_api.py
create mode 100644 finix/api/split_transfers_api.py
create mode 100644 finix/model/accept_dispute.py
create mode 100644 finix/model/additional_healthcare_data.py
create mode 100644 finix/model/additional_purchase_data_item_data.py
create mode 100644 finix/model/application_links_authorizations.py
create mode 100644 finix/model/authorization_captured_external_responses.py
create mode 100644 finix/model/close_settlement.py
create mode 100644 finix/model/compliance_form_list.py
create mode 100644 finix/model/compliance_form_list_embedded.py
create mode 100644 finix/model/create_identity_request_entity_business_address.py
create mode 100644 finix/model/create_identity_request_entity_dob.py
create mode 100644 finix/model/create_identity_request_entity_incorporation_date.py
create mode 100644 finix/model/create_onboarding_form_request_merchant_processors.py
create mode 100644 finix/model/create_reversal_request_split_transfers.py
create mode 100644 finix/model/create_split_transfer_request.py
create mode 100644 finix/model/create_transfer_request_split_transfers.py
create mode 100644 finix/model/dispute_dispute_details.py
create mode 100644 finix/model/error422_invalid_field_list_embedded_errors.py
create mode 100644 finix/model/error422_invalid_field_list_embedded_links.py
create mode 100644 finix/model/get_device_connection_query_params.py
create mode 100644 finix/model/l3_additional_purchase_data.py
create mode 100644 finix/model/l3_additional_purchase_data_item_data.py
create mode 100644 finix/model/list_payoutprofiles_query_params.py
create mode 100644 finix/model/onboarding_form_onboarding_data_additional_underwriting_data.py
create mode 100644 finix/model/onboarding_form_onboarding_data_entity.py
create mode 100644 finix/model/onboarding_form_onboarding_data_entity_incorporation_date.py
create mode 100644 finix/model/onboarding_form_onboarding_data_payment_instruments.py
create mode 100644 finix/model/payment_instrument_links_updates.py
create mode 100644 finix/model/payout_profile.py
create mode 100644 finix/model/payout_profile_gross.py
create mode 100644 finix/model/payout_profile_gross_fees.py
create mode 100644 finix/model/payout_profile_gross_payouts.py
create mode 100644 finix/model/payout_profile_net.py
create mode 100644 finix/model/payout_profiles_list.py
create mode 100644 finix/model/payout_profiles_list_embedded.py
create mode 100644 finix/model/processor_config.py
create mode 100644 finix/model/split_transfer.py
create mode 100644 finix/model/split_transfer_tags.py
create mode 100644 finix/model/split_transfers_list.py
create mode 100644 finix/model/split_transfers_list_embedded.py
create mode 100644 finix/model/submit_dispute_evidence.py
create mode 100644 finix/model/update_dispute_evidence.py
create mode 100644 finix/model/update_identity_request_entity_business_address.py
create mode 100644 finix/model/update_identity_request_entity_dob.py
create mode 100644 finix/model/update_payout_profile_request.py
create mode 100644 finix/model/update_payout_profile_request_gross.py
create mode 100644 finix/model/update_payout_profile_request_gross_fees.py
create mode 100644 finix/model/update_payout_profile_request_gross_payouts.py
create mode 100644 finix/model/update_payout_profile_request_net.py
create mode 100644 finix/model/verification_payment_instrument_verification_details.py
create mode 100644 finix/model/void_authorization.py
create mode 100644 finix/model/void_authorization_request.py
create mode 100644 finix/model/webhook_enabled_events.py
create mode 100644 openapitools.json
diff --git a/finix/api/authorizations_api.py b/finix/api/authorizations_api.py
index 00ed1c8..bccdf74 100644
--- a/finix/api/authorizations_api.py
+++ b/finix/api/authorizations_api.py
@@ -30,6 +30,7 @@
from finix.model.error422_invalid_field_list import Error422InvalidFieldList
from finix.model.error_generic import ErrorGeneric
from finix.model.update_authorization_request import UpdateAuthorizationRequest
+from finix.model.void_authorization import VoidAuthorization
from finix.model.finix_utils import FinixList
from functools import wraps
@@ -79,6 +80,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'authorization_id',
+ 'accept',
+ 'finix_version',
'update_authorization_request',
],
'required': [
@@ -99,14 +102,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'authorization_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'update_authorization_request':
(UpdateAuthorizationRequest,),
},
'attribute_map': {
'authorization_id': 'authorization_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'authorization_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'update_authorization_request': 'body',
},
'collection_format_map': {
@@ -114,10 +125,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -135,6 +146,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
+ 'finix_version',
'create_authorization_request',
],
'required': [],
@@ -151,12 +164,20 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_authorization_request':
(CreateAuthorizationRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_authorization_request': 'body',
},
'collection_format_map': {
@@ -164,10 +185,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -186,6 +207,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'authorization_id',
+ 'accept',
],
'required': [
'authorization_id',
@@ -205,19 +227,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'authorization_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'authorization_id': 'authorization_id',
+ 'accept': 'Accept',
},
'location_map': {
'authorization_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -236,17 +262,20 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'amount',
'amount_gt',
'amount_gte',
'amount_lt',
'amount_lte',
'before_cursor',
+ 'after_cursor',
'created_at_gte',
'created_at_lte',
'idempotency_id',
'limit',
- 'sort',
+ 'tags_key',
+ 'tags_value',
'state',
'updated_at_gte',
'updated_at_lte',
@@ -264,7 +293,7 @@ def __init__(self, api_client=None):
'instrument_card_last4',
'merchant_processor_id',
'type',
- 'after_cursor',
+ 'finix_version',
],
'required': [],
'nullable': [
@@ -288,6 +317,8 @@ def __init__(self, api_client=None):
},
},
'openapi_types': {
+ 'accept':
+ (str,),
'amount':
(int,),
'amount_gt':
@@ -300,6 +331,8 @@ def __init__(self, api_client=None):
(int,),
'before_cursor':
(str,),
+ 'after_cursor':
+ (str,),
'created_at_gte':
(str,),
'created_at_lte':
@@ -308,7 +341,9 @@ def __init__(self, api_client=None):
(str,),
'limit':
(int,),
- 'sort':
+ 'tags_key':
+ (str,),
+ 'tags_value':
(str,),
'state':
(str,),
@@ -344,21 +379,24 @@ def __init__(self, api_client=None):
(str,),
'type':
(str,),
- 'after_cursor':
+ 'finix_version':
(str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'amount': 'amount',
'amount_gt': 'amount.gt',
'amount_gte': 'amount.gte',
'amount_lt': 'amount.lt',
'amount_lte': 'amount.lte',
'before_cursor': 'before_cursor',
+ 'after_cursor': 'after_cursor',
'created_at_gte': 'created_at.gte',
'created_at_lte': 'created_at.lte',
'idempotency_id': 'idempotency_id',
'limit': 'limit',
- 'sort': 'sort',
+ 'tags_key': 'tags.key',
+ 'tags_value': 'tags.value',
'state': 'state',
'updated_at_gte': 'updated_at.gte',
'updated_at_lte': 'updated_at.lte',
@@ -376,20 +414,23 @@ def __init__(self, api_client=None):
'instrument_card_last4': 'instrument_card_last4',
'merchant_processor_id': 'merchant_processor_id',
'type': 'type',
- 'after_cursor': 'after_cursor',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
'amount': 'query',
'amount_gt': 'query',
'amount_gte': 'query',
'amount_lt': 'query',
'amount_lte': 'query',
'before_cursor': 'query',
+ 'after_cursor': 'query',
'created_at_gte': 'query',
'created_at_lte': 'query',
'idempotency_id': 'query',
'limit': 'query',
- 'sort': 'query',
+ 'tags_key': 'query',
+ 'tags_value': 'query',
'state': 'query',
'updated_at_gte': 'query',
'updated_at_lte': 'query',
@@ -407,19 +448,86 @@ def __init__(self, api_client=None):
'instrument_card_last4': 'query',
'merchant_processor_id': 'query',
'type': 'query',
- 'after_cursor': 'query',
+ 'finix_version': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
api_client=api_client
)
+ self._update_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (AuthorizationCaptured,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/authorizations/{authorization_id_void_to}',
+ 'operation_id': 'update',
+ 'http_method': 'PUT',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'authorization_id_void_to',
+ 'accept',
+ 'finix_version',
+ 'void_authorization',
+ ],
+ 'required': [
+ 'authorization_id_void_to',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'authorization_id_void_to':
+ (str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
+ 'void_authorization':
+ (VoidAuthorization,),
+ },
+ 'attribute_map': {
+ 'authorization_id_void_to': 'authorization_id_void_to',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
+ },
+ 'location_map': {
+ 'authorization_id_void_to': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
+ 'void_authorization': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
def update(
self,
@@ -428,7 +536,7 @@ def update(
):
"""Capture an Authorization # noqa: E501
- If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds. By default, `Transfers` are in a **PENDING** state. The **PENDING** state means the request to capture funds hasn't been submitted yet. Capture requests get submitted via a batch request. Once the `Authorization` is updated with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will update to **SUCCEEDED**. > Voided `Authorizations` can't be captured. # noqa: E501
+ Use a PUT request to capture an `Authorization`. If captured successfully, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that moves funds. Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -439,6 +547,8 @@ def update(
authorization_id (str): ID of `Authorization` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
update_authorization_request (UpdateAuthorizationRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -506,7 +616,7 @@ def create(
):
"""Create an Authorization # noqa: E501
- Create an `Authorization` to process a transaction. `Authorizations` can have six possible `states`, two of which are expected: - **SUCCEEDED** - **FAILED** If the `Authorization` has **SUCCEEDED** , it must be captured before `expires_at` passes or the funds will be released. If the `transfer` field of an `Authorization` is **null**, it hasn't been captured yet. Learn how to prevent duplicate authorizations by passing an [Idempotency ID](#section/Idempotency-Requests) in the payload. - `Authorizations` on debit cards place a hold on funds in the cardholder's bank account and can lead to lower than expected balances or issues with insufficient funds. # noqa: E501
+ Create an `Authorization` to process a transaction. Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -515,6 +625,8 @@ def create(
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_authorization_request (CreateAuthorizationRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -592,6 +704,7 @@ def get(
authorization_id (str): ID of `Authorization` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -667,17 +780,20 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
amount (int): Filter by an amount equal to the given value.. [optional]
amount_gt (int): Filter by an amount greater than.. [optional]
amount_gte (int): Filter by an amount greater than or equal.. [optional]
amount_lt (int): Filter by an amount less than.. [optional]
amount_lte (int): Filter by an amount less than or equal.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
+ after_cursor (str): Return every resource created after the cursor value.. [optional]
created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
idempotency_id (str): Filter by `idempotency_id`.. [optional]
limit (int): The numbers of items to return.. [optional]
- sort (str): Specify key to be used for sorting the collection.. [optional]
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional]
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional]
state (str): Filter by Transaction state.. [optional]
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional]
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional]
@@ -695,7 +811,7 @@ def list(
instrument_card_last4 (str): Filter by the payment card last 4 digits.. [optional]
merchant_processor_id (str): Filter by `Processor` ID.. [optional]
type (str): Type of the `Authorization`.. [optional]
- after_cursor (str): Return every resource created after the cursor value.. [optional]
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -756,3 +872,84 @@ def list(
fl = FinixList(ret, self.list, **kwargs)
return fl
+ def update(
+ self,
+ authorization_id_void_to,
+ **kwargs
+ ):
+ """Void an Authorization # noqa: E501
+
+ Use a PUT request to void an `Authorization`. If voided successfully, funds get released and the transaction stops from completing. Additionally, voided `Authorization` can no longer be captured. Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/) # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.update(authorization_id_void_to, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ authorization_id_void_to (str):
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ void_authorization (VoidAuthorization): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ AuthorizationCaptured
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['authorization_id_void_to'] = \
+ authorization_id_void_to
+ return self._update_endpoint.call_with_http_info(**kwargs)
+
diff --git a/finix/api/balance_transfers_api.py b/finix/api/balance_transfers_api.py
index 4228522..04ad754 100644
--- a/finix/api/balance_transfers_api.py
+++ b/finix/api/balance_transfers_api.py
@@ -75,6 +75,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'create_balance_transfer_request',
],
'required': [],
@@ -91,12 +92,16 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'create_balance_transfer_request':
(CreateBalanceTransferRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
},
'location_map': {
+ 'accept': 'header',
'create_balance_transfer_request': 'body',
},
'collection_format_map': {
@@ -104,10 +109,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -126,6 +131,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'balance_transfers_id',
+ 'accept',
],
'required': [
'balance_transfers_id',
@@ -145,19 +151,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'balance_transfers_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'balance_transfers_id': 'balance_transfers_id',
+ 'accept': 'Accept',
},
'location_map': {
'balance_transfers_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -176,8 +186,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'limit',
- 'offset',
'page_number',
'page_size',
'created_at_gte',
@@ -206,10 +216,10 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'limit':
(int,),
- 'offset':
- (int,),
'page_number':
(int,),
'page_size':
@@ -238,8 +248,8 @@ def __init__(self, api_client=None):
(str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'limit': 'limit',
- 'offset': 'offset',
'page_number': 'pageNumber',
'page_size': 'pageSize',
'created_at_gte': 'created_at.gte',
@@ -255,8 +265,8 @@ def __init__(self, api_client=None):
'source': 'source',
},
'location_map': {
+ 'accept': 'header',
'limit': 'query',
- 'offset': 'query',
'page_number': 'query',
'page_size': 'query',
'created_at_gte': 'query',
@@ -276,7 +286,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -298,6 +308,7 @@ def create(
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
create_balance_transfer_request (CreateBalanceTransferRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -375,6 +386,7 @@ def get(
balance_transfers_id (str): ID of the `balance_transfer` resource.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -450,8 +462,8 @@ def list(
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
- offset (int): The number of items to skip before starting to collect the result set.. [optional]
page_number (int): The page number to list.. [optional]
page_size (int): The size of the page.. [optional]
created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
diff --git a/finix/api/compliance_forms_api.py b/finix/api/compliance_forms_api.py
index 4689920..8fa527b 100644
--- a/finix/api/compliance_forms_api.py
+++ b/finix/api/compliance_forms_api.py
@@ -20,6 +20,7 @@
validate_and_convert_types
)
from finix.model.compliance_form import ComplianceForm
+from finix.model.compliance_form_list import ComplianceFormList
from finix.model.error401_unauthorized import Error401Unauthorized
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error404_not_found_list import Error404NotFoundList
@@ -75,6 +76,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'compliance_forms_id',
+ 'accept',
],
'required': [
'compliance_forms_id',
@@ -94,20 +96,83 @@ def __init__(self, api_client=None):
'openapi_types': {
'compliance_forms_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'compliance_forms_id': 'compliance_forms_id',
+ 'accept': 'Accept',
},
'location_map': {
'compliance_forms_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._list_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (ComplianceFormList,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/compliance_forms',
+ 'operation_id': 'list',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'accept',
+ 'state',
+ ],
+ 'required': [],
+ 'nullable': [
+ ],
+ 'enum': [
+ 'state',
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ ('state',): {
+
+ "INCOMPLETE": "INCOMPLETE",
+ "COMPLETE": "COMPLETE"
+ },
+ },
+ 'openapi_types': {
+ 'accept':
+ (str,),
+ 'state':
+ (str,),
+ },
+ 'attribute_map': {
+ 'accept': 'Accept',
+ 'state': 'state',
+ },
+ 'location_map': {
+ 'accept': 'header',
+ 'state': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -127,6 +192,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'compliance_forms_id',
+ 'accept',
'update_compliance_form_request',
],
'required': [
@@ -147,14 +213,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'compliance_forms_id':
(str,),
+ 'accept':
+ (str,),
'update_compliance_form_request':
(UpdateComplianceFormRequest,),
},
'attribute_map': {
'compliance_forms_id': 'compliance_forms_id',
+ 'accept': 'Accept',
},
'location_map': {
'compliance_forms_id': 'path',
+ 'accept': 'header',
'update_compliance_form_request': 'body',
},
'collection_format_map': {
@@ -162,8 +232,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'application/json'
@@ -177,7 +246,7 @@ def list(
compliance_forms_id,
**kwargs
):
- """View Compliance Forms # noqa: E501
+ """Fetch a Compliance Form # noqa: E501
A webhook notifies you when Finix creates a `compliance_form`. Use the ID in the webhook to fetch the `compliance_form` resource from the `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -190,6 +259,7 @@ def list(
compliance_forms_id (str): ID of the `compliance_form`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -250,14 +320,91 @@ def list(
compliance_forms_id
return self._list_endpoint.call_with_http_info(**kwargs)
+ def list(
+ self,
+ **kwargs
+ ):
+ """List Compliance Forms # noqa: E501
+
+ Retrieves a list of `Compliance Forms`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.list(async_req=True)
+ >>> result = thread.get()
+
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ state (str): Filter by the `state` of the `Compliance Form`.. [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ ComplianceFormList
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ ret = self._list_endpoint.call_with_http_info(**kwargs)
+ fl = FinixList(ret, self.list, **kwargs)
+ return fl
+
def update(
self,
compliance_forms_id,
**kwargs
):
- """Complete Compliance Forms # noqa: E501
+ """Complete a Compliance Form # noqa: E501
- As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested. To complete PCI compliance forms: 1. Get the `compliance_form` generated for the merchant using the `ID` from the webhook and present the form to your users when requested. 2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent) to obtain consent. 3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire) information. For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms). # noqa: E501
+ As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested. For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -268,6 +415,7 @@ def update(
compliance_forms_id (str): ID of the `compliance_form`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
update_compliance_form_request (UpdateComplianceFormRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/default_api.py b/finix/api/default_api.py
new file mode 100644
index 0000000..95116b7
--- /dev/null
+++ b/finix/api/default_api.py
@@ -0,0 +1,604 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+import finix.api_client
+from finix.model_utils import ( # noqa: F401
+ check_allowed_values,
+ check_validations,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_and_convert_types
+)
+from finix.model.application import Application
+from finix.model.create_application_request import CreateApplicationRequest
+from finix.model.create_settlement_request import CreateSettlementRequest
+from finix.model.create_verification_request import CreateVerificationRequest
+from finix.model.error401_unauthorized import Error401Unauthorized
+from finix.model.error403_forbidden_list import Error403ForbiddenList
+from finix.model.error404_not_found_list import Error404NotFoundList
+from finix.model.error406_not_acceptable import Error406NotAcceptable
+from finix.model.error422_invalid_field_list import Error422InvalidFieldList
+from finix.model.error_generic import ErrorGeneric
+from finix.model.settlement import Settlement
+from finix.model.split_transfers_list import SplitTransfersList
+from finix.model.verification import Verification
+from finix.model.finix_utils import FinixList
+
+from functools import wraps
+
+def operation_decorator(func):
+ @wraps(func)
+ def response_convert(*args, **kwargs):
+ ret = func(*args, **kwargs)
+ if hasattr(ret, 'embedded'):
+ tmp = ret.embedded
+ if isinstance(tmp, dict):
+ if len(tmp) == 1:
+ ret_0 = ''
+ ret_1 = ''
+ ret_2 = ''
+ for key in tmp:
+ ret_0 = tmp[key]
+ break
+ if hasattr(ret, 'page'):
+ ret_1 = ret.page
+ if hasattr(ret, 'links'):
+ ret_2 = ret.links
+ return (ret_0, ret_1, ret_2)
+
+ else:
+ return ret
+
+ return response_convert
+
+class DefaultApi(object):
+
+ def __init__(self, api_client=None):
+ if api_client is None:
+ api_client = finix.api_client.FinixClient()
+ self._api_client = api_client
+ self._create_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Application,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/applications',
+ 'operation_id': 'create',
+ 'http_method': 'POST',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'create_application_request',
+ ],
+ 'required': [],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'create_application_request':
+ (CreateApplicationRequest,),
+ },
+ 'attribute_map': {
+ },
+ 'location_map': {
+ 'create_application_request': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+ self._create_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Settlement,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/identities/{identity_id}/settlements',
+ 'operation_id': 'create',
+ 'http_method': 'POST',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'identity_id',
+ 'accept',
+ 'create_settlement_request',
+ ],
+ 'required': [
+ 'identity_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'identity_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'create_settlement_request':
+ (CreateSettlementRequest,),
+ },
+ 'attribute_map': {
+ 'identity_id': 'identity_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'identity_id': 'path',
+ 'accept': 'header',
+ 'create_settlement_request': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+ self._create_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Verification,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/verifications',
+ 'operation_id': 'create',
+ 'http_method': 'POST',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'create_verification_request',
+ ],
+ 'required': [],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'create_verification_request':
+ (CreateVerificationRequest,),
+ },
+ 'attribute_map': {
+ },
+ 'location_map': {
+ 'create_verification_request': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+ self._list_split_transfer_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (SplitTransfersList,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/split_transfers',
+ 'operation_id': 'list_split_transfer',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'parent_transfer_id',
+ 'accept',
+ ],
+ 'required': [
+ 'parent_transfer_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ 'parent_transfer_id',
+ ]
+ },
+ root_map={
+ 'validations': {
+ ('parent_transfer_id',): {
+
+ 'regex': {
+ 'pattern': r'TRxxxxxxxxxxxxxxxxxxxxxx', # noqa: E501
+ },
+ },
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'parent_transfer_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'parent_transfer_id': 'parent_transfer_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'parent_transfer_id': 'query',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+
+ def create(
+ self,
+ **kwargs
+ ):
+ """Create an Application # noqa: E501
+
+ If created successfully, a 201 response gets returned and adds a location header to the response which refers to the new created `Application`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.create(async_req=True)
+ >>> result = thread.get()
+
+
+ Keyword Args:
+ create_application_request (CreateApplicationRequest): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Application
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ return self._create_endpoint.call_with_http_info(**kwargs)
+
+ def create(
+ self,
+ identity_id,
+ **kwargs
+ ):
+ """Close Current Active Settlement # noqa: E501
+
+ Close the currently accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team.](mailto:support@finixpayments.com) - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the seller's bank account. Related Guides: [Accruing Settlements](/guides/payouts/accruing-settlements/#closing-an-accruing-settlement) # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.create(identity_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ identity_id (str): ID of the `Identity` for the merchant you want to settle.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ create_settlement_request (CreateSettlementRequest): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Settlement
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['identity_id'] = \
+ identity_id
+ return self._create_endpoint.call_with_http_info(**kwargs)
+
+ def create(
+ self,
+ **kwargs
+ ):
+ """Create a Merchant Verification # noqa: E501
+
+ Create a `Verification` to verify a seller's `Identity`. Verifications can also be created directly on the resources you want to verify. For example: - `POST /merchants/{merchant_id}/verifications` - `POST /payment_instruments/{payment_instrument_id}/verifications` # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.create(async_req=True)
+ >>> result = thread.get()
+
+
+ Keyword Args:
+ create_verification_request (CreateVerificationRequest): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Verification
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ return self._create_endpoint.call_with_http_info(**kwargs)
+
+ def list_split_transfer(
+ self,
+ parent_transfer_id,
+ **kwargs
+ ):
+ """List Split Transfers # noqa: E501
+
+ Retireve a list of `split_transfers` created for a specifc split `Transfer`. For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/). # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.list_split_transfer(parent_transfer_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ parent_transfer_id (str): **ID** of the parent `Transfer` that was split.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ SplitTransfersList
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['parent_transfer_id'] = \
+ parent_transfer_id
+ ret = self._list_split_transfer_endpoint.call_with_http_info(**kwargs)
+ fl = FinixList(ret, self.list_split_transfer, **kwargs)
+ return fl
+
diff --git a/finix/api/devices_api.py b/finix/api/devices_api.py
index 6c6e630..06c8ed2 100644
--- a/finix/api/devices_api.py
+++ b/finix/api/devices_api.py
@@ -76,6 +76,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_id',
+ 'accept',
'create_device',
],
'required': [
@@ -96,14 +97,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_id':
(str,),
+ 'accept':
+ (str,),
'create_device':
(CreateDevice,),
},
'attribute_map': {
'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
},
'location_map': {
'merchant_id': 'path',
+ 'accept': 'header',
'create_device': 'body',
},
'collection_format_map': {
@@ -111,10 +116,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -133,6 +138,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'device_id',
+ 'accept',
'include_connection',
],
'required': [
@@ -153,15 +159,19 @@ def __init__(self, api_client=None):
'openapi_types': {
'device_id':
(str,),
+ 'accept':
+ (str,),
'include_connection':
(bool,),
},
'attribute_map': {
'device_id': 'device_id',
+ 'accept': 'Accept',
'include_connection': 'include_connection',
},
'location_map': {
'device_id': 'path',
+ 'accept': 'header',
'include_connection': 'query',
},
'collection_format_map': {
@@ -169,7 +179,69 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._get_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Device,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/devices/{device_id_connection}',
+ 'operation_id': 'get',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'device_id_connection',
+ 'include_connection',
+ 'accept',
+ ],
+ 'required': [
+ 'device_id_connection',
+ 'include_connection',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'device_id_connection':
+ (str,),
+ 'include_connection':
+ (bool,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'device_id_connection': 'device_id_connection',
+ 'include_connection': 'include_connection',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'device_id_connection': 'path',
+ 'include_connection': 'query',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
],
'content_type': [],
},
@@ -189,6 +261,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'device_id',
+ 'finix_version',
+ 'accept',
'update_device_request',
],
'required': [
@@ -209,14 +283,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'device_id':
(str,),
+ 'finix_version':
+ (str,),
+ 'accept':
+ (str,),
'update_device_request':
(UpdateDeviceRequest,),
},
'attribute_map': {
'device_id': 'device_id',
+ 'finix_version': 'Finix-Version',
+ 'accept': 'Accept',
},
'location_map': {
'device_id': 'path',
+ 'finix_version': 'header',
+ 'accept': 'header',
'update_device_request': 'body',
},
'collection_format_map': {
@@ -224,10 +306,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -251,6 +333,7 @@ def create(
merchant_id (str): ID of the `Merchant` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
create_device (CreateDevice): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -319,7 +402,7 @@ def get(
):
"""Fetch a Device # noqa: E501
- Retrieve the details of an existing `Device`. To check the connectivity of the device, include `?include_connection\\=true\\` at the end of the request endpoint. # noqa: E501
+ Retrieve the details of an existing `Device`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -330,6 +413,7 @@ def get(
device_id (str): ID of the `Device`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
include_connection (bool): Specifies whether the connection information should be included.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -391,6 +475,89 @@ def get(
device_id
return self._get_endpoint.call_with_http_info(**kwargs)
+ def get(
+ self,
+ device_id_connection,
+ include_connection,
+ **kwargs
+ ):
+ """Check Device Connection # noqa: E501
+
+ To check the connection of the `Device`, include `?include_connection\\=true\\` at the end of the request endpoint. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get(device_id_connection, include_connection, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ device_id_connection (str):
+ include_connection (bool): Specifies whether the connection information should be included.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Device
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['device_id_connection'] = \
+ device_id_connection
+ kwargs['include_connection'] = \
+ include_connection
+ return self._get_endpoint.call_with_http_info(**kwargs)
+
def update(
self,
device_id,
@@ -398,7 +565,7 @@ def update(
):
"""Initiate Action on Device # noqa: E501
- Initiate an action on a `Device`. These actions include activation, rebooting, setting an idle message, or deactivate it. # noqa: E501
+ Initiate an action on a `Device`. Actions that are available include: - Activating the `Device` - Rebooting the `Device` - Setting an idle message - Deactivating the `Device` You can also use a PUT request to update the `configuration_details`, `description`, `name`, and `serial_number` of the `Device`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -409,6 +576,8 @@ def update(
device_id (str): ID of the `Device`.
Keyword Args:
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
update_device_request (UpdateDeviceRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/disputes_api.py b/finix/api/disputes_api.py
index 58fa479..81940ff 100644
--- a/finix/api/disputes_api.py
+++ b/finix/api/disputes_api.py
@@ -19,6 +19,7 @@
none_type,
validate_and_convert_types
)
+from finix.model.accept_dispute import AcceptDispute
from finix.model.adjustment_transfers_list import AdjustmentTransfersList
from finix.model.create_dispute_evidence_request import CreateDisputeEvidenceRequest
from finix.model.dispute import Dispute
@@ -29,6 +30,9 @@
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error404_not_found_list import Error404NotFoundList
from finix.model.error406_not_acceptable import Error406NotAcceptable
+from finix.model.error_generic import ErrorGeneric
+from finix.model.submit_dispute_evidence import SubmitDisputeEvidence
+from finix.model.update_dispute_evidence import UpdateDisputeEvidence
from finix.model.finix_utils import FinixList
from functools import wraps
@@ -64,6 +68,68 @@ def __init__(self, api_client=None):
if api_client is None:
api_client = finix.api_client.FinixClient()
self._api_client = api_client
+ self._post_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Dispute,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/disputes/{dispute_id}/accept',
+ 'operation_id': 'post',
+ 'http_method': 'POST',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'dispute_id',
+ 'accept',
+ 'accept_dispute',
+ ],
+ 'required': [
+ 'dispute_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'dispute_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'accept_dispute':
+ (AcceptDispute,),
+ },
+ 'attribute_map': {
+ 'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'dispute_id': 'path',
+ 'accept': 'header',
+ 'accept_dispute': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
self._create_dispute_evidence_endpoint = finix.api_client.Endpoint(
settings={
'response_type': (DisputeEvidence,),
@@ -78,6 +144,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'dispute_id',
+ 'accept',
'create_dispute_evidence_request',
],
'required': [
@@ -98,14 +165,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'dispute_id':
(str,),
+ 'accept':
+ (str,),
'create_dispute_evidence_request':
(CreateDisputeEvidenceRequest,),
},
'attribute_map': {
'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
},
'location_map': {
'dispute_id': 'path',
+ 'accept': 'header',
'create_dispute_evidence_request': 'body',
},
'collection_format_map': {
@@ -113,7 +184,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'multipart/form-data'
@@ -121,6 +192,69 @@ def __init__(self, api_client=None):
},
api_client=api_client
)
+ self._get_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (file_type,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/disputes/{dispute_id}/evidence/{evidence_id}/download',
+ 'operation_id': 'get',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'dispute_id',
+ 'evidence_id',
+ 'accept',
+ ],
+ 'required': [
+ 'dispute_id',
+ 'evidence_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'dispute_id':
+ (str,),
+ 'evidence_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'dispute_id': 'dispute_id',
+ 'evidence_id': 'evidence_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'dispute_id': 'path',
+ 'evidence_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/octet-stream',
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
self._get_endpoint = finix.api_client.Endpoint(
settings={
'response_type': (Dispute,),
@@ -135,6 +269,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'dispute_id',
+ 'accept',
],
'required': [
'dispute_id',
@@ -154,19 +289,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'dispute_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
},
'location_map': {
'dispute_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -187,6 +326,7 @@ def __init__(self, api_client=None):
'all': [
'dispute_id',
'evidence_id',
+ 'accept',
],
'required': [
'dispute_id',
@@ -209,21 +349,25 @@ def __init__(self, api_client=None):
(str,),
'evidence_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'dispute_id': 'dispute_id',
'evidence_id': 'evidence_id',
+ 'accept': 'Accept',
},
'location_map': {
'dispute_id': 'path',
'evidence_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -243,6 +387,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'dispute_id',
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -265,6 +410,8 @@ def __init__(self, api_client=None):
'openapi_types': {
'dispute_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -274,12 +421,14 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
'dispute_id': 'path',
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -289,7 +438,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -308,13 +457,36 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
- 'sort',
- 'offset',
+ 'accept',
'limit',
'created_at_gte',
'created_at_lte',
'updated_at_gte',
'updated_at_lte',
+ 'transfer_id',
+ 'adjustment_transfer_id',
+ 'amount',
+ 'amount_gte',
+ 'amount_gt',
+ 'amount_lt',
+ 'state',
+ 'response_state',
+ 'respond_by_lte',
+ 'respond_by_gte',
+ 'instrument_bin',
+ 'instrument_brand_type',
+ 'merchant_identity_id',
+ 'merchant_identity_name',
+ 'instrument_name',
+ 'instrument_type',
+ 'merchant_id',
+ 'merchant_mid',
+ 'instrument_card_last4',
+ 'instrument_card_type',
+ 'instrument_fingerprint',
+ 'before_cursor',
+ 'tags_key',
+ 'tags_value',
],
'required': [],
'nullable': [
@@ -330,10 +502,8 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'sort':
+ 'accept':
(str,),
- 'offset':
- (int,),
'limit':
(int,),
'created_at_gte':
@@ -344,31 +514,125 @@ def __init__(self, api_client=None):
(str,),
'updated_at_lte':
(str,),
+ 'transfer_id':
+ (str,),
+ 'adjustment_transfer_id':
+ (str,),
+ 'amount':
+ (int,),
+ 'amount_gte':
+ (int,),
+ 'amount_gt':
+ (int,),
+ 'amount_lt':
+ (int,),
+ 'state':
+ (str,),
+ 'response_state':
+ (str,),
+ 'respond_by_lte':
+ (str,),
+ 'respond_by_gte':
+ (str,),
+ 'instrument_bin':
+ (str,),
+ 'instrument_brand_type':
+ (str,),
+ 'merchant_identity_id':
+ (str,),
+ 'merchant_identity_name':
+ (str,),
+ 'instrument_name':
+ (str,),
+ 'instrument_type':
+ (str,),
+ 'merchant_id':
+ (str,),
+ 'merchant_mid':
+ (str,),
+ 'instrument_card_last4':
+ (str,),
+ 'instrument_card_type':
+ (str,),
+ 'instrument_fingerprint':
+ (str,),
+ 'before_cursor':
+ (str,),
+ 'tags_key':
+ (str,),
+ 'tags_value':
+ (str,),
},
'attribute_map': {
- 'sort': 'sort',
- 'offset': 'offset',
+ 'accept': 'Accept',
'limit': 'limit',
'created_at_gte': 'created_at.gte',
'created_at_lte': 'created_at.lte',
'updated_at_gte': 'updated_at.gte',
'updated_at_lte': 'updated_at.lte',
+ 'transfer_id': 'transfer_id',
+ 'adjustment_transfer_id': 'adjustment_transfer_id',
+ 'amount': 'amount',
+ 'amount_gte': 'amount.gte',
+ 'amount_gt': 'amount.gt',
+ 'amount_lt': 'amount.lt',
+ 'state': 'state',
+ 'response_state': 'response_state',
+ 'respond_by_lte': 'respond_by.lte',
+ 'respond_by_gte': 'respond_by.gte',
+ 'instrument_bin': 'instrument_bin',
+ 'instrument_brand_type': 'instrument_brand_type',
+ 'merchant_identity_id': 'merchant_identity_id',
+ 'merchant_identity_name': 'merchant_identity_name',
+ 'instrument_name': 'instrument_name',
+ 'instrument_type': 'instrument_type',
+ 'merchant_id': 'merchant_id',
+ 'merchant_mid': 'merchant_mid',
+ 'instrument_card_last4': 'instrument_card_last4',
+ 'instrument_card_type': 'instrument_card_type',
+ 'instrument_fingerprint': 'instrument_fingerprint',
+ 'before_cursor': 'before_cursor',
+ 'tags_key': 'tags.key',
+ 'tags_value': 'tags.value',
},
'location_map': {
- 'sort': 'query',
- 'offset': 'query',
+ 'accept': 'header',
'limit': 'query',
'created_at_gte': 'query',
'created_at_lte': 'query',
'updated_at_gte': 'query',
'updated_at_lte': 'query',
+ 'transfer_id': 'query',
+ 'adjustment_transfer_id': 'query',
+ 'amount': 'query',
+ 'amount_gte': 'query',
+ 'amount_gt': 'query',
+ 'amount_lt': 'query',
+ 'state': 'query',
+ 'response_state': 'query',
+ 'respond_by_lte': 'query',
+ 'respond_by_gte': 'query',
+ 'instrument_bin': 'query',
+ 'instrument_brand_type': 'query',
+ 'merchant_identity_id': 'query',
+ 'merchant_identity_name': 'query',
+ 'instrument_name': 'query',
+ 'instrument_type': 'query',
+ 'merchant_id': 'query',
+ 'merchant_mid': 'query',
+ 'instrument_card_last4': 'query',
+ 'instrument_card_type': 'query',
+ 'instrument_fingerprint': 'query',
+ 'before_cursor': 'query',
+ 'tags_key': 'query',
+ 'tags_value': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -388,6 +652,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'dispute_id',
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -410,6 +675,8 @@ def __init__(self, api_client=None):
'openapi_types': {
'dispute_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -419,12 +686,14 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
'dispute_id': 'path',
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -434,32 +703,401 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
api_client=api_client
)
+ self._post_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Dispute,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/disputes/{dispute_id}/submit',
+ 'operation_id': 'post',
+ 'http_method': 'POST',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'dispute_id',
+ 'accept',
+ 'finix_version',
+ 'submit_dispute_evidence',
+ ],
+ 'required': [
+ 'dispute_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'dispute_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
+ 'submit_dispute_evidence':
+ (SubmitDisputeEvidence,),
+ },
+ 'attribute_map': {
+ 'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
+ },
+ 'location_map': {
+ 'dispute_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
+ 'submit_dispute_evidence': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+ self._update_dispute_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (Dispute,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/disputes/{dispute_id}',
+ 'operation_id': 'update_dispute',
+ 'http_method': 'PUT',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'dispute_id',
+ 'accept',
+ 'finix_version',
+ 'update_dispute_evidence',
+ ],
+ 'required': [
+ 'dispute_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'dispute_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
+ 'update_dispute_evidence':
+ (UpdateDisputeEvidence,),
+ },
+ 'attribute_map': {
+ 'dispute_id': 'dispute_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
+ },
+ 'location_map': {
+ 'dispute_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
+ 'update_dispute_evidence': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+ self._update_dispute_evidence_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (DisputeEvidence,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/disputes/{dispute_id}/evidence/{evidence_id}',
+ 'operation_id': 'update_dispute_evidence',
+ 'http_method': 'PUT',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'dispute_id',
+ 'evidence_id',
+ 'accept',
+ 'finix_version',
+ 'update_dispute_evidence',
+ ],
+ 'required': [
+ 'dispute_id',
+ 'evidence_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'dispute_id':
+ (str,),
+ 'evidence_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
+ 'update_dispute_evidence':
+ (UpdateDisputeEvidence,),
+ },
+ 'attribute_map': {
+ 'dispute_id': 'dispute_id',
+ 'evidence_id': 'evidence_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
+ },
+ 'location_map': {
+ 'dispute_id': 'path',
+ 'evidence_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
+ 'update_dispute_evidence': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+
+ def post(
+ self,
+ dispute_id,
+ **kwargs
+ ):
+ """Accept a Dispute # noqa: E501
+
+ You can accept a `Dispute` to prevent a long (and potentially expensive) process. When you accept a `Dispute`, you concede that the Dispute is not worth challenging or representing. Related guides: [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/) # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.post(dispute_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ dispute_id (str): ID of `Dispute` to move forward and submit evidence.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ accept_dispute (AcceptDispute): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Dispute
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['dispute_id'] = \
+ dispute_id
+ return self._post_endpoint.call_with_http_info(**kwargs)
+
+ def create_dispute_evidence(
+ self,
+ dispute_id,
+ **kwargs
+ ):
+ """Upload Files as Dispute Evidence # noqa: E501
+
+ Upload a file as evidence for a `Dispute`. - You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB. - The allowed file formats include JPG, PNG, PDF, or TIFF. - Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.create_dispute_evidence(dispute_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ dispute_id (str): ID of `Dispute` to mange evidence for.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ create_dispute_evidence_request (CreateDisputeEvidenceRequest): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ DisputeEvidence
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['dispute_id'] = \
+ dispute_id
+ return self._create_dispute_evidence_endpoint.call_with_http_info(**kwargs)
- def create_dispute_evidence(
+ def get(
self,
dispute_id,
+ evidence_id,
**kwargs
):
- """Upload Dispute Evidence # noqa: E501
+ """Download Dispute Evidence # noqa: E501
- Upload dispute evidence for a `Dispute`. - You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB. - The allowed file formats include JPG, PNG, PDF, or TIFF. - Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB. # noqa: E501
+ Download a file uploaded as `Dispute Evidence`. **Note**: The file extension included in `output` must match the extension of the original uploaded file. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_dispute_evidence(dispute_id, async_req=True)
+ >>> thread = api.get(dispute_id, evidence_id, async_req=True)
>>> result = thread.get()
Args:
- dispute_id (str): ID of `Dispute` to mange evidence for.
+ dispute_id (str): ID of `Dispute` to download evidence from.
+ evidence_id (str): ID of `evidence` to download.
Keyword Args:
- create_dispute_evidence_request (CreateDisputeEvidenceRequest): [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -488,7 +1126,7 @@ def create_dispute_evidence(
async_req (bool): execute request asynchronously
Returns:
- DisputeEvidence
+ file_type
If the method is called asynchronously, returns the request
thread.
"""
@@ -518,7 +1156,9 @@ def create_dispute_evidence(
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['dispute_id'] = \
dispute_id
- return self._create_dispute_evidence_endpoint.call_with_http_info(**kwargs)
+ kwargs['evidence_id'] = \
+ evidence_id
+ return self._get_endpoint.call_with_http_info(**kwargs)
def get(
self,
@@ -535,9 +1175,10 @@ def get(
>>> result = thread.get()
Args:
- dispute_id (str): ID of `Dispute` to fetch.
+ dispute_id (str): ID of `Dispute`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -618,6 +1259,7 @@ def get_dispute_evidence(
evidence_id (str): ID of `evidence` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -698,6 +1340,7 @@ def list_dispute_evidence_by_dispute_id(
dispute_id (str): ID of `Dispute` to mange evidence for.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
@@ -778,13 +1421,36 @@ def list(
Keyword Args:
- sort (str): Specify key to be used for sorting the collection.. [optional]
- offset (int): The number of items to skip before starting to collect the result set.. [optional]
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional]
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional]
+ transfer_id (str): Filter by the ID of the `Transfer` that's being disputed.
**Note**: If included, all other filter parameters are ignored.. [optional]
+ adjustment_transfer_id (str): Filter by the ID of the adjustment `Transfer`.
**Note**: If included, all other filter parameters are ignored.. [optional]
+ amount (int): Filter by an amount equal to the given value.. [optional]
+ amount_gte (int): Filter by an amount greater than or equal.. [optional]
+ amount_gt (int): Filter by an amount greater than.. [optional]
+ amount_lt (int): Filter by an amount less than.. [optional]
+ state (str): Filter by the state of the `Dispute`.. [optional]
+ response_state (str): Filter by the `response_state` of the `Dispute`.. [optional]
+ respond_by_lte (str): Filter where `respond_by` is before the given date.. [optional]
+ respond_by_gte (str): Filter where `respond_by` is after the given date.. [optional]
+ instrument_bin (str): Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number.. [optional]
+ instrument_brand_type (str): Filter by the card brand used.. [optional]
+ merchant_identity_id (str): Filter by the ID of the `Identity` used by the `Merchant`.. [optional]
+ merchant_identity_name (str): Filter by the name used by the `Merchant`.. [optional]
+ instrument_name (str): Filter by the name of the `Payment Instrument`.. [optional]
+ instrument_type (str): Filter by `Payment Instrument` type.. [optional]
+ merchant_id (str): Filter by the ID of the `Merchant`.. [optional]
+ merchant_mid (str): Filter by the MID of the `Merchant`.. [optional]
+ instrument_card_last4 (str): Filter by the last 4 digits of the card used.. [optional]
+ instrument_card_type (str): Filter by the card type.. [optional]
+ instrument_fingerprint (str): Filter by the fingerprint of the `Payment Instrument`.. [optional]
+ before_cursor (str): Returns every `Dispute` created before the cursor value.. [optional]
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional]
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -863,6 +1529,7 @@ def list_disputes_adjustments(
dispute_id (str): ID of the `Dispute` resource.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
@@ -928,3 +1595,250 @@ def list_disputes_adjustments(
fl = FinixList(ret, self.list_disputes_adjustments, **kwargs)
return fl
+ def post(
+ self,
+ dispute_id,
+ **kwargs
+ ):
+ """Submit Dispute Evidence # noqa: E501
+
+ You can manually submit evidence to the issuing bank to manually move a dispute forward. Use the `/disputes/DISPUTE_ID/submit` endpoint to submit evidence. Making a POST request lets the issuing bank know the seller has completed submitting evidence and is prepared to move forward with the dispute. Related guides: [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/). # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.post(dispute_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ dispute_id (str): ID of `Dispute` to move forward and submit evidence.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ submit_dispute_evidence (SubmitDisputeEvidence): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Dispute
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['dispute_id'] = \
+ dispute_id
+ return self._post_endpoint.call_with_http_info(**kwargs)
+
+ def update_dispute(
+ self,
+ dispute_id,
+ **kwargs
+ ):
+ """Update a Dispute # noqa: E501
+
+ Update `tags` on `Disputes`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.update_dispute(dispute_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ dispute_id (str): ID of `Dispute`.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ update_dispute_evidence (UpdateDisputeEvidence): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ Dispute
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['dispute_id'] = \
+ dispute_id
+ return self._update_dispute_endpoint.call_with_http_info(**kwargs)
+
+ def update_dispute_evidence(
+ self,
+ dispute_id,
+ evidence_id,
+ **kwargs
+ ):
+ """Update Dispute Evidence # noqa: E501
+
+ Update tags on `Dispute` evidence. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.update_dispute_evidence(dispute_id, evidence_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ dispute_id (str): ID of `Dispute` to fetch evidence for.
+ evidence_id (str): ID of `evidence` to fetch.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ update_dispute_evidence (UpdateDisputeEvidence): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ DisputeEvidence
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['dispute_id'] = \
+ dispute_id
+ kwargs['evidence_id'] = \
+ evidence_id
+ return self._update_dispute_evidence_endpoint.call_with_http_info(**kwargs)
+
diff --git a/finix/api/fee_profiles_api.py b/finix/api/fee_profiles_api.py
index dfa2e21..2e40535 100644
--- a/finix/api/fee_profiles_api.py
+++ b/finix/api/fee_profiles_api.py
@@ -104,10 +104,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -126,6 +126,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'fee_profile_id',
+ 'accept',
],
'required': [
'fee_profile_id',
@@ -145,19 +146,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'fee_profile_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'fee_profile_id': 'fee_profile_id',
+ 'accept': 'Accept',
},
'location_map': {
'fee_profile_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -176,6 +181,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'after_cursor',
'before_cursor',
'limit',
@@ -194,6 +200,8 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'after_cursor':
(str,),
'before_cursor':
@@ -202,11 +210,13 @@ def __init__(self, api_client=None):
(int,),
},
'attribute_map': {
+ 'accept': 'Accept',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
'limit': 'limit',
},
'location_map': {
+ 'accept': 'header',
'after_cursor': 'query',
'before_cursor': 'query',
'limit': 'query',
@@ -216,7 +226,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -315,6 +325,7 @@ def get(
fee_profile_id (str): The ID of the `fee_profile`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -390,6 +401,7 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
diff --git a/finix/api/files_api.py b/finix/api/files_api.py
index a4e0793..2390255 100644
--- a/finix/api/files_api.py
+++ b/finix/api/files_api.py
@@ -79,6 +79,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'file_id',
+ 'accept',
'create_external_link_request',
],
'required': [
@@ -99,14 +100,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'file_id':
(str,),
+ 'accept':
+ (str,),
'create_external_link_request':
(CreateExternalLinkRequest,),
},
'attribute_map': {
'file_id': 'file_id',
+ 'accept': 'Accept',
},
'location_map': {
'file_id': 'path',
+ 'accept': 'header',
'create_external_link_request': 'body',
},
'collection_format_map': {
@@ -114,11 +119,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/vnd.api+json'
+ 'application/json'
]
},
api_client=api_client
@@ -165,11 +169,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/vnd.api+json'
+ 'application/json'
]
},
api_client=api_client
@@ -188,6 +191,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'file_id',
+ 'accept',
+ 'stream',
],
'required': [
'file_id',
@@ -195,6 +200,7 @@ def __init__(self, api_client=None):
'nullable': [
],
'enum': [
+ 'stream',
],
'validation': [
]
@@ -203,16 +209,29 @@ def __init__(self, api_client=None):
'validations': {
},
'allowed_values': {
+ ('stream',): {
+
+ "TRUE": "true",
+ "FALSE": "false"
+ },
},
'openapi_types': {
'file_id':
(str,),
+ 'accept':
+ (str,),
+ 'stream':
+ (str,),
},
'attribute_map': {
'file_id': 'file_id',
+ 'accept': 'Accept',
+ 'stream': 'stream',
},
'location_map': {
'file_id': 'path',
+ 'accept': 'header',
+ 'stream': 'query',
},
'collection_format_map': {
}
@@ -220,7 +239,7 @@ def __init__(self, api_client=None):
headers_map={
'accept': [
'application/octet-stream',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -241,6 +260,7 @@ def __init__(self, api_client=None):
'all': [
'file_id',
'external_link_id',
+ 'accept',
],
'required': [
'file_id',
@@ -263,22 +283,25 @@ def __init__(self, api_client=None):
(str,),
'external_link_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'file_id': 'file_id',
'external_link_id': 'external_link_id',
+ 'accept': 'Accept',
},
'location_map': {
'file_id': 'path',
'external_link_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -298,6 +321,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'file_id',
+ 'accept',
],
'required': [
'file_id',
@@ -317,20 +341,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'file_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'file_id': 'file_id',
+ 'accept': 'Accept',
},
'location_map': {
'file_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -350,7 +377,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'file_id',
- 'sort',
+ 'accept',
'after_cursor',
'limit',
'id',
@@ -378,7 +405,7 @@ def __init__(self, api_client=None):
'openapi_types': {
'file_id':
(str,),
- 'sort':
+ 'accept':
(str,),
'after_cursor':
(str,),
@@ -399,7 +426,7 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'file_id': 'file_id',
- 'sort': 'sort',
+ 'accept': 'Accept',
'after_cursor': 'after_cursor',
'limit': 'limit',
'id': 'id',
@@ -411,7 +438,7 @@ def __init__(self, api_client=None):
},
'location_map': {
'file_id': 'path',
- 'sort': 'query',
+ 'accept': 'header',
'after_cursor': 'query',
'limit': 'query',
'id': 'query',
@@ -426,8 +453,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -446,7 +472,6 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
- 'sort',
'after_cursor',
'limit',
'id',
@@ -470,8 +495,6 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'sort':
- (str,),
'after_cursor':
(str,),
'limit':
@@ -490,7 +513,6 @@ def __init__(self, api_client=None):
(str,),
},
'attribute_map': {
- 'sort': 'sort',
'after_cursor': 'after_cursor',
'limit': 'limit',
'id': 'id',
@@ -501,7 +523,6 @@ def __init__(self, api_client=None):
'before_cursor': 'before_cursor',
},
'location_map': {
- 'sort': 'query',
'after_cursor': 'query',
'limit': 'query',
'id': 'query',
@@ -516,8 +537,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -537,6 +557,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'file_id',
+ 'accept',
'upload_file_request',
],
'required': [
@@ -557,14 +578,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'file_id':
(str,),
+ 'accept':
+ (str,),
'upload_file_request':
(UploadFileRequest,),
},
'attribute_map': {
'file_id': 'file_id',
+ 'accept': 'Accept',
},
'location_map': {
'file_id': 'path',
+ 'accept': 'header',
'upload_file_request': 'body',
},
'collection_format_map': {
@@ -572,8 +597,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/vnd.api+json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'multipart/form-data'
@@ -589,7 +613,7 @@ def create_external_link(
):
"""Create an External Link # noqa: E501
- Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/docs/guides/onboarding/uploading-files-to-finix/). Once created, you can request the user to upload a file to the `external_link` resource: [Upload files to External Link](#operation/uploadExternalLink) # noqa: E501
+ Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -600,6 +624,7 @@ def create_external_link(
file_id (str): Your `File` ID.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
create_external_link_request (CreateExternalLinkRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -667,7 +692,7 @@ def create(
):
"""Create a File # noqa: E501
- Before uploading a file, you need to create a `File` resource. Once created, you can [upload](/#operation/uploadFile) your file to the new `File` resource. # noqa: E501
+ Before uploading a file, you need to create a `File` resource. Once created, you can [upload](/guides/onboarding/uploading-files-to-finix/#how-to-upload-a-file-to-finix) your file to the new `File` resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -740,9 +765,9 @@ def download(
file_id,
**kwargs
):
- """Download a file # noqa: E501
+ """Download a File # noqa: E501
- Download a file that was uploaded to a `File` resource. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix). # noqa: E501
+ Download a file that was uploaded to a `File` resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -753,6 +778,8 @@ def download(
file_id (str): The ID of the `File` that was created to upload the file.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ stream (str): Stream the contents of the `File` so it's displayed inline in the user's web browser.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -821,7 +848,7 @@ def get_external_link(
):
"""Fetch an External LInk # noqa: E501
- Fetch a previously created `external_link` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). # noqa: E501
+ Fetch a previously created `external_link` resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -833,6 +860,7 @@ def get_external_link(
external_link_id (str): The ID of the `external_link` that you want to retireve.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -902,7 +930,7 @@ def get(
):
"""Fetch a File # noqa: E501
- Retrieve the details of a `File` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). # noqa: E501
+ Retrieve the details of a `File` resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -913,6 +941,7 @@ def get(
file_id (str): Your `File` ID.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -980,7 +1009,7 @@ def list_external_links(
):
"""List All External Links # noqa: E501
- List the previously created `external_links` for a `File`. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). # noqa: E501
+ List the previously created `external_links` for a `File`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -991,7 +1020,7 @@ def list_external_links(
file_id (str): Your `File` ID.
Keyword Args:
- sort (str): Specify key to be used for sorting the collection.. [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
after_cursor (str): Return every resource created after the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
id (str): Filter by `id`.. [optional]
@@ -1068,7 +1097,7 @@ def list(
):
"""List All Files # noqa: E501
- List all the `File` resources you've created. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-1-create-a-file). # noqa: E501
+ List all the `File` resources you've created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1077,7 +1106,6 @@ def list(
Keyword Args:
- sort (str): Specify key to be used for sorting the collection.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
id (str): Filter by `id`.. [optional]
@@ -1153,7 +1181,7 @@ def upload(
):
"""Upload files Directly # noqa: E501
- Upload files directly with a `multipart/form-data` request. For more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file). # noqa: E501
+ Upload files directly with a `multipart/form-data` request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1164,6 +1192,7 @@ def upload(
file_id (str): The ID of the `File` that was created to upload the file.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
upload_file_request (UploadFileRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/identities_api.py b/finix/api/identities_api.py
index 0ac0d8d..83e11a4 100644
--- a/finix/api/identities_api.py
+++ b/finix/api/identities_api.py
@@ -21,7 +21,6 @@
)
from finix.model.create_associated_identity_request import CreateAssociatedIdentityRequest
from finix.model.create_identity_request import CreateIdentityRequest
-from finix.model.create_verification_request import CreateVerificationRequest
from finix.model.error401_unauthorized import Error401Unauthorized
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error404_not_found_list import Error404NotFoundList
@@ -30,7 +29,6 @@
from finix.model.identities_list import IdentitiesList
from finix.model.identity import Identity
from finix.model.update_identity_request import UpdateIdentityRequest
-from finix.model.verification import Verification
from finix.model.finix_utils import FinixList
from functools import wraps
@@ -80,6 +78,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'identity_id',
+ 'accept',
'create_associated_identity_request',
],
'required': [
@@ -100,14 +99,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'identity_id':
(str,),
+ 'accept':
+ (str,),
'create_associated_identity_request':
(CreateAssociatedIdentityRequest,),
},
'attribute_map': {
'identity_id': 'identity_id',
+ 'accept': 'Accept',
},
'location_map': {
'identity_id': 'path',
+ 'accept': 'header',
'create_associated_identity_request': 'body',
},
'collection_format_map': {
@@ -115,10 +118,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -136,6 +139,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
+ 'finix_version',
'create_identity_request',
],
'required': [],
@@ -152,12 +157,20 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_identity_request':
(CreateIdentityRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_identity_request': 'body',
},
'collection_format_map': {
@@ -165,67 +178,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
- ]
- },
- api_client=api_client
- )
- self._create_identity_verification_endpoint = finix.api_client.Endpoint(
- settings={
- 'response_type': (Verification,),
- 'auth': [
- 'BasicAuth'
- ],
- 'endpoint_path': '/identities/{identity_id}/verifications',
- 'operation_id': 'create_identity_verification',
- 'http_method': 'POST',
- 'servers': None,
- },
- params_map={
- 'all': [
- 'identity_id',
- 'create_verification_request',
- ],
- 'required': [
- 'identity_id',
- ],
- 'nullable': [
- ],
- 'enum': [
- ],
- 'validation': [
- ]
- },
- root_map={
- 'validations': {
- },
- 'allowed_values': {
- },
- 'openapi_types': {
- 'identity_id':
- (str,),
- 'create_verification_request':
- (CreateVerificationRequest,),
- },
- 'attribute_map': {
- 'identity_id': 'identity_id',
- },
- 'location_map': {
- 'identity_id': 'path',
- 'create_verification_request': 'body',
- },
- 'collection_format_map': {
- }
- },
- headers_map={
- 'accept': [
- 'application/hal+json'
- ],
- 'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -244,6 +200,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'identity_id',
+ 'accept',
],
'required': [
'identity_id',
@@ -263,19 +220,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'identity_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'identity_id': 'identity_id',
+ 'accept': 'Accept',
},
'location_map': {
'identity_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -294,7 +255,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
- 'sort',
+ 'accept',
'after_cursor',
'limit',
'id',
@@ -308,6 +269,8 @@ def __init__(self, api_client=None):
'last_name',
'title',
'before_cursor',
+ 'tags_key',
+ 'tags_value',
],
'required': [],
'nullable': [
@@ -323,7 +286,7 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'sort':
+ 'accept':
(str,),
'after_cursor':
(str,),
@@ -351,9 +314,13 @@ def __init__(self, api_client=None):
(str,),
'before_cursor':
(str,),
+ 'tags_key':
+ (str,),
+ 'tags_value':
+ (str,),
},
'attribute_map': {
- 'sort': 'sort',
+ 'accept': 'Accept',
'after_cursor': 'after_cursor',
'limit': 'limit',
'id': 'id',
@@ -367,9 +334,11 @@ def __init__(self, api_client=None):
'last_name': 'last_name',
'title': 'title',
'before_cursor': 'before_cursor',
+ 'tags_key': 'tags.key',
+ 'tags_value': 'tags.value',
},
'location_map': {
- 'sort': 'query',
+ 'accept': 'header',
'after_cursor': 'query',
'limit': 'query',
'id': 'query',
@@ -383,13 +352,15 @@ def __init__(self, api_client=None):
'last_name': 'query',
'title': 'query',
'before_cursor': 'query',
+ 'tags_key': 'query',
+ 'tags_value': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -409,6 +380,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'identity_id',
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -431,6 +403,8 @@ def __init__(self, api_client=None):
'openapi_types': {
'identity_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -440,12 +414,14 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'identity_id': 'identity_id',
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
'identity_id': 'path',
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -455,7 +431,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -475,6 +451,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'identity_id',
+ 'accept',
'update_identity_request',
],
'required': [
@@ -495,14 +472,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'identity_id':
(str,),
+ 'accept':
+ (str,),
'update_identity_request':
(UpdateIdentityRequest,),
},
'attribute_map': {
'identity_id': 'identity_id',
+ 'accept': 'Accept',
},
'location_map': {
'identity_id': 'path',
+ 'accept': 'header',
'update_identity_request': 'body',
},
'collection_format_map': {
@@ -510,10 +491,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -526,7 +507,7 @@ def create_associated_identity(
):
"""Create an Associated Identity # noqa: E501
- Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/#step-3-add-associated-identities) over the merchant. # noqa: E501
+ Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/onboarding-with-api#step-3-add-associated-identities) over the merchant. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -537,6 +518,7 @@ def create_associated_identity(
identity_id (str): ID of `Identity` to associate object with.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
create_associated_identity_request (CreateAssociatedIdentityRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -604,7 +586,7 @@ def create(
):
"""Create an Identity # noqa: E501
- Create an `Identity` for your merchant or buyer. All fields for a buyer's `Identity` are optional. Providing `business_type` indicates that the `Identity` is being created for a Merchant. Creating `Identities` for merchants requires they provide [KYC details](/docs/guides/getting-started/). - When creating an `Identity` for a buyer , don't pass the `business_type` field. Including a value for `business_type` configures the created `Identity` to get processed as a merchant. - When creating an `Identity` for a buyer, all fields are optional . Related Guides: [Getting Started](/docs/guides/getting-started/), [Onboarding](/docs/guides/onboarding/) # noqa: E501
+ Create an `Identity` for your seller or buyer. All fields for a buyer's `Identity` are optional. Providing `business_type` indicates that the `Identity` is being created for a Merchant. Related Guides: [Getting Started](/guides/getting-started/), [Onboarding](/guides/onboarding/) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -613,7 +595,9 @@ def create(
Keyword Args:
- create_identity_request (CreateIdentityRequest): . [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ create_identity_request (CreateIdentityRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -672,85 +656,6 @@ def create(
kwargs['_host_index'] = kwargs.get('_host_index')
return self._create_endpoint.call_with_http_info(**kwargs)
- def create_identity_verification(
- self,
- identity_id,
- **kwargs
- ):
- """Verify an Identity # noqa: E501
-
- Verify an `Identity`. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
-
- >>> thread = api.create_identity_verification(identity_id, async_req=True)
- >>> result = thread.get()
-
- Args:
- identity_id (str): ID of `Identity` to verify.
-
- Keyword Args:
- create_verification_request (CreateVerificationRequest): [optional]
- _return_http_data_only (bool): response data without head status
- code and headers. Default is True.
- _preload_content (bool): if False, the urllib3.HTTPResponse object
- will be returned without reading/decoding response data.
- Default is True.
- _request_timeout (int/float/tuple): timeout setting for this request. If
- one number provided, it will be total request timeout. It can also
- be a pair (tuple) of (connection, read) timeouts.
- Default is None.
- _check_input_type (bool): specifies if type checking
- should be done one the data sent to the server.
- Default is True.
- _check_return_type (bool): specifies if type checking
- should be done one the data received from the server.
- Default is True.
- _spec_property_naming (bool): True if the variable names in the input data
- are serialized names, as specified in the OpenAPI document.
- False if the variable names in the input data
- are pythonic names, e.g. snake case (default)
- _content_type (str/None): force body content-type.
- Default is None and content-type will be predicted by allowed
- content-types and body.
- _host_index (int/None): specifies the index of the server
- that we want to use.
- Default is read from the configuration.
- async_req (bool): execute request asynchronously
-
- Returns:
- Verification
- If the method is called asynchronously, returns the request
- thread.
- """
- kwargs['async_req'] = kwargs.get(
- 'async_req', False
- )
- kwargs['_return_http_data_only'] = kwargs.get(
- '_return_http_data_only', True
- )
- kwargs['_preload_content'] = kwargs.get(
- '_preload_content', True
- )
- kwargs['_request_timeout'] = kwargs.get(
- '_request_timeout', None
- )
- kwargs['_check_input_type'] = kwargs.get(
- '_check_input_type', False
- )
- kwargs['_check_return_type'] = kwargs.get(
- '_check_return_type', False
- )
- kwargs['_spec_property_naming'] = kwargs.get(
- '_spec_property_naming', False
- )
- kwargs['_content_type'] = kwargs.get(
- '_content_type')
- kwargs['_host_index'] = kwargs.get('_host_index')
- kwargs['identity_id'] = \
- identity_id
- return self._create_identity_verification_endpoint.call_with_http_info(**kwargs)
-
def get(
self,
identity_id,
@@ -769,6 +674,7 @@ def get(
identity_id (str): ID of the `Identity` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -835,7 +741,7 @@ def list(
):
"""List Identities # noqa: E501
- Retrieves a list of `Identities`. # noqa: E501
+ Retrieve a list of `Identities`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -844,7 +750,7 @@ def list(
Keyword Args:
- sort (str): Specify key to be used for sorting the collection.. [optional]
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
after_cursor (str): Return every resource created after the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
id (str): Filter by `id`.. [optional]
@@ -858,6 +764,8 @@ def list(
last_name (str): Filter by the last name of the person associated to the `Identity`.. [optional]
title (str): Filter by the title if available.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional]
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -936,6 +844,7 @@ def list_associated_identities(
identity_id (str): ID of `Identity` to associate object with.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The number of entries to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
@@ -1008,7 +917,7 @@ def update(
):
"""Update an Identity # noqa: E501
- Update an existing `Identity`. If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](#operation/createMerchantVerification). # noqa: E501
+ Update an existing `Identity`. If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](/api/tag/Merchants/#tag/Merchants/operation/createMerchantVerification). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1019,6 +928,7 @@ def update(
identity_id (str): ID of the `Identity` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
update_identity_request (UpdateIdentityRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/instrument_updates_api.py b/finix/api/instrument_updates_api.py
index bcae549..7955cb3 100644
--- a/finix/api/instrument_updates_api.py
+++ b/finix/api/instrument_updates_api.py
@@ -74,6 +74,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'create_instrument_update_request',
],
'required': [],
@@ -90,12 +91,16 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'create_instrument_update_request':
(CreateInstrumentUpdateRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
},
'location_map': {
+ 'accept': 'header',
'create_instrument_update_request': 'body',
},
'collection_format_map': {
@@ -103,7 +108,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'multipart/form-data'
@@ -125,6 +130,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'instrument_updates_id',
+ 'accept',
'format',
],
'required': [
@@ -145,15 +151,19 @@ def __init__(self, api_client=None):
'openapi_types': {
'instrument_updates_id':
(str,),
+ 'accept':
+ (str,),
'format':
(str,),
},
'attribute_map': {
'instrument_updates_id': 'instrument_updates_id',
+ 'accept': 'Accept',
'format': 'format',
},
'location_map': {
'instrument_updates_id': 'path',
+ 'accept': 'header',
'format': 'query',
},
'collection_format_map': {
@@ -161,8 +171,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -182,6 +191,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'instrument_updates_id',
+ 'accept',
],
'required': [
'instrument_updates_id',
@@ -201,19 +211,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'instrument_updates_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'instrument_updates_id': 'instrument_updates_id',
+ 'accept': 'Accept',
},
'location_map': {
'instrument_updates_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -235,7 +249,8 @@ def create(
Keyword Args:
- create_instrument_update_request (CreateInstrumentUpdateRequest): . [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ create_instrument_update_request (CreateInstrumentUpdateRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -312,6 +327,7 @@ def download(
instrument_updates_id (str): The ID of the `instrument_updates` resource. This ID was returned when initially creating the `instrument_updates` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
format (str): Specify the format you'd like to download the response in (JSON is the only other format available for download).. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -380,7 +396,7 @@ def get(
):
"""Fetch an Instrument Update # noqa: E501
- Fetch a specific `instrument_update` from an `instrument_updates` resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater). # noqa: E501
+ Fetch a specific `instrument_update` from an `instrument_updates` resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -391,6 +407,7 @@ def get(
instrument_updates_id (str): The ID of the `instrument_update`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
diff --git a/finix/api/merchant_profiles_api.py b/finix/api/merchant_profiles_api.py
index 3cd264f..1ce3558 100644
--- a/finix/api/merchant_profiles_api.py
+++ b/finix/api/merchant_profiles_api.py
@@ -75,6 +75,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_profile_id',
+ 'accept',
],
'required': [
'merchant_profile_id',
@@ -94,19 +95,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_profile_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'merchant_profile_id': 'merchant_profile_id',
+ 'accept': 'Accept',
},
'location_map': {
'merchant_profile_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -125,6 +130,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'id',
'before_cursor',
'limit',
@@ -144,6 +150,8 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'id':
(str,),
'before_cursor':
@@ -154,12 +162,14 @@ def __init__(self, api_client=None):
(str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'id': 'id',
'before_cursor': 'before_cursor',
'limit': 'limit',
'after_cursor': 'after_cursor',
},
'location_map': {
+ 'accept': 'header',
'id': 'query',
'before_cursor': 'query',
'limit': 'query',
@@ -170,7 +180,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -190,6 +200,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_profile_id',
+ 'accept',
'update_merchant_profile_request',
],
'required': [
@@ -210,14 +221,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_profile_id':
(str,),
+ 'accept':
+ (str,),
'update_merchant_profile_request':
(UpdateMerchantProfileRequest,),
},
'attribute_map': {
'merchant_profile_id': 'merchant_profile_id',
+ 'accept': 'Accept',
},
'location_map': {
'merchant_profile_id': 'path',
+ 'accept': 'header',
'update_merchant_profile_request': 'body',
},
'collection_format_map': {
@@ -225,10 +240,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -252,6 +267,7 @@ def get(
merchant_profile_id (str): ID of `merchant_profile`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -327,6 +343,7 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
id (str): Filter by `id`.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
@@ -409,6 +426,7 @@ def update(
merchant_profile_id (str): ID of `merchant_profile`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
update_merchant_profile_request (UpdateMerchantProfileRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/merchants_api.py b/finix/api/merchants_api.py
index ea8b6c9..f8db7fd 100644
--- a/finix/api/merchants_api.py
+++ b/finix/api/merchants_api.py
@@ -79,6 +79,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'identity_id',
+ 'accept',
+ 'finix_version',
'create_merchant_underwriting_request',
],
'required': [
@@ -99,14 +101,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'identity_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_merchant_underwriting_request':
(CreateMerchantUnderwritingRequest,),
},
'attribute_map': {
'identity_id': 'identity_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'identity_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_merchant_underwriting_request': 'body',
},
'collection_format_map': {
@@ -114,28 +124,30 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
)
- self._create_merchant_verification_endpoint = finix.api_client.Endpoint(
+ self._create_endpoint = finix.api_client.Endpoint(
settings={
'response_type': (Verification,),
'auth': [
'BasicAuth'
],
'endpoint_path': '/merchants/{merchant_id}/verifications',
- 'operation_id': 'create_merchant_verification',
+ 'operation_id': 'create',
'http_method': 'POST',
'servers': None,
},
params_map={
'all': [
'merchant_id',
+ 'accept',
+ 'finix_version',
'create_verification_request',
],
'required': [
@@ -156,14 +168,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_verification_request':
(CreateVerificationRequest,),
},
'attribute_map': {
'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'merchant_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_verification_request': 'body',
},
'collection_format_map': {
@@ -171,10 +191,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -193,6 +213,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_id',
+ 'accept',
],
'required': [
'merchant_id',
@@ -212,19 +233,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
},
'location_map': {
'merchant_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -243,13 +268,15 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'id',
- 'created_at_gte',
- 'created_at_lte',
'after_cursor',
'before_cursor',
+ 'created_at_gte',
+ 'created_at_lte',
'limit',
- 'sort',
+ 'updated_at_gte',
+ 'updated_at_lte',
],
'required': [],
'nullable': [
@@ -265,45 +292,53 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'id':
+ 'accept':
(str,),
- 'created_at_gte':
- (str,),
- 'created_at_lte':
+ 'id':
(str,),
'after_cursor':
(str,),
'before_cursor':
(str,),
+ 'created_at_gte':
+ (str,),
+ 'created_at_lte':
+ (str,),
'limit':
(int,),
- 'sort':
+ 'updated_at_gte':
+ (str,),
+ 'updated_at_lte':
(str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'id': 'id',
- 'created_at_gte': 'created_at.gte',
- 'created_at_lte': 'created_at.lte',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
+ 'created_at_gte': 'created_at.gte',
+ 'created_at_lte': 'created_at.lte',
'limit': 'limit',
- 'sort': 'sort',
+ 'updated_at_gte': 'updated_at.gte',
+ 'updated_at_lte': 'updated_at.lte',
},
'location_map': {
+ 'accept': 'header',
'id': 'query',
- 'created_at_gte': 'query',
- 'created_at_lte': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
+ 'created_at_gte': 'query',
+ 'created_at_lte': 'query',
'limit': 'query',
- 'sort': 'query',
+ 'updated_at_gte': 'query',
+ 'updated_at_lte': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -323,6 +358,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_id',
+ 'accept',
+ 'finix_version',
'update_merchant_request',
],
'required': [
@@ -343,14 +380,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'update_merchant_request':
(UpdateMerchantRequest,),
},
'attribute_map': {
'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'merchant_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'update_merchant_request': 'body',
},
'collection_format_map': {
@@ -358,10 +403,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -374,7 +419,7 @@ def create(
):
"""Create a Merchant # noqa: E501
- Create a `Merchant` to start the underwriting (also called provisioning) process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities). > A bank account must be associated with the previously created `Identity` before a `Merchant` can be succefully onboarded and verified. `Merchant` resources can have three possible `onboarding_states`: 1. **PROVISIONING**: The request is pending (the state can change after two minutes). * `processing_enabled`: **False** * `settlement_enabled`: **False** 1. **APPROVED**: The `Merchant` has been approved and can begin processing payments. * `processing_enabled`: **True** * `settlement_enabled`: **True** 1. **REJECTED**: The `Merchant` was rejected by the processor because of invalid information or it failed a regulatory and/or compliance check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and [try verifying the `Merchant` again](#operation/createMerchantVerification). * `processing_enabled`: **False** * `settlement_enabled`: **False** > Provisioning a `Merchant` account is an asynchronous request. We recommend creating a [`Webhook`](#tag/Webhooks) to listen for the state change. # noqa: E501
+ Create a `Merchant` to start the underwriting (also called provisioning) process for your seller. `Merchants` must be created under an [`Identity`](/api/tag/Identities). A bank account must be associated with the previously created `Identity` before a `Merchant` can be successfully onboarded and verified. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -385,6 +430,8 @@ def create(
identity_id (str): ID of `Identity` to fetch.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_merchant_underwriting_request (CreateMerchantUnderwritingRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -446,24 +493,26 @@ def create(
identity_id
return self._create_endpoint.call_with_http_info(**kwargs)
- def create_merchant_verification(
+ def create(
self,
merchant_id,
**kwargs
):
"""Verify a Merchant # noqa: E501
- If the `onboarding_state` for a `Merchant` returns **FAILED**, correct the `Identity` information saved for the `Merchant`. Once corrected, try verifying (also called provisioning) the `Merchant` again with another request. # noqa: E501
+ Verify a `Merchant` if the `onboarding_state` for a `Merchant` returns **FAILED**, or if the correct the seller needs to update the saved in their information `Identity`. Related Guides: [Onboarding Process](/guides/onboarding/onboarding-process/#reverify-a-merchant) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_merchant_verification(merchant_id, async_req=True)
+ >>> thread = api.create(merchant_id, async_req=True)
>>> result = thread.get()
Args:
merchant_id (str): ID of `Merchant` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_verification_request (CreateVerificationRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -523,7 +572,7 @@ def create_merchant_verification(
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['merchant_id'] = \
merchant_id
- return self._create_merchant_verification_endpoint.call_with_http_info(**kwargs)
+ return self._create_endpoint.call_with_http_info(**kwargs)
def get(
self,
@@ -543,6 +592,7 @@ def get(
merchant_id (str): ID of `Merchant`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -618,13 +668,15 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
id (str): Filter by `id`.. [optional]
- created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
- created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
+ created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
+ created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
limit (int): The numbers of items to return.. [optional]
- sort (str): Specify key to be used for sorting the collection.. [optional]
+ updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional]
+ updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -692,7 +744,7 @@ def update(
):
"""Update a Merchant # noqa: E501
- Update a `Merchant` to: - Change the `Identity` information saved with the underlying processor - Enable Level 2/3 processing - Enable [Buyer Chages](/guides/payments/buyer-charges/) # noqa: E501
+ Update a `Merchant` to: - Change the `Identity` information saved with the underlying processor - [Enable Level 2/3 processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/) - Enable [buyer charges](/guides/payments/making-a-payment/buyer-charges/) - Disable a `Merchant` so the seller can't create new `Transfers` and `Authorizations`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -703,6 +755,8 @@ def update(
merchant_id (str): ID of `Merchant`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
update_merchant_request (UpdateMerchantRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/onboarding_forms_api.py b/finix/api/onboarding_forms_api.py
index 0255a56..c376605 100644
--- a/finix/api/onboarding_forms_api.py
+++ b/finix/api/onboarding_forms_api.py
@@ -105,8 +105,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'application/json'
@@ -128,6 +127,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'onboarding_form_id',
+ 'accept',
'create_onboarding_form_link_request',
],
'required': [
@@ -148,14 +148,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'onboarding_form_id':
(str,),
+ 'accept':
+ (str,),
'create_onboarding_form_link_request':
(CreateOnboardingFormLinkRequest,),
},
'attribute_map': {
'onboarding_form_id': 'onboarding_form_id',
+ 'accept': 'Accept',
},
'location_map': {
'onboarding_form_id': 'path',
+ 'accept': 'header',
'create_onboarding_form_link_request': 'body',
},
'collection_format_map': {
@@ -163,8 +167,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
'application/json'
@@ -186,6 +189,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'onboarding_form_id',
+ 'accept',
],
'required': [
'onboarding_form_id',
@@ -205,20 +209,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'onboarding_form_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'onboarding_form_id': 'onboarding_form_id',
+ 'accept': 'Accept',
},
'location_map': {
'onboarding_form_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/json',
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -231,7 +238,7 @@ def create(
):
"""Create an Onboarding Form # noqa: E501
- Create an onboarding_form with the name of the processor you plan to onboard users to and the links they get redirected to when completing or moving away from the Finix Onboarding Form. > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`. # noqa: E501
+ Create an `onboarding_form` with the name of the processor you plan to onboard users to and the links they` get redirected to when completing or moving away from the Finix Onboarding Form. Only **ROLE_PARTNER** credentials can be used to create an `onboarding_form`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -306,7 +313,7 @@ def create_link(
):
"""Create an Onboarding Form Link # noqa: E501
- You can use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form. # noqa: E501
+ Use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -317,6 +324,7 @@ def create_link(
onboarding_form_id (str): The ID of the `onboarding_form` resource.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
create_onboarding_form_link_request (CreateOnboardingFormLinkRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -396,6 +404,7 @@ def get(
onboarding_form_id (str): The id of the `onboarding_form`.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
diff --git a/finix/api/payment_instruments_api.py b/finix/api/payment_instruments_api.py
index d9889a8..5aa6401 100644
--- a/finix/api/payment_instruments_api.py
+++ b/finix/api/payment_instruments_api.py
@@ -29,7 +29,6 @@
from finix.model.error422_invalid_field_list import Error422InvalidFieldList
from finix.model.error_generic import ErrorGeneric
from finix.model.payment_instrument import PaymentInstrument
-from finix.model.payment_instrument_updates_list import PaymentInstrumentUpdatesList
from finix.model.payment_instruments_list import PaymentInstrumentsList
from finix.model.update_payment_instrument_request import UpdatePaymentInstrumentRequest
from finix.model.finix_utils import FinixList
@@ -109,10 +108,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -130,6 +129,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
+ 'finix_version',
'create_payment_instrument_request',
],
'required': [],
@@ -146,12 +147,20 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_payment_instrument_request':
(CreatePaymentInstrumentRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_payment_instrument_request': 'body',
},
'collection_format_map': {
@@ -159,10 +168,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -181,6 +190,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'payment_instrument_id',
+ 'accept',
],
'required': [
'payment_instrument_id',
@@ -200,85 +210,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'payment_instrument_id':
(str,),
- },
- 'attribute_map': {
- 'payment_instrument_id': 'payment_instrument_id',
- },
- 'location_map': {
- 'payment_instrument_id': 'path',
- },
- 'collection_format_map': {
- }
- },
- headers_map={
- 'accept': [
- 'application/hal+json'
- ],
- 'content_type': [],
- },
- api_client=api_client
- )
- self._list_updates_by_payment_instrument_id_endpoint = finix.api_client.Endpoint(
- settings={
- 'response_type': (PaymentInstrumentUpdatesList,),
- 'auth': [
- 'BasicAuth'
- ],
- 'endpoint_path': '/payment_instruments/{payment_instrument_id}/updates',
- 'operation_id': 'list_updates_by_payment_instrument_id',
- 'http_method': 'GET',
- 'servers': None,
- },
- params_map={
- 'all': [
- 'payment_instrument_id',
- 'limit',
- 'offset',
- 'page_size',
- ],
- 'required': [
- 'payment_instrument_id',
- ],
- 'nullable': [
- ],
- 'enum': [
- ],
- 'validation': [
- ]
- },
- root_map={
- 'validations': {
- },
- 'allowed_values': {
- },
- 'openapi_types': {
- 'payment_instrument_id':
+ 'accept':
(str,),
- 'limit':
- (int,),
- 'offset':
- (int,),
- 'page_size':
- (int,),
},
'attribute_map': {
'payment_instrument_id': 'payment_instrument_id',
- 'limit': 'limit',
- 'offset': 'offset',
- 'page_size': 'pageSize',
+ 'accept': 'Accept',
},
'location_map': {
'payment_instrument_id': 'path',
- 'limit': 'query',
- 'offset': 'query',
- 'page_size': 'query',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -297,6 +245,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'account_last4',
'account_routing_number',
'after_cursor',
@@ -307,11 +256,13 @@ def __init__(self, api_client=None):
'created_at_lte',
'expiration_month',
'expiration_year',
- 'last_four',
+ 'last4',
'limit',
'name',
'owner_identity_id',
'type',
+ 'tags_key',
+ 'tags_value',
],
'required': [],
'nullable': [
@@ -334,6 +285,8 @@ def __init__(self, api_client=None):
},
},
'openapi_types': {
+ 'accept':
+ (str,),
'account_last4':
(str,),
'account_routing_number':
@@ -354,7 +307,7 @@ def __init__(self, api_client=None):
(str,),
'expiration_year':
(str,),
- 'last_four':
+ 'last4':
(str,),
'limit':
(int,),
@@ -364,8 +317,13 @@ def __init__(self, api_client=None):
(str,),
'type':
(str,),
+ 'tags_key':
+ (str,),
+ 'tags_value':
+ (str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'account_last4': 'account_last4',
'account_routing_number': 'account_routing_number',
'after_cursor': 'after_cursor',
@@ -376,13 +334,16 @@ def __init__(self, api_client=None):
'created_at_lte': 'created_at.lte',
'expiration_month': 'expiration_month',
'expiration_year': 'expiration_year',
- 'last_four': 'last_four',
+ 'last4': 'last4',
'limit': 'limit',
'name': 'name',
'owner_identity_id': 'owner_identity_id',
'type': 'type',
+ 'tags_key': 'tags.key',
+ 'tags_value': 'tags.value',
},
'location_map': {
+ 'accept': 'header',
'account_last4': 'query',
'account_routing_number': 'query',
'after_cursor': 'query',
@@ -393,18 +354,20 @@ def __init__(self, api_client=None):
'created_at_lte': 'query',
'expiration_month': 'query',
'expiration_year': 'query',
- 'last_four': 'query',
+ 'last4': 'query',
'limit': 'query',
'name': 'query',
'owner_identity_id': 'query',
'type': 'query',
+ 'tags_key': 'query',
+ 'tags_value': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -424,6 +387,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'payment_instrument_id',
+ 'accept',
+ 'finix_version',
'update_payment_instrument_request',
],
'required': [
@@ -444,14 +409,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'payment_instrument_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'update_payment_instrument_request':
(UpdatePaymentInstrumentRequest,),
},
'attribute_map': {
'payment_instrument_id': 'payment_instrument_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'payment_instrument_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'update_payment_instrument_request': 'body',
},
'collection_format_map': {
@@ -459,10 +432,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -474,7 +447,7 @@ def create_apple_pay_session(
):
"""Create an Apple Pay Session # noqa: E501
- Create an `apple_pay_session` to process Apple Pay transactions on the web. To create an Apple Pay Session, pass the unique `validation_url` (provided by Apple) while creating an `apple_pay_sessions` resource. Finix returns a `merchantSession` object that you can use to create a payment. For more information, see [Apple Pay](/docs/guides/payments/alternative-payment-methods/apple-pay/). # noqa: E501
+ Create an `apple_pay_session` to process Apple Pay transactions on the web. To create an Apple Pay Session, pass the unique `validation_url` (provided by Apple) while creating an `apple_pay_sessions` resource. Finix returns a `merchantSession` object that you can use to create a payment. For more information, see [Apple Pay](/guides/payments/alternative-payment-methods/apple-pay/). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -548,7 +521,7 @@ def create(
):
"""Create a Payment Instrument # noqa: E501
- Create a `Payment Instrument` resource using a card or bank account. To accept payment details, review our guide on how to [tokenize cards using hosted fields](/guides/payments/tokenization-with-hosted-fields). - The creation of `Payment Instruments` directly via Finix's API should only be done for testing purposes. You must use the Hosted Tokenization fields or the javascript client to remain out of PCI scope. # noqa: E501
+ Create a `Payment Instrument` resource using a card or bank account. - The creation of `Payment Instruments` directly via Finix's API should only be done for testing purposes. You must use [our hosted fields](/guides/payments/making-a-payment/using-hosted-fields/) or the javascript client to remain out of PCI scope. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -557,7 +530,9 @@ def create(
Keyword Args:
- create_payment_instrument_request (CreatePaymentInstrumentRequest): . [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ create_payment_instrument_request (CreatePaymentInstrumentRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -634,6 +609,7 @@ def get(
payment_instrument_id (str): ID of object
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -694,89 +670,6 @@ def get(
payment_instrument_id
return self._get_endpoint.call_with_http_info(**kwargs)
- def list_updates_by_payment_instrument_id(
- self,
- payment_instrument_id,
- **kwargs
- ):
- """List Payment Instrument Updates # noqa: E501
-
- List the updates on a `Payment Instrument`. When using the [account updater](/guides/payments/account-updater), `Payment Instrument` details that are updated are represented by an `Update`. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
-
- >>> thread = api.list_updates_by_payment_instrument_id(payment_instrument_id, async_req=True)
- >>> result = thread.get()
-
- Args:
- payment_instrument_id (str): ID of `Payment Instrument` object.
-
- Keyword Args:
- limit (int): The number of entries to return.. [optional]
- offset (int): The number of items to skip before starting to collect the result set.. [optional]
- page_size (int): The size of the page.. [optional]
- _return_http_data_only (bool): response data without head status
- code and headers. Default is True.
- _preload_content (bool): if False, the urllib3.HTTPResponse object
- will be returned without reading/decoding response data.
- Default is True.
- _request_timeout (int/float/tuple): timeout setting for this request. If
- one number provided, it will be total request timeout. It can also
- be a pair (tuple) of (connection, read) timeouts.
- Default is None.
- _check_input_type (bool): specifies if type checking
- should be done one the data sent to the server.
- Default is True.
- _check_return_type (bool): specifies if type checking
- should be done one the data received from the server.
- Default is True.
- _spec_property_naming (bool): True if the variable names in the input data
- are serialized names, as specified in the OpenAPI document.
- False if the variable names in the input data
- are pythonic names, e.g. snake case (default)
- _content_type (str/None): force body content-type.
- Default is None and content-type will be predicted by allowed
- content-types and body.
- _host_index (int/None): specifies the index of the server
- that we want to use.
- Default is read from the configuration.
- async_req (bool): execute request asynchronously
-
- Returns:
- PaymentInstrumentUpdatesList
- If the method is called asynchronously, returns the request
- thread.
- """
- kwargs['async_req'] = kwargs.get(
- 'async_req', False
- )
- kwargs['_return_http_data_only'] = kwargs.get(
- '_return_http_data_only', True
- )
- kwargs['_preload_content'] = kwargs.get(
- '_preload_content', True
- )
- kwargs['_request_timeout'] = kwargs.get(
- '_request_timeout', None
- )
- kwargs['_check_input_type'] = kwargs.get(
- '_check_input_type', False
- )
- kwargs['_check_return_type'] = kwargs.get(
- '_check_return_type', False
- )
- kwargs['_spec_property_naming'] = kwargs.get(
- '_spec_property_naming', False
- )
- kwargs['_content_type'] = kwargs.get(
- '_content_type')
- kwargs['_host_index'] = kwargs.get('_host_index')
- kwargs['payment_instrument_id'] = \
- payment_instrument_id
- ret = self._list_updates_by_payment_instrument_id_endpoint.call_with_http_info(**kwargs)
- fl = FinixList(ret, self.list_updates_by_payment_instrument_id, **kwargs)
- return fl
-
def list(
self,
**kwargs
@@ -792,6 +685,7 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
account_last4 (str): Filter by the last 4 digits of the account if available.. [optional]
account_routing_number (str): Filter by the account routing number if available.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
@@ -802,11 +696,13 @@ def list(
created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
expiration_month (str): Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards.. [optional]
expiration_year (str): Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.. [optional]
- last_four (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional]
+ last4 (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional]
limit (int): The numbers of items to return.. [optional]
name (str): Filter by the name.. [optional]
owner_identity_id (str): Filter by the owner id of the associated `Identity`.. [optional]
type (str): Filter by the `Payment Instrument` type.. [optional]
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional]
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -874,7 +770,7 @@ def update(
):
"""Update a Payment Instrument # noqa: E501
- Update a `Payment Instrument`. # noqa: E501
+ Update a `Payment Instrument` to: - Change the **billing address** in case the account holder moved (`instrument_type`:**PAYMENT_CARD** only). - Disable the `Payment Instrument` resource so it can't be used in requests. - Update the `name` on the `Payment Instrument`. - Change the `tags`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -885,6 +781,8 @@ def update(
payment_instrument_id (str): ID of object
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
update_payment_instrument_request (UpdatePaymentInstrumentRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/payout_profiles_api.py b/finix/api/payout_profiles_api.py
new file mode 100644
index 0000000..2273902
--- /dev/null
+++ b/finix/api/payout_profiles_api.py
@@ -0,0 +1,608 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+import finix.api_client
+from finix.model_utils import ( # noqa: F401
+ check_allowed_values,
+ check_validations,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_and_convert_types
+)
+from finix.model.error401_unauthorized import Error401Unauthorized
+from finix.model.error403_forbidden_list import Error403ForbiddenList
+from finix.model.error404_not_found_list import Error404NotFoundList
+from finix.model.error406_not_acceptable import Error406NotAcceptable
+from finix.model.error422_invalid_field_list import Error422InvalidFieldList
+from finix.model.payout_profile import PayoutProfile
+from finix.model.payout_profiles_list import PayoutProfilesList
+from finix.model.update_payout_profile_request import UpdatePayoutProfileRequest
+from finix.model.finix_utils import FinixList
+
+from functools import wraps
+
+def operation_decorator(func):
+ @wraps(func)
+ def response_convert(*args, **kwargs):
+ ret = func(*args, **kwargs)
+ if hasattr(ret, 'embedded'):
+ tmp = ret.embedded
+ if isinstance(tmp, dict):
+ if len(tmp) == 1:
+ ret_0 = ''
+ ret_1 = ''
+ ret_2 = ''
+ for key in tmp:
+ ret_0 = tmp[key]
+ break
+ if hasattr(ret, 'page'):
+ ret_1 = ret.page
+ if hasattr(ret, 'links'):
+ ret_2 = ret.links
+ return (ret_0, ret_1, ret_2)
+
+ else:
+ return ret
+
+ return response_convert
+
+class PayoutProfilesApi(object):
+
+ def __init__(self, api_client=None):
+ if api_client is None:
+ api_client = finix.api_client.FinixClient()
+ self._api_client = api_client
+ self._get_by_merchant_id_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (PayoutProfile,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/merchants/{merchant_id}/payout_profile',
+ 'operation_id': 'get_by_merchant_id',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'merchant_id',
+ 'accept',
+ ],
+ 'required': [
+ 'merchant_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'merchant_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'merchant_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._get_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (PayoutProfile,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/payout_profiles/{payout_profile_id}',
+ 'operation_id': 'get',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'payout_profile_id',
+ 'accept',
+ ],
+ 'required': [
+ 'payout_profile_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'payout_profile_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'payout_profile_id': 'payout_profile_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'payout_profile_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._list_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (PayoutProfilesList,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/payout_profiles',
+ 'operation_id': 'list',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'after_cursor',
+ 'limit',
+ ],
+ 'required': [],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'after_cursor':
+ (str,),
+ 'limit':
+ (int,),
+ },
+ 'attribute_map': {
+ 'after_cursor': 'after_cursor',
+ 'limit': 'limit',
+ },
+ 'location_map': {
+ 'after_cursor': 'query',
+ 'limit': 'query',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._update_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (PayoutProfile,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/payout_profiles/{payout_profile_id}',
+ 'operation_id': 'update',
+ 'http_method': 'PUT',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'payout_profile_id',
+ 'accept',
+ 'update_payout_profile_request',
+ ],
+ 'required': [
+ 'payout_profile_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'payout_profile_id':
+ (str,),
+ 'accept':
+ (str,),
+ 'update_payout_profile_request':
+ (UpdatePayoutProfileRequest,),
+ },
+ 'attribute_map': {
+ 'payout_profile_id': 'payout_profile_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'payout_profile_id': 'path',
+ 'accept': 'header',
+ 'update_payout_profile_request': 'body',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [
+ 'application/json'
+ ]
+ },
+ api_client=api_client
+ )
+
+ def get_by_merchant_id(
+ self,
+ merchant_id,
+ **kwargs
+ ):
+ """Fetch Payout Profile by Merchant # noqa: E501
+
+ Fetch the the `Payout Profile` createrd for a specific `Merchant`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get_by_merchant_id(merchant_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ merchant_id (str): ID of the `Merchant`.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ PayoutProfile
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['merchant_id'] = \
+ merchant_id
+ return self._get_by_merchant_id_endpoint.call_with_http_info(**kwargs)
+
+ def get(
+ self,
+ payout_profile_id,
+ **kwargs
+ ):
+ """Fetch a Payout Profile # noqa: E501
+
+ Retrieve the details of a previously created `Payout Profile`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get(payout_profile_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ payout_profile_id (str): ID of the `Payout Profile`.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ PayoutProfile
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['payout_profile_id'] = \
+ payout_profile_id
+ return self._get_endpoint.call_with_http_info(**kwargs)
+
+ def list(
+ self,
+ **kwargs
+ ):
+ """List Payout Profiles # noqa: E501
+
+ List all `Payout Profiles`. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.list(async_req=True)
+ >>> result = thread.get()
+
+
+ Keyword Args:
+ after_cursor (str): Return every resource created after the cursor value.. [optional]
+ limit (int): The numbers of items to return.. [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ PayoutProfilesList
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ ret = self._list_endpoint.call_with_http_info(**kwargs)
+ fl = FinixList(ret, self.list, **kwargs)
+ return fl
+
+ def update(
+ self,
+ payout_profile_id,
+ **kwargs
+ ):
+ """Update a Payout Profile # noqa: E501
+
+ Update a `Payout Profile` to configure how fees and payouts get calculated, credited, and debited. By default, `Merchants` get configured with daily net settlements. Payouts get submitted using the **Next-Day ACH** `rail`. Contact [Finix Support](/guides/getting-started/support-at-finix/) to configure payouts on a custom schedule. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.update(payout_profile_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ payout_profile_id (str): ID of the `Payout Profile`.
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ update_payout_profile_request (UpdatePayoutProfileRequest): [optional]
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ PayoutProfile
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['payout_profile_id'] = \
+ payout_profile_id
+ return self._update_endpoint.call_with_http_info(**kwargs)
+
diff --git a/finix/api/settlements_api.py b/finix/api/settlements_api.py
index 00be706..5787695 100644
--- a/finix/api/settlements_api.py
+++ b/finix/api/settlements_api.py
@@ -19,13 +19,12 @@
none_type,
validate_and_convert_types
)
-from finix.model.create_settlement_request import CreateSettlementRequest
+from finix.model.close_settlement import CloseSettlement
from finix.model.error401_unauthorized import Error401Unauthorized
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error404_not_found_list import Error404NotFoundList
from finix.model.error406_not_acceptable import Error406NotAcceptable
from finix.model.error422_invalid_field_list import Error422InvalidFieldList
-from finix.model.error_generic import ErrorGeneric
from finix.model.remove_settlement_transfer import RemoveSettlementTransfer
from finix.model.settlement import Settlement
from finix.model.settlements_list import SettlementsList
@@ -65,24 +64,26 @@ def __init__(self, api_client=None):
if api_client is None:
api_client = finix.api_client.FinixClient()
self._api_client = api_client
- self._create_endpoint = finix.api_client.Endpoint(
+ self._put_endpoint = finix.api_client.Endpoint(
settings={
'response_type': (Settlement,),
'auth': [
'BasicAuth'
],
- 'endpoint_path': '/identities/{identity_id}/settlements',
- 'operation_id': 'create',
- 'http_method': 'POST',
+ 'endpoint_path': '/settlements/{settlement_id}',
+ 'operation_id': 'put',
+ 'http_method': 'PUT',
'servers': None,
},
params_map={
'all': [
- 'identity_id',
- 'create_settlement_request',
+ 'settlement_id',
+ 'accept',
+ 'finix_version',
+ 'close_settlement',
],
'required': [
- 'identity_id',
+ 'settlement_id',
],
'nullable': [
],
@@ -97,27 +98,35 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'identity_id':
+ 'settlement_id':
+ (str,),
+ 'accept':
(str,),
- 'create_settlement_request':
- (CreateSettlementRequest,),
+ 'finix_version':
+ (str,),
+ 'close_settlement':
+ (CloseSettlement,),
},
'attribute_map': {
- 'identity_id': 'identity_id',
+ 'settlement_id': 'settlement_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
- 'identity_id': 'path',
- 'create_settlement_request': 'body',
+ 'settlement_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
+ 'close_settlement': 'body',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -136,6 +145,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'settlement_id',
+ 'accept',
],
'required': [
'settlement_id',
@@ -155,19 +165,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'settlement_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'settlement_id': 'settlement_id',
+ 'accept': 'Accept',
},
'location_map': {
'settlement_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -187,9 +201,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'settlement_id',
+ 'accept',
'limit',
- 'after_cursor',
- 'before_cursor',
],
'required': [
'settlement_id',
@@ -209,31 +222,27 @@ def __init__(self, api_client=None):
'openapi_types': {
'settlement_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
- 'after_cursor':
- (str,),
- 'before_cursor':
- (str,),
},
'attribute_map': {
'settlement_id': 'settlement_id',
+ 'accept': 'Accept',
'limit': 'limit',
- 'after_cursor': 'after_cursor',
- 'before_cursor': 'before_cursor',
},
'location_map': {
'settlement_id': 'path',
+ 'accept': 'header',
'limit': 'query',
- 'after_cursor': 'query',
- 'before_cursor': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -253,9 +262,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'settlement_id',
+ 'accept',
'limit',
- 'after_cursor',
- 'before_cursor',
],
'required': [
'settlement_id',
@@ -275,31 +283,27 @@ def __init__(self, api_client=None):
'openapi_types': {
'settlement_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
- 'after_cursor':
- (str,),
- 'before_cursor':
- (str,),
},
'attribute_map': {
'settlement_id': 'settlement_id',
+ 'accept': 'Accept',
'limit': 'limit',
- 'after_cursor': 'after_cursor',
- 'before_cursor': 'before_cursor',
},
'location_map': {
'settlement_id': 'path',
+ 'accept': 'header',
'limit': 'query',
- 'after_cursor': 'query',
- 'before_cursor': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -320,17 +324,21 @@ def __init__(self, api_client=None):
'all': [
'created_at_gte',
'created_at_lte',
- 'updated_at_gte',
- 'updated_at_lte',
- 'id',
- 'limit',
- 'after_cursor',
- 'before_cursor',
+ 'amount',
+ 'amount_gt',
+ 'amount_gte',
+ 'amount_lt',
+ 'amount_lte',
+ 'status',
+ 'transfer_id',
+ 'funding_transfer_id',
+ 'accept',
],
'required': [],
'nullable': [
],
'enum': [
+ 'status',
],
'validation': [
]
@@ -339,51 +347,69 @@ def __init__(self, api_client=None):
'validations': {
},
'allowed_values': {
+ ('status',): {
+
+ "PENDING": "PENDING",
+ "AWAITING_APPROVAL": "AWAITING_APPROVAL",
+ "APPROVED": "APPROVED"
+ },
},
'openapi_types': {
'created_at_gte':
(str,),
'created_at_lte':
(str,),
- 'updated_at_gte':
- (str,),
- 'updated_at_lte':
+ 'amount':
+ (int,),
+ 'amount_gt':
+ (int,),
+ 'amount_gte':
+ (int,),
+ 'amount_lt':
+ (int,),
+ 'amount_lte':
+ (int,),
+ 'status':
(str,),
- 'id':
+ 'transfer_id':
(str,),
- 'limit':
- (int,),
- 'after_cursor':
+ 'funding_transfer_id':
(str,),
- 'before_cursor':
+ 'accept':
(str,),
},
'attribute_map': {
'created_at_gte': 'created_at.gte',
'created_at_lte': 'created_at.lte',
- 'updated_at_gte': 'updated_at.gte',
- 'updated_at_lte': 'updated_at.lte',
- 'id': 'id',
- 'limit': 'limit',
- 'after_cursor': 'after_cursor',
- 'before_cursor': 'before_cursor',
+ 'amount': 'amount',
+ 'amount_gt': 'amount.gt',
+ 'amount_gte': 'amount.gte',
+ 'amount_lt': 'amount.lt',
+ 'amount_lte': 'amount.lte',
+ 'status': 'status',
+ 'transfer_id': 'transfer_id',
+ 'funding_transfer_id': 'funding_transfer_id',
+ 'accept': 'Accept',
},
'location_map': {
'created_at_gte': 'query',
'created_at_lte': 'query',
- 'updated_at_gte': 'query',
- 'updated_at_lte': 'query',
- 'id': 'query',
- 'limit': 'query',
- 'after_cursor': 'query',
- 'before_cursor': 'query',
+ 'amount': 'query',
+ 'amount_gt': 'query',
+ 'amount_gte': 'query',
+ 'amount_lt': 'query',
+ 'amount_lte': 'query',
+ 'status': 'query',
+ 'transfer_id': 'query',
+ 'funding_transfer_id': 'query',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -403,6 +429,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'settlement_id',
+ 'accept',
'remove_settlement_transfer',
],
'required': [
@@ -423,14 +450,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'settlement_id':
(str,),
+ 'accept':
+ (str,),
'remove_settlement_transfer':
(RemoveSettlementTransfer,),
},
'attribute_map': {
'settlement_id': 'settlement_id',
+ 'accept': 'Accept',
},
'location_map': {
'settlement_id': 'path',
+ 'accept': 'header',
'remove_settlement_transfer': 'body',
},
'collection_format_map': {
@@ -438,34 +469,36 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
)
- def create(
+ def put(
self,
- identity_id,
+ settlement_id,
**kwargs
):
- """Close Current Active Settlement # noqa: E501
+ """Close a Settlement # noqa: E501
- Close the currently accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the merchant's bank account. Related Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement) # noqa: E501
+ Close an accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close a specific `settlement`. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team](mailto:support@finixpayments.com). - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the seller's bank account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create(identity_id, async_req=True)
+ >>> thread = api.put(settlement_id, async_req=True)
>>> result = thread.get()
Args:
- identity_id (str): ID of the `Identity` for the merchant you want to settle.
+ settlement_id (str): ID of `Settlement` object.
Keyword Args:
- create_settlement_request (CreateSettlementRequest): [optional]
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
+ close_settlement (CloseSettlement): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -522,9 +555,9 @@ def create(
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
- kwargs['identity_id'] = \
- identity_id
- return self._create_endpoint.call_with_http_info(**kwargs)
+ kwargs['settlement_id'] = \
+ settlement_id
+ return self._put_endpoint.call_with_http_info(**kwargs)
def get(
self,
@@ -544,6 +577,7 @@ def get(
settlement_id (str): ID of `Settlement` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -622,9 +656,8 @@ def list_funding_transfers(
settlement_id (str): ID of `Settlement` object.
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
- after_cursor (str): Return every resource created after the cursor value.. [optional]
- before_cursor (str): Return every resource created before the cursor value.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -692,7 +725,7 @@ def list_transfers_by_settlement_id(
settlement_id,
**kwargs
):
- """List Settlement Transfers # noqa: E501
+ """List all Transfers in a Settlement # noqa: E501
Retrieve a list of every `Transfer` in a `Settlement` that has `type` **DEBIT** or **REFUND**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -705,9 +738,8 @@ def list_transfers_by_settlement_id(
settlement_id (str): ID of `Settlement` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
- after_cursor (str): Return every resource created after the cursor value.. [optional]
- before_cursor (str): Return every resource created before the cursor value.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -787,12 +819,15 @@ def list(
Keyword Args:
created_at_gte (str): Filter where `created_at` is after the given date.. [optional]
created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
- updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional]
- updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional]
- id (str): Filter by `id`.. [optional]
- limit (int): The numbers of items to return.. [optional]
- after_cursor (str): Return every resource created after the cursor value.. [optional]
- before_cursor (str): Return every resource created before the cursor value.. [optional]
+ amount (int): Filter by an amount equal to the given value.. [optional]
+ amount_gt (int): Filter by an amount greater than.. [optional]
+ amount_gte (int): Filter by an amount greater than or equal.. [optional]
+ amount_lt (int): Filter by an amount less than.. [optional]
+ amount_lte (int): Filter by an amount less than or equal.. [optional]
+ status (str): Filter by the status of the `Settlement`. Available values include:
- **PENDING**
- **STAGED**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED**. For more information, see [Payouts](/docs/guides/payouts/payouts/).. [optional]
+ transfer_id (str): Filter by a `transfer_id` a `Settlement` has accrued. Please note this filter is only available for non-versioned requests, or requests using `-H 'Finix-Version: 2018-01-01'`. We're actively working on making this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).. [optional]
+ funding_transfer_id (str): Filter by a `funding_transfer` a `Settlement` has created.. [optional]
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -871,6 +906,7 @@ def remove_transfers_from_settlement(
settlement_id (str): ID of `Settlement` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
remove_settlement_transfer (RemoveSettlementTransfer): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/split_transfers_api.py b/finix/api/split_transfers_api.py
new file mode 100644
index 0000000..18210db
--- /dev/null
+++ b/finix/api/split_transfers_api.py
@@ -0,0 +1,333 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+import finix.api_client
+from finix.model_utils import ( # noqa: F401
+ check_allowed_values,
+ check_validations,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_and_convert_types
+)
+from finix.model.error401_unauthorized import Error401Unauthorized
+from finix.model.error403_forbidden_list import Error403ForbiddenList
+from finix.model.error404_not_found_list import Error404NotFoundList
+from finix.model.error406_not_acceptable import Error406NotAcceptable
+from finix.model.split_transfer import SplitTransfer
+from finix.model.transfers_list import TransfersList
+from finix.model.finix_utils import FinixList
+
+from functools import wraps
+
+def operation_decorator(func):
+ @wraps(func)
+ def response_convert(*args, **kwargs):
+ ret = func(*args, **kwargs)
+ if hasattr(ret, 'embedded'):
+ tmp = ret.embedded
+ if isinstance(tmp, dict):
+ if len(tmp) == 1:
+ ret_0 = ''
+ ret_1 = ''
+ ret_2 = ''
+ for key in tmp:
+ ret_0 = tmp[key]
+ break
+ if hasattr(ret, 'page'):
+ ret_1 = ret.page
+ if hasattr(ret, 'links'):
+ ret_2 = ret.links
+ return (ret_0, ret_1, ret_2)
+
+ else:
+ return ret
+
+ return response_convert
+
+class SplitTransfersApi(object):
+
+ def __init__(self, api_client=None):
+ if api_client is None:
+ api_client = finix.api_client.FinixClient()
+ self._api_client = api_client
+ self._get_split_transfer_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (SplitTransfer,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/split_transfers/{split_transfer_id}',
+ 'operation_id': 'get_split_transfer',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'split_transfer_id',
+ 'accept',
+ ],
+ 'required': [
+ 'split_transfer_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'split_transfer_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'split_transfer_id': 'split_transfer_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'split_transfer_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+ self._get_split_transfer_fees_endpoint = finix.api_client.Endpoint(
+ settings={
+ 'response_type': (TransfersList,),
+ 'auth': [
+ 'BasicAuth'
+ ],
+ 'endpoint_path': '/split_transfers/{split_transfer_id}/fees',
+ 'operation_id': 'get_split_transfer_fees',
+ 'http_method': 'GET',
+ 'servers': None,
+ },
+ params_map={
+ 'all': [
+ 'split_transfer_id',
+ 'accept',
+ ],
+ 'required': [
+ 'split_transfer_id',
+ ],
+ 'nullable': [
+ ],
+ 'enum': [
+ ],
+ 'validation': [
+ ]
+ },
+ root_map={
+ 'validations': {
+ },
+ 'allowed_values': {
+ },
+ 'openapi_types': {
+ 'split_transfer_id':
+ (str,),
+ 'accept':
+ (str,),
+ },
+ 'attribute_map': {
+ 'split_transfer_id': 'split_transfer_id',
+ 'accept': 'Accept',
+ },
+ 'location_map': {
+ 'split_transfer_id': 'path',
+ 'accept': 'header',
+ },
+ 'collection_format_map': {
+ }
+ },
+ headers_map={
+ 'accept': [
+ 'application/json'
+ ],
+ 'content_type': [],
+ },
+ api_client=api_client
+ )
+
+ def get_split_transfer(
+ self,
+ split_transfer_id,
+ **kwargs
+ ):
+ """Fetch a Split Transfer # noqa: E501
+
+ Fetch a `split_transfer` that was created from a split transaction. For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/). # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get_split_transfer(split_transfer_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ split_transfer_id (str):
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ SplitTransfer
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['split_transfer_id'] = \
+ split_transfer_id
+ return self._get_split_transfer_endpoint.call_with_http_info(**kwargs)
+
+ def get_split_transfer_fees(
+ self,
+ split_transfer_id,
+ **kwargs
+ ):
+ """Fetch Split Transfer Fees # noqa: E501
+
+ Fetch the fees associated with a `split_transfer`. For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/). # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get_split_transfer_fees(split_transfer_id, async_req=True)
+ >>> result = thread.get()
+
+ Args:
+ split_transfer_id (str):
+
+ Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ _return_http_data_only (bool): response data without head status
+ code and headers. Default is True.
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
+ will be returned without reading/decoding response data.
+ Default is True.
+ _request_timeout (int/float/tuple): timeout setting for this request. If
+ one number provided, it will be total request timeout. It can also
+ be a pair (tuple) of (connection, read) timeouts.
+ Default is None.
+ _check_input_type (bool): specifies if type checking
+ should be done one the data sent to the server.
+ Default is True.
+ _check_return_type (bool): specifies if type checking
+ should be done one the data received from the server.
+ Default is True.
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _content_type (str/None): force body content-type.
+ Default is None and content-type will be predicted by allowed
+ content-types and body.
+ _host_index (int/None): specifies the index of the server
+ that we want to use.
+ Default is read from the configuration.
+ async_req (bool): execute request asynchronously
+
+ Returns:
+ TransfersList
+ If the method is called asynchronously, returns the request
+ thread.
+ """
+ kwargs['async_req'] = kwargs.get(
+ 'async_req', False
+ )
+ kwargs['_return_http_data_only'] = kwargs.get(
+ '_return_http_data_only', True
+ )
+ kwargs['_preload_content'] = kwargs.get(
+ '_preload_content', True
+ )
+ kwargs['_request_timeout'] = kwargs.get(
+ '_request_timeout', None
+ )
+ kwargs['_check_input_type'] = kwargs.get(
+ '_check_input_type', False
+ )
+ kwargs['_check_return_type'] = kwargs.get(
+ '_check_return_type', False
+ )
+ kwargs['_spec_property_naming'] = kwargs.get(
+ '_spec_property_naming', False
+ )
+ kwargs['_content_type'] = kwargs.get(
+ '_content_type')
+ kwargs['_host_index'] = kwargs.get('_host_index')
+ kwargs['split_transfer_id'] = \
+ split_transfer_id
+ return self._get_split_transfer_fees_endpoint.call_with_http_info(**kwargs)
+
diff --git a/finix/api/transfers_api.py b/finix/api/transfers_api.py
index 1214dcd..1dc1c79 100644
--- a/finix/api/transfers_api.py
+++ b/finix/api/transfers_api.py
@@ -79,6 +79,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
+ 'finix_version',
'create_transfer_request',
],
'required': [],
@@ -95,12 +97,20 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_transfer_request':
(CreateTransferRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_transfer_request': 'body',
},
'collection_format_map': {
@@ -108,10 +118,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -130,6 +140,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'transfer_id',
+ 'finix_version',
'create_reversal_request',
],
'required': [
@@ -150,14 +161,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'transfer_id':
(str,),
+ 'finix_version':
+ (str,),
'create_reversal_request':
(CreateReversalRequest,),
},
'attribute_map': {
'transfer_id': 'transfer_id',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'transfer_id': 'path',
+ 'finix_version': 'header',
'create_reversal_request': 'body',
},
'collection_format_map': {
@@ -165,10 +180,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -187,6 +202,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'transfer_id',
+ 'accept',
],
'required': [
'transfer_id',
@@ -206,19 +222,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'transfer_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'transfer_id': 'transfer_id',
+ 'accept': 'Accept',
},
'location_map': {
'transfer_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -238,6 +258,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'transfer_id',
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -260,6 +281,8 @@ def __init__(self, api_client=None):
'openapi_types': {
'transfer_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -269,12 +292,14 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'transfer_id': 'transfer_id',
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
'transfer_id': 'path',
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -284,7 +309,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -303,7 +328,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
- 'sort',
+ 'accept',
'after_cursor',
'limit',
'amount',
@@ -315,9 +340,9 @@ def __init__(self, api_client=None):
'created_at_lte',
'idempotency_id',
'id',
- 'state',
'ready_to_settle_at_gte',
'ready_to_settle_at_lte',
+ 'state',
'statement_descriptor',
'trace_id',
'updated_at_gte',
@@ -335,6 +360,8 @@ def __init__(self, api_client=None):
'merchant_processor_id',
'type',
'before_cursor',
+ 'tags_key',
+ 'tags_value',
],
'required': [],
'nullable': [
@@ -368,7 +395,7 @@ def __init__(self, api_client=None):
},
},
'openapi_types': {
- 'sort':
+ 'accept':
(str,),
'after_cursor':
(str,),
@@ -392,12 +419,12 @@ def __init__(self, api_client=None):
(str,),
'id':
(str,),
- 'state':
- (str,),
'ready_to_settle_at_gte':
(str,),
'ready_to_settle_at_lte':
(str,),
+ 'state':
+ (str,),
'statement_descriptor':
(int,),
'trace_id':
@@ -432,9 +459,13 @@ def __init__(self, api_client=None):
(str,),
'before_cursor':
(str,),
+ 'tags_key':
+ (str,),
+ 'tags_value':
+ (str,),
},
'attribute_map': {
- 'sort': 'sort',
+ 'accept': 'Accept',
'after_cursor': 'after_cursor',
'limit': 'limit',
'amount': 'amount',
@@ -446,9 +477,9 @@ def __init__(self, api_client=None):
'created_at_lte': 'created_at.lte',
'idempotency_id': 'idempotency_id',
'id': 'id',
- 'state': 'state',
'ready_to_settle_at_gte': 'ready_to_settle_at.gte',
'ready_to_settle_at_lte': 'ready_to_settle_at.lte',
+ 'state': 'state',
'statement_descriptor': 'statement_descriptor',
'trace_id': 'trace_id',
'updated_at_gte': 'updated_at.gte',
@@ -466,9 +497,11 @@ def __init__(self, api_client=None):
'merchant_processor_id': 'merchant_processor_id',
'type': 'type',
'before_cursor': 'before_cursor',
+ 'tags_key': 'tags.key',
+ 'tags_value': 'tags.value',
},
'location_map': {
- 'sort': 'query',
+ 'accept': 'header',
'after_cursor': 'query',
'limit': 'query',
'amount': 'query',
@@ -480,9 +513,9 @@ def __init__(self, api_client=None):
'created_at_lte': 'query',
'idempotency_id': 'query',
'id': 'query',
- 'state': 'query',
'ready_to_settle_at_gte': 'query',
'ready_to_settle_at_lte': 'query',
+ 'state': 'query',
'statement_descriptor': 'query',
'trace_id': 'query',
'updated_at_gte': 'query',
@@ -500,13 +533,15 @@ def __init__(self, api_client=None):
'merchant_processor_id': 'query',
'type': 'query',
'before_cursor': 'query',
+ 'tags_key': 'query',
+ 'tags_value': 'query',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -526,6 +561,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'transfer_id',
+ 'accept',
'update_transfer_request',
],
'required': [
@@ -546,14 +582,18 @@ def __init__(self, api_client=None):
'openapi_types': {
'transfer_id':
(str,),
+ 'accept':
+ (str,),
'update_transfer_request':
(UpdateTransferRequest,),
},
'attribute_map': {
'transfer_id': 'transfer_id',
+ 'accept': 'Accept',
},
'location_map': {
'transfer_id': 'path',
+ 'accept': 'header',
'update_transfer_request': 'body',
},
'collection_format_map': {
@@ -561,10 +601,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -576,7 +616,7 @@ def create(
):
"""Create a Transfer # noqa: E501
- Create a `Transfer`. > By default, Finix implements a 3 (business) day delay when debiting bank accounts (i.e. eChecks). # noqa: E501
+ Create a `Transfer`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -585,6 +625,8 @@ def create(
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_transfer_request (CreateTransferRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -651,7 +693,7 @@ def create_transfer_reversal(
):
"""Refund or Reverse a Transfer # noqa: E501
- Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**. The refund can get delivered in most cases without the physical card. The card only needs to be swiped (to receive the refund) when: - The payment type is **DEBIT**, and the transaction is no longer in the Settlement batch. - The payment type is **CREDIT**, and the transaction is no longer in the batch and is older than 45 days. # noqa: E501
+ Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**. Related Guides: [Refunding Payments](/guides/after-the-payment/refunding-and-cancelling-payments/) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -662,6 +704,7 @@ def create_transfer_reversal(
transfer_id (str): ID of `Transfer` object.
Keyword Args:
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_reversal_request (CreateReversalRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -741,6 +784,7 @@ def get(
transfer_id (str): ID of `Transfer` resource.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -819,6 +863,7 @@ def list_transfers_reversals(
transfer_id (str): ID of `Transfer` object.
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The number of entries to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
@@ -899,7 +944,7 @@ def list(
Keyword Args:
- sort (str): Specify key to be used for sorting the collection.. [optional]
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
after_cursor (str): Return every resource created after the cursor value.. [optional]
limit (int): The numbers of items to return.. [optional]
amount (int): Filter by an amount equal to the given value.. [optional]
@@ -911,9 +956,9 @@ def list(
created_at_lte (str): Filter where `created_at` is before the given date.. [optional]
idempotency_id (str): Filter by `idempotency_id`.. [optional]
id (str): Filter by `id`.. [optional]
+ ready_to_settle_at_gte (str): Filter where `ready_to_settle_at` is after the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional]
+ ready_to_settle_at_lte (str): Filter where `ready_to_settle_at` is before the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional]
state (str): Filter by Transaction state.. [optional]
- ready_to_settle_at_gte (str): Filter by `ready_to_settle_at`.. [optional]
- ready_to_settle_at_lte (str): Filter by `ready_to_settle_at`.. [optional]
statement_descriptor (int): Filter by `statement_descriptor`.. [optional]
trace_id (str): Filter by `trace_id`.. [optional]
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional]
@@ -931,6 +976,8 @@ def list(
merchant_processor_id (str): Filter by `Processor` ID.. [optional]
type (str): Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional]
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1009,6 +1056,7 @@ def update(
transfer_id (str): ID of `Transfer` resource.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
update_transfer_request (UpdateTransferRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api/verifications_api.py b/finix/api/verifications_api.py
index a563c9c..e4d55b1 100644
--- a/finix/api/verifications_api.py
+++ b/finix/api/verifications_api.py
@@ -19,13 +19,10 @@
none_type,
validate_and_convert_types
)
-from finix.model.create_verification_request import CreateVerificationRequest
from finix.model.error401_unauthorized import Error401Unauthorized
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error404_not_found_list import Error404NotFoundList
from finix.model.error406_not_acceptable import Error406NotAcceptable
-from finix.model.error422_invalid_field_list import Error422InvalidFieldList
-from finix.model.error_generic import ErrorGeneric
from finix.model.verification import Verification
from finix.model.verifications_list import VerificationsList
from finix.model.finix_utils import FinixList
@@ -63,56 +60,6 @@ def __init__(self, api_client=None):
if api_client is None:
api_client = finix.api_client.FinixClient()
self._api_client = api_client
- self._create_endpoint = finix.api_client.Endpoint(
- settings={
- 'response_type': (Verification,),
- 'auth': [
- 'BasicAuth'
- ],
- 'endpoint_path': '/verifications',
- 'operation_id': 'create',
- 'http_method': 'POST',
- 'servers': None,
- },
- params_map={
- 'all': [
- 'create_verification_request',
- ],
- 'required': [],
- 'nullable': [
- ],
- 'enum': [
- ],
- 'validation': [
- ]
- },
- root_map={
- 'validations': {
- },
- 'allowed_values': {
- },
- 'openapi_types': {
- 'create_verification_request':
- (CreateVerificationRequest,),
- },
- 'attribute_map': {
- },
- 'location_map': {
- 'create_verification_request': 'body',
- },
- 'collection_format_map': {
- }
- },
- headers_map={
- 'accept': [
- 'application/hal+json'
- ],
- 'content_type': [
- 'application/hal+json'
- ]
- },
- api_client=api_client
- )
self._get_endpoint = finix.api_client.Endpoint(
settings={
'response_type': (Verification,),
@@ -127,6 +74,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'verification_id',
+ 'accept',
],
'required': [
'verification_id',
@@ -146,19 +94,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'verification_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'verification_id': 'verification_id',
+ 'accept': 'Accept',
},
'location_map': {
'verification_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -178,6 +130,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'merchant_id',
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -200,6 +153,8 @@ def __init__(self, api_client=None):
'openapi_types': {
'merchant_id':
(str,),
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -209,12 +164,14 @@ def __init__(self, api_client=None):
},
'attribute_map': {
'merchant_id': 'merchant_id',
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
'merchant_id': 'path',
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -224,7 +181,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -236,21 +193,22 @@ def __init__(self, api_client=None):
'auth': [
'BasicAuth'
],
- 'endpoint_path': '/payment_instruments/{payment_instrument_id}/verifications',
+ 'endpoint_path': '/payment_instruments/{payment_instrument_id_verify}',
'operation_id': 'list_by_payment_instrument_id',
'http_method': 'GET',
'servers': None,
},
params_map={
'all': [
- 'payment_instrument_id',
+ 'payment_instrument_id_verify',
+ 'accept',
'limit',
'offset',
'page_number',
'page_size',
],
'required': [
- 'payment_instrument_id',
+ 'payment_instrument_id_verify',
],
'nullable': [
],
@@ -265,7 +223,9 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
- 'payment_instrument_id':
+ 'payment_instrument_id_verify':
+ (str,),
+ 'accept':
(str,),
'limit':
(int,),
@@ -277,14 +237,16 @@ def __init__(self, api_client=None):
(int,),
},
'attribute_map': {
- 'payment_instrument_id': 'payment_instrument_id',
+ 'payment_instrument_id_verify': 'payment_instrument_id_verify',
+ 'accept': 'Accept',
'limit': 'limit',
'offset': 'offset',
'page_number': 'pageNumber',
'page_size': 'pageSize',
},
'location_map': {
- 'payment_instrument_id': 'path',
+ 'payment_instrument_id_verify': 'path',
+ 'accept': 'header',
'limit': 'query',
'offset': 'query',
'page_number': 'query',
@@ -295,7 +257,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -314,6 +276,7 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
'limit',
'after_cursor',
'before_cursor',
@@ -332,6 +295,8 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
'limit':
(int,),
'after_cursor':
@@ -340,11 +305,13 @@ def __init__(self, api_client=None):
(str,),
},
'attribute_map': {
+ 'accept': 'Accept',
'limit': 'limit',
'after_cursor': 'after_cursor',
'before_cursor': 'before_cursor',
},
'location_map': {
+ 'accept': 'header',
'limit': 'query',
'after_cursor': 'query',
'before_cursor': 'query',
@@ -354,87 +321,13 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
api_client=api_client
)
- def create(
- self,
- **kwargs
- ):
- """Create a Merchant Verification # noqa: E501
-
- Create a `Verification` to verify a merchant's `Identity`. Verifications can also be created directly on the resources you want to verify: - `POST /merchants/{merchant_id}/verifications` Verify `Payment Instruments` directly on the resource: - `POST /payment_instruments/{payment_instrument_id}/verifications` # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
-
- >>> thread = api.create(async_req=True)
- >>> result = thread.get()
-
-
- Keyword Args:
- create_verification_request (CreateVerificationRequest): [optional]
- _return_http_data_only (bool): response data without head status
- code and headers. Default is True.
- _preload_content (bool): if False, the urllib3.HTTPResponse object
- will be returned without reading/decoding response data.
- Default is True.
- _request_timeout (int/float/tuple): timeout setting for this request. If
- one number provided, it will be total request timeout. It can also
- be a pair (tuple) of (connection, read) timeouts.
- Default is None.
- _check_input_type (bool): specifies if type checking
- should be done one the data sent to the server.
- Default is True.
- _check_return_type (bool): specifies if type checking
- should be done one the data received from the server.
- Default is True.
- _spec_property_naming (bool): True if the variable names in the input data
- are serialized names, as specified in the OpenAPI document.
- False if the variable names in the input data
- are pythonic names, e.g. snake case (default)
- _content_type (str/None): force body content-type.
- Default is None and content-type will be predicted by allowed
- content-types and body.
- _host_index (int/None): specifies the index of the server
- that we want to use.
- Default is read from the configuration.
- async_req (bool): execute request asynchronously
-
- Returns:
- Verification
- If the method is called asynchronously, returns the request
- thread.
- """
- kwargs['async_req'] = kwargs.get(
- 'async_req', False
- )
- kwargs['_return_http_data_only'] = kwargs.get(
- '_return_http_data_only', True
- )
- kwargs['_preload_content'] = kwargs.get(
- '_preload_content', True
- )
- kwargs['_request_timeout'] = kwargs.get(
- '_request_timeout', None
- )
- kwargs['_check_input_type'] = kwargs.get(
- '_check_input_type', False
- )
- kwargs['_check_return_type'] = kwargs.get(
- '_check_return_type', False
- )
- kwargs['_spec_property_naming'] = kwargs.get(
- '_spec_property_naming', False
- )
- kwargs['_content_type'] = kwargs.get(
- '_content_type')
- kwargs['_host_index'] = kwargs.get('_host_index')
- return self._create_endpoint.call_with_http_info(**kwargs)
-
def get(
self,
verification_id,
@@ -453,6 +346,7 @@ def get(
verification_id (str): ID of `Verification` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -531,6 +425,7 @@ def list_by_merchant_id(
merchant_id (str): ID of `Merchant` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The number of entries to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
@@ -598,7 +493,7 @@ def list_by_merchant_id(
def list_by_payment_instrument_id(
self,
- payment_instrument_id,
+ payment_instrument_id_verify,
**kwargs
):
"""List Payment Instrument Verifications # noqa: E501
@@ -607,13 +502,14 @@ def list_by_payment_instrument_id(
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_by_payment_instrument_id(payment_instrument_id, async_req=True)
+ >>> thread = api.list_by_payment_instrument_id(payment_instrument_id_verify, async_req=True)
>>> result = thread.get()
Args:
- payment_instrument_id (str): ID of `Payment Instrument `object.
+ payment_instrument_id_verify (str):
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The number of entries to return.. [optional]
offset (int): The number of items to skip before starting to collect the result set.. [optional]
page_number (int): The page number to list.. [optional]
@@ -674,8 +570,8 @@ def list_by_payment_instrument_id(
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
- kwargs['payment_instrument_id'] = \
- payment_instrument_id
+ kwargs['payment_instrument_id_verify'] = \
+ payment_instrument_id_verify
ret = self._list_by_payment_instrument_id_endpoint.call_with_http_info(**kwargs)
fl = FinixList(ret, self.list_by_payment_instrument_id, **kwargs)
return fl
@@ -695,6 +591,7 @@ def list(
Keyword Args:
+ accept (str): Body Header. [optional] if omitted the server will use the default value of "application/hal+json"
limit (int): The numbers of items to return.. [optional]
after_cursor (str): Return every resource created after the cursor value.. [optional]
before_cursor (str): Return every resource created before the cursor value.. [optional]
diff --git a/finix/api/webhooks_api.py b/finix/api/webhooks_api.py
index 3c51743..7a2f5a2 100644
--- a/finix/api/webhooks_api.py
+++ b/finix/api/webhooks_api.py
@@ -77,6 +77,8 @@ def __init__(self, api_client=None):
},
params_map={
'all': [
+ 'accept',
+ 'finix_version',
'create_webhook_request',
],
'required': [],
@@ -93,12 +95,20 @@ def __init__(self, api_client=None):
'allowed_values': {
},
'openapi_types': {
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'create_webhook_request':
(CreateWebhookRequest,),
},
'attribute_map': {
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
+ 'accept': 'header',
+ 'finix_version': 'header',
'create_webhook_request': 'body',
},
'collection_format_map': {
@@ -106,10 +116,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -128,6 +138,7 @@ def __init__(self, api_client=None):
params_map={
'all': [
'webhook_id',
+ 'accept',
],
'required': [
'webhook_id',
@@ -147,19 +158,23 @@ def __init__(self, api_client=None):
'openapi_types': {
'webhook_id':
(str,),
+ 'accept':
+ (str,),
},
'attribute_map': {
'webhook_id': 'webhook_id',
+ 'accept': 'Accept',
},
'location_map': {
'webhook_id': 'path',
+ 'accept': 'header',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -218,7 +233,7 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [],
},
@@ -238,6 +253,8 @@ def __init__(self, api_client=None):
params_map={
'all': [
'webhook_id',
+ 'accept',
+ 'finix_version',
'update_webhook_request',
],
'required': [
@@ -258,14 +275,22 @@ def __init__(self, api_client=None):
'openapi_types': {
'webhook_id':
(str,),
+ 'accept':
+ (str,),
+ 'finix_version':
+ (str,),
'update_webhook_request':
(UpdateWebhookRequest,),
},
'attribute_map': {
'webhook_id': 'webhook_id',
+ 'accept': 'Accept',
+ 'finix_version': 'Finix-Version',
},
'location_map': {
'webhook_id': 'path',
+ 'accept': 'header',
+ 'finix_version': 'header',
'update_webhook_request': 'body',
},
'collection_format_map': {
@@ -273,10 +298,10 @@ def __init__(self, api_client=None):
},
headers_map={
'accept': [
- 'application/hal+json'
+ 'application/json'
],
'content_type': [
- 'application/hal+json'
+ 'application/json'
]
},
api_client=api_client
@@ -297,6 +322,8 @@ def create(
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
create_webhook_request (CreateWebhookRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
@@ -374,6 +401,7 @@ def get(
webhook_id (str): ID of `Webhook` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -519,7 +547,7 @@ def update(
):
"""Update a Webhook # noqa: E501
- Update an existing `Webhook`. # noqa: E501
+ Update an existing `Webhook`to: - Disable or enable an endpoint URL to recieve webhook events. - Add [authentication to a `Webhook`](/guides/developers/webhooks/#authenticating-webhooks). - Filter the [webhook events sent to an endpoint URL](/guides/developers/webhooks/#webhook-event-filtering). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -530,6 +558,8 @@ def update(
webhook_id (str): ID of `Webhook` object.
Keyword Args:
+ accept (str): [optional] if omitted the server will use the default value of "application/hal+json"
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] if omitted the server will use the default value of "2018-01-01"
update_webhook_request (UpdateWebhookRequest): [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
diff --git a/finix/api_client.py b/finix/api_client.py
index 7b63697..9679c3a 100644
--- a/finix/api_client.py
+++ b/finix/api_client.py
@@ -31,10 +31,13 @@
import finix.api.merchants_api
import finix.api.onboarding_forms_api
import finix.api.payment_instruments_api
+import finix.api.payout_profiles_api
import finix.api.settlements_api
+import finix.api.split_transfers_api
import finix.api.transfers_api
import finix.api.verifications_api
import finix.api.webhooks_api
+import finix.api.default_api
from finix import rest
from finix.configuration import Configuration
@@ -104,10 +107,13 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
self.merchants = finix.api.merchants_api.MerchantsApi(self)
self.onboarding_forms = finix.api.onboarding_forms_api.OnboardingFormsApi(self)
self.payment_instruments = finix.api.payment_instruments_api.PaymentInstrumentsApi(self)
+ self.payout_profiles = finix.api.payout_profiles_api.PayoutProfilesApi(self)
self.settlements = finix.api.settlements_api.SettlementsApi(self)
+ self.split_transfers = finix.api.split_transfers_api.SplitTransfersApi(self)
self.transfers = finix.api.transfers_api.TransfersApi(self)
self.verifications = finix.api.verifications_api.VerificationsApi(self)
self.webhooks = finix.api.webhooks_api.WebhooksApi(self)
+ self.default = finix.api.default_api.DefaultApi(self)
def __enter__(self):
return self
diff --git a/finix/model/accept_dispute.py b/finix/model/accept_dispute.py
new file mode 100644
index 0000000..1da2568
--- /dev/null
+++ b/finix/model/accept_dispute.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class AcceptDispute(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'note': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'note': 'note', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, note, *args, **kwargs): # noqa: E501
+ """AcceptDispute - a model defined in OpenAPI
+
+ Args:
+ note (str): Include a note or custom metadata to reference the `Dispute`.
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.note = note
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, note, *args, **kwargs): # noqa: E501
+ """AcceptDispute - a model defined in OpenAPI
+
+ Args:
+ note (str): Include a note or custom metadata to reference the `Dispute`.
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.note = note
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/additional_healthcare_data.py b/finix/model/additional_healthcare_data.py
new file mode 100644
index 0000000..deb5bad
--- /dev/null
+++ b/finix/model/additional_healthcare_data.py
@@ -0,0 +1,262 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class AdditionalHealthcareData(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'clinic_amount': (int, none_type,), # noqa: E501
+ 'dental_amount': (int, none_type,), # noqa: E501
+ 'prescription_amount': (int, none_type,), # noqa: E501
+ 'vision_amount': (int, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'clinic_amount': 'clinic_amount', # noqa: E501
+ 'dental_amount': 'dental_amount', # noqa: E501
+ 'prescription_amount': 'prescription_amount', # noqa: E501
+ 'vision_amount': 'vision_amount', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """AdditionalHealthcareData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ clinic_amount (int, none_type): The amount used for clinic and office visits such as a copay amount.. [optional] # noqa: E501
+ dental_amount (int, none_type): The amount used for dental related expenses.. [optional] # noqa: E501
+ prescription_amount (int, none_type): The amount used to purchase perscriptions and medications.. [optional] # noqa: E501
+ vision_amount (int, none_type): The amount used for vision related expenses.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """AdditionalHealthcareData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ clinic_amount (int, none_type): The amount used for clinic and office visits such as a copay amount.. [optional] # noqa: E501
+ dental_amount (int, none_type): The amount used for dental related expenses.. [optional] # noqa: E501
+ prescription_amount (int, none_type): The amount used to purchase perscriptions and medications.. [optional] # noqa: E501
+ vision_amount (int, none_type): The amount used for vision related expenses.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/additional_purchase_data.py b/finix/model/additional_purchase_data.py
index 8a9cb4e..5cf8e09 100644
--- a/finix/model/additional_purchase_data.py
+++ b/finix/model/additional_purchase_data.py
@@ -28,9 +28,9 @@
def lazy_import():
- from finix.model.additional_purchase_data_item_data_inner import AdditionalPurchaseDataItemDataInner
+ from finix.model.additional_purchase_data_item_data import AdditionalPurchaseDataItemData
from finix.model.additional_purchase_data_order_date import AdditionalPurchaseDataOrderDate
- globals()['AdditionalPurchaseDataItemDataInner'] = AdditionalPurchaseDataItemDataInner
+ globals()['AdditionalPurchaseDataItemData'] = AdditionalPurchaseDataItemData
globals()['AdditionalPurchaseDataOrderDate'] = AdditionalPurchaseDataOrderDate
@@ -59,6 +59,18 @@ class AdditionalPurchaseData(ModelNormal):
}
validations = {
+ ('customer_reference_number',): {
+ 'max_length': 17,
+ },
+ ('destination_postal_code',): {
+ 'max_length': 10,
+ },
+ ('invoice_reference_number',): {
+ 'max_length': 15,
+ },
+ ('ship_from_postal_code',): {
+ 'max_length': 10,
+ },
}
@cached_property
@@ -85,14 +97,14 @@ def openapi_types():
lazy_import()
return {
'customer_reference_number': (str,), # noqa: E501
+ 'sales_tax': (int,), # noqa: E501
'customs_duty_amount': (int,), # noqa: E501
'destination_country_code': (str,), # noqa: E501
'destination_postal_code': (str,), # noqa: E501
'discount_amount': (int,), # noqa: E501
'invoice_reference_number': (str,), # noqa: E501
- 'item_data': ([AdditionalPurchaseDataItemDataInner],), # noqa: E501
+ 'item_data': ([AdditionalPurchaseDataItemData],), # noqa: E501
'order_date': (AdditionalPurchaseDataOrderDate,), # noqa: E501
- 'sales_tax': (int,), # noqa: E501
'ship_from_postal_code': (str,), # noqa: E501
'shipping_amount': (int,), # noqa: E501
'tax_exempt': (bool,), # noqa: E501
@@ -105,6 +117,7 @@ def discriminator():
attribute_map = {
'customer_reference_number': 'customer_reference_number', # noqa: E501
+ 'sales_tax': 'sales_tax', # noqa: E501
'customs_duty_amount': 'customs_duty_amount', # noqa: E501
'destination_country_code': 'destination_country_code', # noqa: E501
'destination_postal_code': 'destination_postal_code', # noqa: E501
@@ -112,7 +125,6 @@ def discriminator():
'invoice_reference_number': 'invoice_reference_number', # noqa: E501
'item_data': 'item_data', # noqa: E501
'order_date': 'order_date', # noqa: E501
- 'sales_tax': 'sales_tax', # noqa: E501
'ship_from_postal_code': 'ship_from_postal_code', # noqa: E501
'shipping_amount': 'shipping_amount', # noqa: E501
'tax_exempt': 'tax_exempt', # noqa: E501
@@ -125,9 +137,13 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, customer_reference_number, sales_tax, *args, **kwargs): # noqa: E501
"""AdditionalPurchaseData - a model defined in OpenAPI
+ Args:
+ customer_reference_number (str): The customer reference for the purchase (max 17 characters).
+ sales_tax (int): - Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. - For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**. - Request must align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -159,18 +175,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- customer_reference_number (str): The customer reference for the purchase (max 17 characters).. [optional] # noqa: E501
customs_duty_amount (int): The duty in cents on the total purchase amount for the order. [optional] # noqa: E501
destination_country_code (str): The ISO country code of the order destination.. [optional] # noqa: E501
destination_postal_code (str): The postal code of the order destination (10 characters). [optional] # noqa: E501
discount_amount (int): The amount in cents of the discount for the order.. [optional] # noqa: E501
invoice_reference_number (str): The order's invoice number (max 15 characters). [optional] # noqa: E501
- item_data ([AdditionalPurchaseDataItemDataInner]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.. [optional] # noqa: E501
+ item_data ([AdditionalPurchaseDataItemData]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.. [optional] # noqa: E501
order_date (AdditionalPurchaseDataOrderDate): [optional] # noqa: E501
- sales_tax (int): Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**.. [optional] # noqa: E501
ship_from_postal_code (str): The postal code from where order is shipped (10 characters). [optional] # noqa: E501
shipping_amount (int): The shipping cost in cents for the order. . [optional] # noqa: E501
- tax_exempt (bool): For tax exempt purchases set to True.. [optional] # noqa: E501
+ tax_exempt (bool): - For tax exempt purchases set to **True**. - If set to **True**, request can't include `sales_tax`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -198,6 +212,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.customer_reference_number = customer_reference_number
+ self.sales_tax = sales_tax
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -218,9 +234,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, *args, **kwargs): # noqa: E501
+ def __init__(self, customer_reference_number, sales_tax, *args, **kwargs): # noqa: E501
"""AdditionalPurchaseData - a model defined in OpenAPI
+ Args:
+ customer_reference_number (str): The customer reference for the purchase (max 17 characters).
+ sales_tax (int): - Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. - For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**. - Request must align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -252,18 +272,16 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- customer_reference_number (str): The customer reference for the purchase (max 17 characters).. [optional] # noqa: E501
customs_duty_amount (int): The duty in cents on the total purchase amount for the order. [optional] # noqa: E501
destination_country_code (str): The ISO country code of the order destination.. [optional] # noqa: E501
destination_postal_code (str): The postal code of the order destination (10 characters). [optional] # noqa: E501
discount_amount (int): The amount in cents of the discount for the order.. [optional] # noqa: E501
invoice_reference_number (str): The order's invoice number (max 15 characters). [optional] # noqa: E501
- item_data ([AdditionalPurchaseDataItemDataInner]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.. [optional] # noqa: E501
+ item_data ([AdditionalPurchaseDataItemData]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.. [optional] # noqa: E501
order_date (AdditionalPurchaseDataOrderDate): [optional] # noqa: E501
- sales_tax (int): Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**.. [optional] # noqa: E501
ship_from_postal_code (str): The postal code from where order is shipped (10 characters). [optional] # noqa: E501
shipping_amount (int): The shipping cost in cents for the order. . [optional] # noqa: E501
- tax_exempt (bool): For tax exempt purchases set to True.. [optional] # noqa: E501
+ tax_exempt (bool): - For tax exempt purchases set to **True**. - If set to **True**, request can't include `sales_tax`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -289,6 +307,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.customer_reference_number = customer_reference_number
+ self.sales_tax = sales_tax
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/additional_purchase_data_item_data.py b/finix/model/additional_purchase_data_item_data.py
new file mode 100644
index 0000000..d20e5e0
--- /dev/null
+++ b/finix/model/additional_purchase_data_item_data.py
@@ -0,0 +1,298 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class AdditionalPurchaseDataItemData(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('commodity_code',): {
+ 'max_length': 12,
+ },
+ ('item_description',): {
+ 'max_length': 25,
+ },
+ ('merchant_product_code',): {
+ 'max_length': 12,
+ },
+ ('quantity',): {
+ 'inclusive_maximum': 99,
+ 'inclusive_minimum': 1,
+ },
+ ('unit_of_measure',): {
+ 'max_length': 3,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'amount_excluding_sales_tax': (int,), # noqa: E501
+ 'amount_including_sales_tax': (int,), # noqa: E501
+ 'commodity_code': (str,), # noqa: E501
+ 'cost_per_unit': (int,), # noqa: E501
+ 'item_description': (str,), # noqa: E501
+ 'item_discount_amount': (int,), # noqa: E501
+ 'merchant_product_code': (str,), # noqa: E501
+ 'quantity': (int,), # noqa: E501
+ 'unit_of_measure': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'amount_excluding_sales_tax': 'amount_excluding_sales_tax', # noqa: E501
+ 'amount_including_sales_tax': 'amount_including_sales_tax', # noqa: E501
+ 'commodity_code': 'commodity_code', # noqa: E501
+ 'cost_per_unit': 'cost_per_unit', # noqa: E501
+ 'item_description': 'item_description', # noqa: E501
+ 'item_discount_amount': 'item_discount_amount', # noqa: E501
+ 'merchant_product_code': 'merchant_product_code', # noqa: E501
+ 'quantity': 'quantity', # noqa: E501
+ 'unit_of_measure': 'unit_of_measure', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """AdditionalPurchaseDataItemData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount_excluding_sales_tax (int): - Total cost of the line item in cents, excluding tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.. [optional] # noqa: E501
+ amount_including_sales_tax (int): - Total cost of the line item in cents, including tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.. [optional] # noqa: E501
+ commodity_code (str): A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters).. [optional] # noqa: E501
+ cost_per_unit (int): The price in cents of one unit of the item purchased. [optional] # noqa: E501
+ item_description (str): Required when `item_data` is supplied (max 25 characters). [optional] # noqa: E501
+ item_discount_amount (int): Item discount amount in cents . [optional] # noqa: E501
+ merchant_product_code (str): Merchant defined product code (max 12 characters).. [optional] # noqa: E501
+ quantity (int): The number of items purchased. Must be greater than 0.. [optional] # noqa: E501
+ unit_of_measure (str): The unit of measure of the purchased item (max 3 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """AdditionalPurchaseDataItemData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount_excluding_sales_tax (int): - Total cost of the line item in cents, excluding tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.. [optional] # noqa: E501
+ amount_including_sales_tax (int): - Total cost of the line item in cents, including tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.. [optional] # noqa: E501
+ commodity_code (str): A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters).. [optional] # noqa: E501
+ cost_per_unit (int): The price in cents of one unit of the item purchased. [optional] # noqa: E501
+ item_description (str): Required when `item_data` is supplied (max 25 characters). [optional] # noqa: E501
+ item_discount_amount (int): Item discount amount in cents . [optional] # noqa: E501
+ merchant_product_code (str): Merchant defined product code (max 12 characters).. [optional] # noqa: E501
+ quantity (int): The number of items purchased. Must be greater than 0.. [optional] # noqa: E501
+ unit_of_measure (str): The unit of measure of the purchased item (max 3 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/additional_purchase_data_order_date.py b/finix/model/additional_purchase_data_order_date.py
index abcf61a..208ac1e 100644
--- a/finix/model/additional_purchase_data_order_date.py
+++ b/finix/model/additional_purchase_data_order_date.py
@@ -53,6 +53,9 @@ class AdditionalPurchaseDataOrderDate(ModelNormal):
}
validations = {
+ ('year',): {
+ 'inclusive_minimum': 1990,
+ },
}
@cached_property
diff --git a/finix/model/application.py b/finix/model/application.py
index e146850..aa92ef9 100644
--- a/finix/model/application.py
+++ b/finix/model/application.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.application_links import ApplicationLinks
- from finix.model.tags import Tags
globals()['ApplicationLinks'] = ApplicationLinks
- globals()['Tags'] = Tags
class Application(ModelNormal):
@@ -67,8 +65,9 @@ class Application(ModelNormal):
'SUCCESSFUL_CAPTURE': "SUCCESSFUL_CAPTURE",
},
('settlement_funding_identifier',): {
- 'None': None,
'UNSET': "UNSET",
+ 'MID_AND_DATE': "MID_AND_DATE",
+ 'MID_AND_MERCHANT_NAME': "MID_AND_MERCHANT_NAME",
},
}
@@ -111,8 +110,8 @@ def openapi_types():
'processing_enabled': (bool,), # noqa: E501
'ready_to_settle_upon': (str, none_type,), # noqa: E501
'settlement_enabled': (bool,), # noqa: E501
- 'settlement_funding_identifier': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'settlement_funding_identifier': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (ApplicationLinks,), # noqa: E501
}
@@ -192,10 +191,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
name (str): The name of the `Application`.. [optional] # noqa: E501
owner (str): ID of the `Identity` resource that created the `Application`.. [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Application`. . [optional] # noqa: E501
- ready_to_settle_upon (str, none_type): Details when `Authroizations` submitted under the `Application` will be ready to settle.. [optional] # noqa: E501
+ ready_to_settle_upon (str, none_type): Details when transactions submitted under the `Application` will be ready to settle.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Application`. . [optional] # noqa: E501
- settlement_funding_identifier (str, none_type): [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ApplicationLinks): [optional] # noqa: E501
"""
@@ -289,10 +288,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
name (str): The name of the `Application`.. [optional] # noqa: E501
owner (str): ID of the `Identity` resource that created the `Application`.. [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Application`. . [optional] # noqa: E501
- ready_to_settle_upon (str, none_type): Details when `Authroizations` submitted under the `Application` will be ready to settle.. [optional] # noqa: E501
+ ready_to_settle_upon (str, none_type): Details when transactions submitted under the `Application` will be ready to settle.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Application`. . [optional] # noqa: E501
- settlement_funding_identifier (str, none_type): [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ApplicationLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/application_links.py b/finix/model/application_links.py
index 1e14492..f1d9fed 100644
--- a/finix/model/application_links.py
+++ b/finix/model/application_links.py
@@ -28,9 +28,9 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
@@ -84,21 +84,21 @@ def openapi_types():
"""
lazy_import()
return {
- 'application_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'authorizations': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'disputes': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'identities': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'merchants': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'owner_identity': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'payment_instruments': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'processors': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'reversals': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'authorizations': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'application_profile': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'disputes': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'identities': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'merchants': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'owner_identity': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'payment_instruments': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'processors': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'reversals': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'settlements': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'tokens': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'users': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'webhooks': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'settlements': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'tokens': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'transfers': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'users': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'webhooks': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -107,8 +107,8 @@ def discriminator():
attribute_map = {
- 'application_profile': 'application_profile', # noqa: E501
'authorizations': 'authorizations', # noqa: E501
+ 'application_profile': 'application_profile', # noqa: E501
'disputes': 'disputes', # noqa: E501
'identities': 'identities', # noqa: E501
'merchants': 'merchants', # noqa: E501
@@ -165,21 +165,21 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- application_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- disputes (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identities (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- merchants (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- payment_instruments (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reversals (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ application_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ disputes (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identities (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ merchants (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ payment_instruments (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reversals (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- settlements (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- tokens (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- webhooks (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ settlements (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ tokens (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ webhooks (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -261,21 +261,21 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- application_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- disputes (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identities (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- merchants (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- payment_instruments (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reversals (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ application_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ disputes (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identities (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ merchants (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ payment_instruments (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reversals (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- settlements (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- tokens (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- webhooks (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ settlements (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ tokens (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ webhooks (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/application_links_authorizations.py b/finix/model/application_links_authorizations.py
new file mode 100644
index 0000000..576f974
--- /dev/null
+++ b/finix/model/application_links_authorizations.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class ApplicationLinksAuthorizations(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'href': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'href': 'href', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """ApplicationLinksAuthorizations - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ href (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """ApplicationLinksAuthorizations - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ href (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/application_profile.py b/finix/model/application_profile.py
index 7a73d84..bf90576 100644
--- a/finix/model/application_profile.py
+++ b/finix/model/application_profile.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.application_profile_links import ApplicationProfileLinks
- from finix.model.tags import Tags
globals()['ApplicationProfileLinks'] = ApplicationProfileLinks
- globals()['Tags'] = Tags
class ApplicationProfile(ModelNormal):
@@ -90,7 +88,7 @@ def openapi_types():
'application': (str,), # noqa: E501
'fee_profile': (str, none_type,), # noqa: E501
'risk_profile': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (ApplicationProfileLinks,), # noqa: E501
}
@@ -157,7 +155,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
application (str): The ID of the `Application` resource.. [optional] # noqa: E501
fee_profile (str, none_type): The ID of the `Fee Profile` associated with the `Application`.. [optional] # noqa: E501
risk_profile (str): The ID of the `risk_profile` that was created during provisioning.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ApplicationProfileLinks): [optional] # noqa: E501
"""
@@ -246,7 +244,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
application (str): The ID of the `Application` resource.. [optional] # noqa: E501
fee_profile (str, none_type): The ID of the `Fee Profile` associated with the `Application`.. [optional] # noqa: E501
risk_profile (str): The ID of the `risk_profile` that was created during provisioning.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ApplicationProfileLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/application_profile_links.py b/finix/model/application_profile_links.py
index e22e859..3058b8f 100644
--- a/finix/model/application_profile_links.py
+++ b/finix/model/application_profile_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
@@ -87,8 +87,8 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'fee_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'risk_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'fee_profile': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'risk_profile': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
}
@@ -146,8 +146,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- fee_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- risk_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ fee_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ risk_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
"""
@@ -231,8 +231,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- fee_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- risk_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ fee_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ risk_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
"""
diff --git a/finix/model/application_profiles_list.py b/finix/model/application_profiles_list.py
index f1f22a6..84daee8 100644
--- a/finix/model/application_profiles_list.py
+++ b/finix/model/application_profiles_list.py
@@ -29,10 +29,10 @@
def lazy_import():
from finix.model.application_profiles_list_embedded import ApplicationProfilesListEmbedded
- from finix.model.application_profiles_list_links import ApplicationProfilesListLinks
+ from finix.model.list_links import ListLinks
from finix.model.page_cursor import PageCursor
globals()['ApplicationProfilesListEmbedded'] = ApplicationProfilesListEmbedded
- globals()['ApplicationProfilesListLinks'] = ApplicationProfilesListLinks
+ globals()['ListLinks'] = ListLinks
globals()['PageCursor'] = PageCursor
@@ -88,7 +88,7 @@ def openapi_types():
return {
'page': (PageCursor,), # noqa: E501
'embedded': (ApplicationProfilesListEmbedded,), # noqa: E501
- 'links': (ApplicationProfilesListLinks,), # noqa: E501
+ 'links': (ListLinks,), # noqa: E501
}
@cached_property
@@ -145,7 +145,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
page (PageCursor): [optional] # noqa: E501
embedded (ApplicationProfilesListEmbedded): [optional] # noqa: E501
- links (ApplicationProfilesListLinks): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,7 +229,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
page (PageCursor): [optional] # noqa: E501
embedded (ApplicationProfilesListEmbedded): [optional] # noqa: E501
- links (ApplicationProfilesListLinks): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/associated_identity.py b/finix/model/associated_identity.py
index 0bd4603..9f435fc 100644
--- a/finix/model/associated_identity.py
+++ b/finix/model/associated_identity.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.associated_identity_entity import AssociatedIdentityEntity
from finix.model.identity_links import IdentityLinks
- from finix.model.tags import Tags
globals()['AssociatedIdentityEntity'] = AssociatedIdentityEntity
globals()['IdentityLinks'] = IdentityLinks
- globals()['Tags'] = Tags
class AssociatedIdentity(ModelNormal):
@@ -97,7 +95,7 @@ def openapi_types():
'updated_at': (datetime,), # noqa: E501
'application': (str,), # noqa: E501
'entity': (AssociatedIdentityEntity,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (IdentityLinks,), # noqa: E501
}
@@ -162,7 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): ID of the `Application` associated with the `Identity`.. [optional] # noqa: E501
entity (AssociatedIdentityEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (IdentityLinks): [optional] # noqa: E501
"""
@@ -250,7 +248,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): ID of the `Application` associated with the `Identity`.. [optional] # noqa: E501
entity (AssociatedIdentityEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (IdentityLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/associated_identity_entity.py b/finix/model/associated_identity_entity.py
index 8310c0f..b252e56 100644
--- a/finix/model/associated_identity_entity.py
+++ b/finix/model/associated_identity_entity.py
@@ -30,11 +30,11 @@
def lazy_import():
from finix.model.identity_entity_business_address import IdentityEntityBusinessAddress
from finix.model.identity_entity_dob import IdentityEntityDob
- from finix.model.identity_entity_incorporation_date import IdentityEntityIncorporationDate
+ from finix.model.identity_entity_form_incorporation_date import IdentityEntityFormIncorporationDate
from finix.model.identity_entity_personal_address import IdentityEntityPersonalAddress
globals()['IdentityEntityBusinessAddress'] = IdentityEntityBusinessAddress
globals()['IdentityEntityDob'] = IdentityEntityDob
- globals()['IdentityEntityIncorporationDate'] = IdentityEntityIncorporationDate
+ globals()['IdentityEntityFormIncorporationDate'] = IdentityEntityFormIncorporationDate
globals()['IdentityEntityPersonalAddress'] = IdentityEntityPersonalAddress
@@ -129,8 +129,6 @@ def openapi_types():
"""
lazy_import()
return {
- 'amex_mid': (int, none_type,), # noqa: E501
- 'annual_card_volume': (int, none_type,), # noqa: E501
'business_address': (IdentityEntityBusinessAddress,), # noqa: E501
'business_name': (str, none_type,), # noqa: E501
'business_phone': (str, none_type,), # noqa: E501
@@ -143,7 +141,7 @@ def openapi_types():
'email': (str, none_type,), # noqa: E501
'first_name': (str, none_type,), # noqa: E501
'has_accepted_credit_cards_previously': (bool,), # noqa: E501
- 'incorporation_date': (IdentityEntityIncorporationDate,), # noqa: E501
+ 'incorporation_date': (IdentityEntityFormIncorporationDate,), # noqa: E501
'last_name': (str, none_type,), # noqa: E501
'max_transaction_amount': (int, none_type,), # noqa: E501
'mcc': (str, none_type,), # noqa: E501
@@ -156,6 +154,8 @@ def openapi_types():
'tax_id_provided': (bool,), # noqa: E501
'title': (str, none_type,), # noqa: E501
'url': (str, none_type,), # noqa: E501
+ 'amex_mid': (int, none_type,), # noqa: E501
+ 'annual_card_volume': (int, none_type,), # noqa: E501
}
@cached_property
@@ -164,8 +164,6 @@ def discriminator():
attribute_map = {
- 'amex_mid': 'amex_mid', # noqa: E501
- 'annual_card_volume': 'annual_card_volume', # noqa: E501
'business_address': 'business_address', # noqa: E501
'business_name': 'business_name', # noqa: E501
'business_phone': 'business_phone', # noqa: E501
@@ -191,6 +189,8 @@ def discriminator():
'tax_id_provided': 'tax_id_provided', # noqa: E501
'title': 'title', # noqa: E501
'url': 'url', # noqa: E501
+ 'amex_mid': 'amex_mid', # noqa: E501
+ 'annual_card_volume': 'annual_card_volume', # noqa: E501
}
read_only_vars = {
@@ -234,8 +234,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
- annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): The merchant's legal business name (max 120 characters).- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
business_phone (str, none_type): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
@@ -248,10 +246,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (IdentityEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
@@ -261,6 +259,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
tax_id_provided (bool): Details if the `tax_id` was provided.. [optional] # noqa: E501
title (str, none_type): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
url (str, none_type): The URL of the merchant's public website.. [optional] # noqa: E501
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
+ annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -342,8 +342,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
- annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): The merchant's legal business name (max 120 characters).
- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
business_phone (str, none_type): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
@@ -356,10 +354,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (IdentityEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
@@ -369,6 +367,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
tax_id_provided (bool): Details if the `tax_id` was provided.. [optional] # noqa: E501
title (str, none_type): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
url (str, none_type): The URL of the merchant's public website.. [optional] # noqa: E501
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
+ annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/authorization.py b/finix/model/authorization.py
index 745f318..21d8387 100644
--- a/finix/model/authorization.py
+++ b/finix/model/authorization.py
@@ -29,15 +29,17 @@
def lazy_import():
from finix.model.additional_buyer_charges import AdditionalBuyerCharges
+ from finix.model.additional_healthcare_data import AdditionalHealthcareData
+ from finix.model.additional_purchase_data import AdditionalPurchaseData
from finix.model.authorization_links import AuthorizationLinks
from finix.model.card_present_details import CardPresentDetails
from finix.model.currency import Currency
- from finix.model.tags import Tags
globals()['AdditionalBuyerCharges'] = AdditionalBuyerCharges
+ globals()['AdditionalHealthcareData'] = AdditionalHealthcareData
+ globals()['AdditionalPurchaseData'] = AdditionalPurchaseData
globals()['AuthorizationLinks'] = AuthorizationLinks
globals()['CardPresentDetails'] = CardPresentDetails
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class Authorization(ModelNormal):
@@ -104,7 +106,10 @@ def openapi_types():
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'_3ds_redirect_url': (str, none_type,), # noqa: E501
+ 'address_verification': (str, none_type,), # noqa: E501
'additional_buyer_charges': (AdditionalBuyerCharges,), # noqa: E501
+ 'additional_healthcare_data': (AdditionalHealthcareData,), # noqa: E501
+ 'additional_purchase_data': (AdditionalPurchaseData,), # noqa: E501
'amount': (int,), # noqa: E501
'application': (str,), # noqa: E501
'card_present_details': (CardPresentDetails,), # noqa: E501
@@ -114,14 +119,16 @@ def openapi_types():
'expires_at': (datetime,), # noqa: E501
'failure_code': (str, none_type,), # noqa: E501
'failure_message': (str, none_type,), # noqa: E501
- 'idempotency_id': (str, none_type,), # noqa: E501
+ 'security_code_checks': (str, none_type,), # noqa: E501
'is_void': (bool,), # noqa: E501
- 'merchant_identity': (str, none_type,), # noqa: E501
- 'messages': ([str],), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'merchant_identity': (str,), # noqa: E501
+ 'messages': ([str], none_type,), # noqa: E501
'raw': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'security_code_verification': (str, none_type,), # noqa: E501
'source': (str,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'trace_id': (str,), # noqa: E501
'transfer': (str, none_type,), # noqa: E501
'void_state': (str,), # noqa: E501
@@ -138,7 +145,10 @@ def discriminator():
'created_at': 'created_at', # noqa: E501
'updated_at': 'updated_at', # noqa: E501
'_3ds_redirect_url': '3ds_redirect_url', # noqa: E501
+ 'address_verification': 'address_verification', # noqa: E501
'additional_buyer_charges': 'additional_buyer_charges', # noqa: E501
+ 'additional_healthcare_data': 'additional_healthcare_data', # noqa: E501
+ 'additional_purchase_data': 'additional_purchase_data', # noqa: E501
'amount': 'amount', # noqa: E501
'application': 'application', # noqa: E501
'card_present_details': 'card_present_details', # noqa: E501
@@ -148,11 +158,13 @@ def discriminator():
'expires_at': 'expires_at', # noqa: E501
'failure_code': 'failure_code', # noqa: E501
'failure_message': 'failure_message', # noqa: E501
- 'idempotency_id': 'idempotency_id', # noqa: E501
+ 'security_code_checks': 'security_code_checks', # noqa: E501
'is_void': 'is_void', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
'merchant_identity': 'merchant_identity', # noqa: E501
'messages': 'messages', # noqa: E501
'raw': 'raw', # noqa: E501
+ 'security_code_verification': 'security_code_verification', # noqa: E501
'source': 'source', # noqa: E501
'state': 'state', # noqa: E501
'tags': 'tags', # noqa: E501
@@ -207,7 +219,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
_3ds_redirect_url (str, none_type): The redirect URL used for 3DS transactions (if supported by the processor).. [optional] # noqa: E501
+ address_verification (str, none_type): Details the results of the Address Verification checks.. [optional] # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
+ additional_healthcare_data (AdditionalHealthcareData): [optional] # noqa: E501
+ additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
application (str): The ID of the `Application` resource the `Authorization` was created under.. [optional] # noqa: E501
card_present_details (CardPresentDetails): [optional] # noqa: E501
@@ -215,16 +230,18 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
expires_at (datetime): `Authorization` expiration time.. [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
+ security_code_checks (str, none_type): Details the results of the Security Code Verification checks.. [optional] # noqa: E501
is_void (bool): Details if the `Authorization` is void.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- messages ([str]): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Authorization` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of the `Identity` resource used by the `Merchant` the `Authorization` was processed under.. [optional] # noqa: E501
+ messages ([str], none_type): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
+ security_code_verification (str, none_type): Details the results of the Security Code Verification che. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
state (str): The state of the `Authorization`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.. [optional] # noqa: E501
transfer (str, none_type): The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.. [optional] # noqa: E501
void_state (str): Details if the `Authorization` has been voided.. [optional] # noqa: E501
@@ -314,7 +331,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
_3ds_redirect_url (str, none_type): The redirect URL used for 3DS transactions (if supported by the processor).. [optional] # noqa: E501
+ address_verification (str, none_type): Details the results of the Address Verification checks.. [optional] # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
+ additional_healthcare_data (AdditionalHealthcareData): [optional] # noqa: E501
+ additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
application (str): The ID of the `Application` resource the `Authorization` was created under.. [optional] # noqa: E501
card_present_details (CardPresentDetails): [optional] # noqa: E501
@@ -322,16 +342,18 @@ def __init__(self, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
expires_at (datetime): `Authorization` expiration time.. [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
+ security_code_checks (str, none_type): Details the results of the Security Code Verification checks.. [optional] # noqa: E501
is_void (bool): Details if the `Authorization` is void.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- messages ([str]): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Authorization` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of the `Identity` resource used by the `Merchant` the `Authorization` was processed under.. [optional] # noqa: E501
+ messages ([str], none_type): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
+ security_code_verification (str, none_type): Details the results of the Security Code Verification che. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
state (str): The state of the `Authorization`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.. [optional] # noqa: E501
transfer (str, none_type): The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.. [optional] # noqa: E501
void_state (str): Details if the `Authorization` has been voided.. [optional] # noqa: E501
diff --git a/finix/model/authorization_captured.py b/finix/model/authorization_captured.py
index de47af8..a7a207c 100644
--- a/finix/model/authorization_captured.py
+++ b/finix/model/authorization_captured.py
@@ -29,17 +29,15 @@
def lazy_import():
from finix.model.additional_buyer_charges import AdditionalBuyerCharges
- from finix.model.authorization_captured_external_responses_inner import AuthorizationCapturedExternalResponsesInner
+ from finix.model.authorization_captured_external_responses import AuthorizationCapturedExternalResponses
from finix.model.authorization_links import AuthorizationLinks
from finix.model.card_present_details import CardPresentDetails
from finix.model.currency import Currency
- from finix.model.tags import Tags
globals()['AdditionalBuyerCharges'] = AdditionalBuyerCharges
- globals()['AuthorizationCapturedExternalResponsesInner'] = AuthorizationCapturedExternalResponsesInner
+ globals()['AuthorizationCapturedExternalResponses'] = AuthorizationCapturedExternalResponses
globals()['AuthorizationLinks'] = AuthorizationLinks
globals()['CardPresentDetails'] = CardPresentDetails
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class AuthorizationCaptured(ModelNormal):
@@ -114,17 +112,18 @@ def openapi_types():
'currency': (Currency,), # noqa: E501
'device': (str, none_type,), # noqa: E501
'expires_at': (datetime,), # noqa: E501
- 'external_responses': ([AuthorizationCapturedExternalResponsesInner], none_type,), # noqa: E501
+ 'external_responses': ([AuthorizationCapturedExternalResponses], none_type,), # noqa: E501
'failure_code': (str, none_type,), # noqa: E501
'failure_message': (str, none_type,), # noqa: E501
'idempotency_id': (str, none_type,), # noqa: E501
'is_void': (bool,), # noqa: E501
- 'merchant_identity': (str, none_type,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'merchant_identity': (str,), # noqa: E501
'messages': ([str],), # noqa: E501
'raw': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'source': (str,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'trace_id': (str,), # noqa: E501
'transfer': (str, none_type,), # noqa: E501
'void_state': (str,), # noqa: E501
@@ -154,6 +153,7 @@ def discriminator():
'failure_message': 'failure_message', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
'is_void': 'is_void', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
'merchant_identity': 'merchant_identity', # noqa: E501
'messages': 'messages', # noqa: E501
'raw': 'raw', # noqa: E501
@@ -219,17 +219,18 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
expires_at (datetime): Authorization expiration time.. [optional] # noqa: E501
- external_responses ([AuthorizationCapturedExternalResponsesInner], none_type): [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ external_responses ([AuthorizationCapturedExternalResponses], none_type): [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
is_void (bool): Details if the `Authorization` is void.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Authorization` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of `Identity` resource used by the `Merchant` the `Authorization` was created under.. [optional] # noqa: E501
messages ([str]): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
state (str): The state of the `Transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.. [optional] # noqa: E501
transfer (str, none_type): The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.. [optional] # noqa: E501
void_state (str): Details if the `Authorization` has been voided.. [optional] # noqa: E501
@@ -327,17 +328,18 @@ def __init__(self, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
expires_at (datetime): Authorization expiration time.. [optional] # noqa: E501
- external_responses ([AuthorizationCapturedExternalResponsesInner], none_type): [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ external_responses ([AuthorizationCapturedExternalResponses], none_type): [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
is_void (bool): Details if the `Authorization` is void.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Authorization` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of `Identity` resource used by the `Merchant` the `Authorization` was created under.. [optional] # noqa: E501
messages ([str]): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
state (str): The state of the `Transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.. [optional] # noqa: E501
transfer (str, none_type): The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.. [optional] # noqa: E501
void_state (str): Details if the `Authorization` has been voided.. [optional] # noqa: E501
diff --git a/finix/model/authorization_captured_external_responses.py b/finix/model/authorization_captured_external_responses.py
new file mode 100644
index 0000000..38b15c4
--- /dev/null
+++ b/finix/model/authorization_captured_external_responses.py
@@ -0,0 +1,254 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class AuthorizationCapturedExternalResponses(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'body': (str,), # noqa: E501
+ 'content_type': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'body': 'body', # noqa: E501
+ 'content_type': 'content_type', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """AuthorizationCapturedExternalResponses - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ body (str): [optional] # noqa: E501
+ content_type (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """AuthorizationCapturedExternalResponses - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ body (str): [optional] # noqa: E501
+ content_type (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/balance_transfer.py b/finix/model/balance_transfer.py
index cebb0b2..23847ca 100644
--- a/finix/model/balance_transfer.py
+++ b/finix/model/balance_transfer.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.currency import Currency
from finix.model.list_links import ListLinks
- from finix.model.tags import Tags
globals()['Currency'] = Currency
globals()['ListLinks'] = ListLinks
- globals()['Tags'] = Tags
class BalanceTransfer(ModelNormal):
@@ -107,7 +105,7 @@ def openapi_types():
'reference_id': (str,), # noqa: E501
'source': (str,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (ListLinks,), # noqa: E501
}
@@ -186,7 +184,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
reference_id (str): ID generated by Finix and sent to the partner.. [optional] # noqa: E501
source (str): The account where funds get debited. For balance transfers, this is an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or `OPERATING_ACCOUNT`.. [optional] # noqa: E501
state (str): The `state` of the `balance_transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ListLinks): [optional] # noqa: E501
"""
@@ -281,7 +279,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
reference_id (str): ID generated by Finix and sent to the partner.. [optional] # noqa: E501
source (str): The account where funds get debited. For balance transfers, this is an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or `OPERATING_ACCOUNT`.. [optional] # noqa: E501
state (str): The `state` of the `balance_transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (ListLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/card_present_details_emv_data.py b/finix/model/card_present_details_emv_data.py
index f87892a..19e603f 100644
--- a/finix/model/card_present_details_emv_data.py
+++ b/finix/model/card_present_details_emv_data.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CardPresentDetailsEmvData(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = True
@@ -80,7 +75,6 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'application_identifier': (str,), # noqa: E501
'application_label': (str,), # noqa: E501
@@ -89,7 +83,7 @@ def openapi_types():
'cryptogram': (str,), # noqa: E501
'issuer_code_table_index': (str, none_type,), # noqa: E501
'pin_verified': (bool,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -156,7 +150,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
cryptogram (str): Encrypted card infromation used to process the transaction.. [optional] # noqa: E501
issuer_code_table_index (str, none_type): The alphabet code table (according to ISO 8859) used by the EMV application (if provided).. [optional] # noqa: E501
pin_verified (bool): Details if the cardholder's PIN number was verified.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -245,7 +239,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
cryptogram (str): Encrypted card infromation used to process the transaction.. [optional] # noqa: E501
issuer_code_table_index (str, none_type): The alphabet code table (according to ISO 8859) used by the EMV application (if provided).. [optional] # noqa: E501
pin_verified (bool): Details if the cardholder's PIN number was verified.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/close_settlement.py b/finix/model/close_settlement.py
new file mode 100644
index 0000000..219fbbf
--- /dev/null
+++ b/finix/model/close_settlement.py
@@ -0,0 +1,261 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CloseSettlement(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('action',): {
+ 'STOP_ACCRUAL': "STOP_ACCRUAL",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'action': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'action': 'action', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """CloseSettlement - a model defined in OpenAPI
+
+ Args:
+
+ Keyword Args:
+ action (str): The action you want to perform on the `settlement`. Use **STOP_ACCRUAL** to close the specified `settlement`.. defaults to "STOP_ACCRUAL", must be one of ["STOP_ACCRUAL", ] # noqa: E501
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ action = kwargs.get('action', "STOP_ACCRUAL")
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.action = action
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """CloseSettlement - a model defined in OpenAPI
+
+ Args:
+
+ Keyword Args:
+ action (str): The action you want to perform on the `settlement`. Use **STOP_ACCRUAL** to close the specified `settlement`.. defaults to "STOP_ACCRUAL", must be one of ["STOP_ACCRUAL", ] # noqa: E501
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ action = kwargs.get('action', "STOP_ACCRUAL")
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.action = action
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/compliance_form.py b/finix/model/compliance_form.py
index a2dae0b..dda27e6 100644
--- a/finix/model/compliance_form.py
+++ b/finix/model/compliance_form.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.compliance_form_files import ComplianceFormFiles
from finix.model.compliance_form_pci_saq_a import ComplianceFormPciSaqA
- from finix.model.tags import Tags
globals()['ComplianceFormFiles'] = ComplianceFormFiles
globals()['ComplianceFormPciSaqA'] = ComplianceFormPciSaqA
- globals()['Tags'] = Tags
class ComplianceForm(ModelNormal):
@@ -58,15 +56,15 @@ class ComplianceForm(ModelNormal):
"""
allowed_values = {
- ('type',): {
- 'PCI_SAQ_A': "PCI_SAQ_A",
- },
('state',): {
'PENDING': "PENDING",
- 'COMPLETED': "COMPLETED",
+ 'COMPLETE': "COMPLETE",
'INVALID': "INVALID",
'INCOMPLETE': "INCOMPLETE",
},
+ ('type',): {
+ 'PCI_SAQ_A': "PCI_SAQ_A",
+ },
}
validations = {
@@ -96,19 +94,21 @@ def openapi_types():
lazy_import()
return {
'id': (str,), # noqa: E501
- 'type': (str,), # noqa: E501
- 'state': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
+ 'application_id': (str,), # noqa: E501
+ 'compliance_form_template': (str,), # noqa: E501
'due_at': (datetime,), # noqa: E501
+ 'files': (ComplianceFormFiles,), # noqa: E501
'linked_to': (str,), # noqa: E501
'linked_type': (str,), # noqa: E501
'pci_saq_a': (ComplianceFormPciSaqA,), # noqa: E501
- 'files': (ComplianceFormFiles,), # noqa: E501
+ 'state': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'type': (str,), # noqa: E501
'valid_from': (datetime,), # noqa: E501
'valid_until': (str,), # noqa: E501
- 'compliance_form_template': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'version': (str,), # noqa: E501
}
@cached_property
@@ -118,19 +118,21 @@ def discriminator():
attribute_map = {
'id': 'id', # noqa: E501
- 'type': 'type', # noqa: E501
- 'state': 'state', # noqa: E501
'created_at': 'created_at', # noqa: E501
'updated_at': 'updated_at', # noqa: E501
+ 'application_id': 'application_id', # noqa: E501
+ 'compliance_form_template': 'compliance_form_template', # noqa: E501
'due_at': 'due_at', # noqa: E501
+ 'files': 'files', # noqa: E501
'linked_to': 'linked_to', # noqa: E501
'linked_type': 'linked_type', # noqa: E501
'pci_saq_a': 'pci_saq_a', # noqa: E501
- 'files': 'files', # noqa: E501
+ 'state': 'state', # noqa: E501
+ 'tags': 'tags', # noqa: E501
+ 'type': 'type', # noqa: E501
'valid_from': 'valid_from', # noqa: E501
'valid_until': 'valid_until', # noqa: E501
- 'compliance_form_template': 'compliance_form_template', # noqa: E501
- 'tags': 'tags', # noqa: E501
+ 'version': 'version', # noqa: E501
}
read_only_vars = {
@@ -175,19 +177,21 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
id (str): ID of the `compliance_form`.. [optional] # noqa: E501
- type (str): Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.. [optional] if omitted the server will use the default value of "PCI_SAQ_A" # noqa: E501
- state (str): The state of the `compliance_form`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ application_id (str): The ID of the `Application` the `compliance_form` was created under.. [optional] # noqa: E501
+ compliance_form_template (str): Template linked to this `compliance_form`.. [optional] # noqa: E501
due_at (datetime): Timestamp of when the `compliance_form` must be completed by.. [optional] # noqa: E501
+ files (ComplianceFormFiles): [optional] # noqa: E501
linked_to (str): The ID of the `merchant` linked to the `compliance_form`.. [optional] # noqa: E501
linked_type (str): The type of resource this `compliance_form` is linked to.. [optional] # noqa: E501
pci_saq_a (ComplianceFormPciSaqA): [optional] # noqa: E501
- files (ComplianceFormFiles): [optional] # noqa: E501
+ state (str): The state of the `compliance_form`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.. [optional] if omitted the server will use the default value of "PCI_SAQ_A" # noqa: E501
valid_from (datetime): Timestamp of when the `compliance_form` becomes active and valid.. [optional] # noqa: E501
valid_until (str): Timestamp of when the `compliance_form` is no longer active and valid.. [optional] # noqa: E501
- compliance_form_template (str): Template linked to this `compliance_form`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ version (str): Details the version of the SAQ form. When `compliance_forms` are created, Finix automatically provides the most up-to-date SAQ form that's available.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -270,19 +274,21 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
id (str): ID of the `compliance_form`.. [optional] # noqa: E501
- type (str): Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.. [optional] if omitted the server will use the default value of "PCI_SAQ_A" # noqa: E501
- state (str): The state of the `compliance_form`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ application_id (str): The ID of the `Application` the `compliance_form` was created under.. [optional] # noqa: E501
+ compliance_form_template (str): Template linked to this `compliance_form`.. [optional] # noqa: E501
due_at (datetime): Timestamp of when the `compliance_form` must be completed by.. [optional] # noqa: E501
+ files (ComplianceFormFiles): [optional] # noqa: E501
linked_to (str): The ID of the `merchant` linked to the `compliance_form`.. [optional] # noqa: E501
linked_type (str): The type of resource this `compliance_form` is linked to.. [optional] # noqa: E501
pci_saq_a (ComplianceFormPciSaqA): [optional] # noqa: E501
- files (ComplianceFormFiles): [optional] # noqa: E501
+ state (str): The state of the `compliance_form`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.. [optional] if omitted the server will use the default value of "PCI_SAQ_A" # noqa: E501
valid_from (datetime): Timestamp of when the `compliance_form` becomes active and valid.. [optional] # noqa: E501
valid_until (str): Timestamp of when the `compliance_form` is no longer active and valid.. [optional] # noqa: E501
- compliance_form_template (str): Template linked to this `compliance_form`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ version (str): Details the version of the SAQ form. When `compliance_forms` are created, Finix automatically provides the most up-to-date SAQ form that's available.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/compliance_form_files.py b/finix/model/compliance_form_files.py
index d75ad37..dc5f4c3 100644
--- a/finix/model/compliance_form_files.py
+++ b/finix/model/compliance_form_files.py
@@ -76,8 +76,8 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'unsigned_file': (str,), # noqa: E501
'signed_file': (str, none_type,), # noqa: E501
+ 'unsigned_file': (str,), # noqa: E501
}
@cached_property
@@ -86,8 +86,8 @@ def discriminator():
attribute_map = {
- 'unsigned_file': 'unsigned_file', # noqa: E501
'signed_file': 'signed_file', # noqa: E501
+ 'unsigned_file': 'unsigned_file', # noqa: E501
}
read_only_vars = {
@@ -131,8 +131,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- unsigned_file (str): ID of the `File` resource that has the `compliance_form`.. [optional] # noqa: E501
signed_file (str, none_type):
- Autofills to null.
- When a compliance_form is attested, signed_file will contain a File corresponding to the signed version of the form.
. [optional] # noqa: E501
+ unsigned_file (str): ID of the `File` resource that has the `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -214,8 +214,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- unsigned_file (str): ID of the `File` resource that has the `compliance_form`.. [optional] # noqa: E501
signed_file (str, none_type): - Autofills to null.
- When a compliance_form is attested, signed_file will contain a File corresponding to the signed version of the form.
. [optional] # noqa: E501
+ unsigned_file (str): ID of the `File` resource that has the `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/compliance_form_list.py b/finix/model/compliance_form_list.py
new file mode 100644
index 0000000..9037be9
--- /dev/null
+++ b/finix/model/compliance_form_list.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.compliance_form_list_embedded import ComplianceFormListEmbedded
+ from finix.model.list_links import ListLinks
+ from finix.model.page_cursor import PageCursor
+ globals()['ComplianceFormListEmbedded'] = ComplianceFormListEmbedded
+ globals()['ListLinks'] = ListLinks
+ globals()['PageCursor'] = PageCursor
+
+
+class ComplianceFormList(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'embedded': (ComplianceFormListEmbedded,), # noqa: E501
+ 'links': (ListLinks,), # noqa: E501
+ 'page': (PageCursor,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'embedded': '_embedded', # noqa: E501
+ 'links': '_links', # noqa: E501
+ 'page': 'page', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """ComplianceFormList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (ComplianceFormListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """ComplianceFormList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (ComplianceFormListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/compliance_form_list_embedded.py b/finix/model/compliance_form_list_embedded.py
new file mode 100644
index 0000000..bfd5014
--- /dev/null
+++ b/finix/model/compliance_form_list_embedded.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.compliance_form import ComplianceForm
+ globals()['ComplianceForm'] = ComplianceForm
+
+
+class ComplianceFormListEmbedded(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'compliance_forms': ([ComplianceForm],), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'compliance_forms': 'compliance_forms', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """ComplianceFormListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ compliance_forms ([ComplianceForm]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """ComplianceFormListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ compliance_forms ([ComplianceForm]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/compliance_form_pci_saq_a.py b/finix/model/compliance_form_pci_saq_a.py
index 7ba875e..abfc456 100644
--- a/finix/model/compliance_form_pci_saq_a.py
+++ b/finix/model/compliance_form_pci_saq_a.py
@@ -76,12 +76,12 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'name': (str, none_type,), # noqa: E501
- 'signed_at': (str, none_type,), # noqa: E501
- 'user_agent': (str, none_type,), # noqa: E501
'ip_address': (str, none_type,), # noqa: E501
'is_accepted': (bool, none_type,), # noqa: E501
+ 'name': (str, none_type,), # noqa: E501
+ 'signed_at': (str, none_type,), # noqa: E501
'title': (str, none_type,), # noqa: E501
+ 'user_agent': (str, none_type,), # noqa: E501
}
@cached_property
@@ -90,12 +90,12 @@ def discriminator():
attribute_map = {
- 'name': 'name', # noqa: E501
- 'signed_at': 'signed_at', # noqa: E501
- 'user_agent': 'user_agent', # noqa: E501
'ip_address': 'ip_address', # noqa: E501
'is_accepted': 'is_accepted', # noqa: E501
+ 'name': 'name', # noqa: E501
+ 'signed_at': 'signed_at', # noqa: E501
'title': 'title', # noqa: E501
+ 'user_agent': 'user_agent', # noqa: E501
}
read_only_vars = {
@@ -139,12 +139,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- name (str, none_type): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
- signed_at (str, none_type): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- user_agent (str, none_type): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
ip_address (str, none_type): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
is_accepted (bool, none_type): If all `pci_saq_a` fields are all submitted, `is_accepted` updates to **true**.. [optional] # noqa: E501
+ name (str, none_type): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ signed_at (str, none_type): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
title (str, none_type): Title or role of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ user_agent (str, none_type): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -226,12 +226,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- name (str, none_type): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
- signed_at (str, none_type): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- user_agent (str, none_type): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
ip_address (str, none_type): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
is_accepted (bool, none_type): If all `pci_saq_a` fields are all submitted, `is_accepted` updates to **true**.. [optional] # noqa: E501
+ name (str, none_type): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ signed_at (str, none_type): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
title (str, none_type): Title or role of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ user_agent (str, none_type): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/configuration_details.py b/finix/model/configuration_details.py
index 2b9aa0a..7793a23 100644
--- a/finix/model/configuration_details.py
+++ b/finix/model/configuration_details.py
@@ -27,12 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.configuration_details_cashback_options import ConfigurationDetailsCashbackOptions
- from finix.model.configuration_details_tip_options import ConfigurationDetailsTipOptions
- globals()['ConfigurationDetailsCashbackOptions'] = ConfigurationDetailsCashbackOptions
- globals()['ConfigurationDetailsTipOptions'] = ConfigurationDetailsTipOptions
-
class ConfigurationDetails(ModelNormal):
"""
@@ -67,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -82,22 +75,14 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'allow_debit': (bool,), # noqa: E501
- 'allow_partial_approvals': (bool,), # noqa: E501
'bypass_device_on_capture': (bool,), # noqa: E501
- 'cashback_options': (ConfigurationDetailsCashbackOptions,), # noqa: E501
'check_for_duplicate_transactions': (bool,), # noqa: E501
- 'is_cash_back_allowed': (bool,), # noqa: E501
- 'is_gift_supported': (str,), # noqa: E501
- 'is_manual_entry_allowed': (bool,), # noqa: E501
- 'market_code': (str,), # noqa: E501
'prompt_amount_confirmation': (bool,), # noqa: E501
'prompt_manual_entry': (bool,), # noqa: E501
'prompt_signature': (str,), # noqa: E501
'signature_threshold_amount': (int,), # noqa: E501
- 'tip_options': (ConfigurationDetailsTipOptions,), # noqa: E501
}
@cached_property
@@ -107,19 +92,12 @@ def discriminator():
attribute_map = {
'allow_debit': 'allow_debit', # noqa: E501
- 'allow_partial_approvals': 'allow_partial_approvals', # noqa: E501
'bypass_device_on_capture': 'bypass_device_on_capture', # noqa: E501
- 'cashback_options': 'cashback_options', # noqa: E501
'check_for_duplicate_transactions': 'check_for_duplicate_transactions', # noqa: E501
- 'is_cash_back_allowed': 'is_cash_back_allowed', # noqa: E501
- 'is_gift_supported': 'is_gift_supported', # noqa: E501
- 'is_manual_entry_allowed': 'is_manual_entry_allowed', # noqa: E501
- 'market_code': 'market_code', # noqa: E501
'prompt_amount_confirmation': 'prompt_amount_confirmation', # noqa: E501
'prompt_manual_entry': 'prompt_manual_entry', # noqa: E501
'prompt_signature': 'prompt_signature', # noqa: E501
'signature_threshold_amount': 'signature_threshold_amount', # noqa: E501
- 'tip_options': 'tip_options', # noqa: E501
}
read_only_vars = {
@@ -164,19 +142,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
allow_debit (bool): Allow transaction to be processed on Debit rails. If `false`, Debit card transactions will be processed on Credit rails.. [optional] # noqa: E501
- allow_partial_approvals (bool): Determines if a transaction can be partially approved (Usually **null**).. [optional] # noqa: E501
bypass_device_on_capture (bool): Sets whether the device will be used to capture `Authorizations`. The device is required to be connected if `bypass_device_on_capture` is set to false. (defaults to true).. [optional] # noqa: E501
- cashback_options (ConfigurationDetailsCashbackOptions): [optional] # noqa: E501
check_for_duplicate_transactions (bool): Sets whether the device will check for duplicate transactions.. [optional] # noqa: E501
- is_cash_back_allowed (bool): Sets whether the device will allow cash back.. [optional] # noqa: E501
- is_gift_supported (str): Sets whether the device will allow gifting funds.. [optional] # noqa: E501
- is_manual_entry_allowed (bool): Sets whether the device will process payment details entered manually.. [optional] # noqa: E501
- market_code (str): Used by the processor to handle the `transfer`. Usually **null**.. [optional] # noqa: E501
prompt_amount_confirmation (bool): Sets if the card holder needs to confirm the amount they will pay (defaults to **true**).. [optional] # noqa: E501
prompt_manual_entry (bool): Sets if the device defaults to manual entry as the default card input method. (defaults to **false**).. [optional] # noqa: E501
prompt_signature (str): Sets if the device will prompt the card holder for a signature by default. Available values include:- ALWAYS
- NEVER
- AMOUNT: Used in conjunction with `signature_threshold_amount` so when the threshold is reached the signature form appears on the device.. [optional] # noqa: E501
signature_threshold_amount (int): The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0).. [optional] # noqa: E501
- tip_options (ConfigurationDetailsTipOptions): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -259,19 +230,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
allow_debit (bool): Allow transaction to be processed on Debit rails. If `false`, Debit card transactions will be processed on Credit rails.. [optional] # noqa: E501
- allow_partial_approvals (bool): Determines if a transaction can be partially approved (Usually **null**).. [optional] # noqa: E501
bypass_device_on_capture (bool): Sets whether the device will be used to capture `Authorizations`. The device is required to be connected if `bypass_device_on_capture` is set to false. (defaults to true).. [optional] # noqa: E501
- cashback_options (ConfigurationDetailsCashbackOptions): [optional] # noqa: E501
check_for_duplicate_transactions (bool): Sets whether the device will check for duplicate transactions.. [optional] # noqa: E501
- is_cash_back_allowed (bool): Sets whether the device will allow cash back.. [optional] # noqa: E501
- is_gift_supported (str): Sets whether the device will allow gifting funds.. [optional] # noqa: E501
- is_manual_entry_allowed (bool): Sets whether the device will process payment details entered manually.. [optional] # noqa: E501
- market_code (str): Used by the processor to handle the `transfer`. Usually **null**.. [optional] # noqa: E501
prompt_amount_confirmation (bool): Sets if the card holder needs to confirm the amount they will pay (defaults to **true**).. [optional] # noqa: E501
prompt_manual_entry (bool): Sets if the device defaults to manual entry as the default card input method. (defaults to **false**).. [optional] # noqa: E501
prompt_signature (str): Sets if the device will prompt the card holder for a signature by default. Available values include:
- ALWAYS
- NEVER
- AMOUNT: Used in conjunction with `signature_threshold_amount` so when the threshold is reached the signature form appears on the device.. [optional] # noqa: E501
signature_threshold_amount (int): The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0).. [optional] # noqa: E501
- tip_options (ConfigurationDetailsTipOptions): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_application_request.py b/finix/model/create_application_request.py
index 4cc01fe..5cb7c9b 100644
--- a/finix/model/create_application_request.py
+++ b/finix/model/create_application_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.identity_entity_form import IdentityEntityForm
- from finix.model.tags import Tags
globals()['IdentityEntityForm'] = IdentityEntityForm
- globals()['Tags'] = Tags
class CreateApplicationRequest(ModelNormal):
@@ -88,7 +86,7 @@ def openapi_types():
'entity': (IdentityEntityForm,), # noqa: E501
'max_transaction_amount': (int, none_type,), # noqa: E501
'name': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -151,7 +149,7 @@ def _from_openapi_data(cls, user, *args, **kwargs): # noqa: E501
entity (IdentityEntityForm): [optional] # noqa: E501
max_transaction_amount (int, none_type): Maximum amount that can be processed for a single transaction in cents (max 12 characters).. [optional] # noqa: E501
name (str, none_type): Merchant's full legal business name (If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, enter first name, Full legal last name and middle initial; max 120 characters).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -240,7 +238,7 @@ def __init__(self, user, *args, **kwargs): # noqa: E501
entity (IdentityEntityForm): [optional] # noqa: E501
max_transaction_amount (int, none_type): Maximum amount that can be processed for a single transaction in cents (max 12 characters).. [optional] # noqa: E501
name (str, none_type): Merchant's full legal business name (If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, enter first name, Full legal last name and middle initial; max 120 characters).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_associated_identity_request.py b/finix/model/create_associated_identity_request.py
index ab0cf4e..3e09572 100644
--- a/finix/model/create_associated_identity_request.py
+++ b/finix/model/create_associated_identity_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.create_associated_identity_request_entity import CreateAssociatedIdentityRequestEntity
- from finix.model.tags import Tags
globals()['CreateAssociatedIdentityRequestEntity'] = CreateAssociatedIdentityRequestEntity
- globals()['Tags'] = Tags
class CreateAssociatedIdentityRequest(ModelNormal):
@@ -85,7 +83,7 @@ def openapi_types():
lazy_import()
return {
'entity': (CreateAssociatedIdentityRequestEntity,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -140,7 +138,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
entity (CreateAssociatedIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,7 +221,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
entity (CreateAssociatedIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_associated_identity_request_entity.py b/finix/model/create_associated_identity_request_entity.py
index 321699c..eb6fc20 100644
--- a/finix/model/create_associated_identity_request_entity.py
+++ b/finix/model/create_associated_identity_request_entity.py
@@ -30,12 +30,12 @@
def lazy_import():
from finix.model.create_associated_identity_request_entity_business_address import CreateAssociatedIdentityRequestEntityBusinessAddress
from finix.model.create_associated_identity_request_entity_dob import CreateAssociatedIdentityRequestEntityDob
- from finix.model.create_associated_identity_request_entity_incorporation_date import CreateAssociatedIdentityRequestEntityIncorporationDate
from finix.model.create_associated_identity_request_entity_personal_address import CreateAssociatedIdentityRequestEntityPersonalAddress
+ from finix.model.identity_entity_form_incorporation_date import IdentityEntityFormIncorporationDate
globals()['CreateAssociatedIdentityRequestEntityBusinessAddress'] = CreateAssociatedIdentityRequestEntityBusinessAddress
globals()['CreateAssociatedIdentityRequestEntityDob'] = CreateAssociatedIdentityRequestEntityDob
- globals()['CreateAssociatedIdentityRequestEntityIncorporationDate'] = CreateAssociatedIdentityRequestEntityIncorporationDate
globals()['CreateAssociatedIdentityRequestEntityPersonalAddress'] = CreateAssociatedIdentityRequestEntityPersonalAddress
+ globals()['IdentityEntityFormIncorporationDate'] = IdentityEntityFormIncorporationDate
class CreateAssociatedIdentityRequestEntity(ModelNormal):
@@ -155,11 +155,11 @@ def openapi_types():
'email': (str,), # noqa: E501
'first_name': (str,), # noqa: E501
'has_accepted_credit_cards_previously': (bool,), # noqa: E501
- 'incorporation_date': (CreateAssociatedIdentityRequestEntityIncorporationDate,), # noqa: E501
+ 'incorporation_date': (IdentityEntityFormIncorporationDate,), # noqa: E501
'last_name': (str,), # noqa: E501
'max_transaction_amount': (int,), # noqa: E501
'mcc': (str,), # noqa: E501
- 'ownership_type': (str,), # noqa: E501
+ 'ownership_type': (str, none_type,), # noqa: E501
'personal_address': (CreateAssociatedIdentityRequestEntityPersonalAddress,), # noqa: E501
'phone': (str,), # noqa: E501
'principal_percentage_ownership': (int,), # noqa: E501
@@ -244,7 +244,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
business_address (CreateAssociatedIdentityRequestEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
- business_tax_id (str): Details if the `business_tax_id` was provided.. [optional] # noqa: E501
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).. [optional] # noqa: E501
business_type (str): Include the value that best applies to the merchant.. [optional] # noqa: E501
default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
dob (CreateAssociatedIdentityRequestEntityDob): [optional] # noqa: E501
@@ -252,11 +252,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
email (str): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str): The legal first name of the control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (CreateAssociatedIdentityRequestEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str): The `Identity` owner's legal last name.. [optional] # noqa: E501
max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
- ownership_type (str): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (CreateAssociatedIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
phone (str): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
@@ -348,7 +348,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
business_address (CreateAssociatedIdentityRequestEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
- business_tax_id (str): Details if the `business_tax_id` was provided.. [optional] # noqa: E501
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).. [optional] # noqa: E501
business_type (str): Include the value that best applies to the merchant.. [optional] # noqa: E501
default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
dob (CreateAssociatedIdentityRequestEntityDob): [optional] # noqa: E501
@@ -356,11 +356,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
email (str): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str): The legal first name of the control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (CreateAssociatedIdentityRequestEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str): The `Identity` owner's legal last name.. [optional] # noqa: E501
max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
- ownership_type (str): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (CreateAssociatedIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
phone (str): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
diff --git a/finix/model/create_associated_identity_request_entity_business_address.py b/finix/model/create_associated_identity_request_entity_business_address.py
index 55e064b..99e602e 100644
--- a/finix/model/create_associated_identity_request_entity_business_address.py
+++ b/finix/model/create_associated_identity_request_entity_business_address.py
@@ -59,9 +59,6 @@ class CreateAssociatedIdentityRequestEntityBusinessAddress(ModelNormal):
('country',): {
'min_length': 1,
},
- ('region',): {
- 'min_length': 1,
- },
('line2',): {
'min_length': 1,
},
@@ -71,6 +68,9 @@ class CreateAssociatedIdentityRequestEntityBusinessAddress(ModelNormal):
('postal_code',): {
'min_length': 1,
},
+ ('region',): {
+ 'min_length': 1,
+ },
}
@cached_property
@@ -96,10 +96,10 @@ def openapi_types():
return {
'city': (str,), # noqa: E501
'country': (str,), # noqa: E501
- 'region': (str,), # noqa: E501
'line2': (str,), # noqa: E501
'line1': (str,), # noqa: E501
'postal_code': (str,), # noqa: E501
+ 'region': (str,), # noqa: E501
}
@cached_property
@@ -110,10 +110,10 @@ def discriminator():
attribute_map = {
'city': 'city', # noqa: E501
'country': 'country', # noqa: E501
- 'region': 'region', # noqa: E501
'line2': 'line2', # noqa: E501
'line1': 'line1', # noqa: E501
'postal_code': 'postal_code', # noqa: E501
+ 'region': 'region', # noqa: E501
}
read_only_vars = {
@@ -159,10 +159,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): [optional] # noqa: E501
- region (str): 2-letter state code.. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ region (str): 2-letter state code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -246,10 +246,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): [optional] # noqa: E501
- region (str): 2-letter state code.. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ region (str): 2-letter state code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_associated_identity_request_entity_dob.py b/finix/model/create_associated_identity_request_entity_dob.py
index 20f5210..faa1430 100644
--- a/finix/model/create_associated_identity_request_entity_dob.py
+++ b/finix/model/create_associated_identity_request_entity_dob.py
@@ -76,9 +76,9 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'year': (int,), # noqa: E501
'day': (int,), # noqa: E501
'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
}
@cached_property
@@ -87,9 +87,9 @@ def discriminator():
attribute_map = {
- 'year': 'year', # noqa: E501
'day': 'day', # noqa: E501
'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
}
read_only_vars = {
@@ -133,9 +133,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): [optional] # noqa: E501
day (int): [optional] # noqa: E501
month (int): [optional] # noqa: E501
+ year (int): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,9 +217,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): [optional] # noqa: E501
day (int): [optional] # noqa: E501
month (int): [optional] # noqa: E501
+ year (int): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_associated_identity_request_entity_personal_address.py b/finix/model/create_associated_identity_request_entity_personal_address.py
index 1d031b1..eab36cb 100644
--- a/finix/model/create_associated_identity_request_entity_personal_address.py
+++ b/finix/model/create_associated_identity_request_entity_personal_address.py
@@ -59,16 +59,16 @@ class CreateAssociatedIdentityRequestEntityPersonalAddress(ModelNormal):
('country',): {
'min_length': 1,
},
- ('region',): {
+ ('line1',): {
'min_length': 1,
},
('line2',): {
'min_length': 1,
},
- ('line1',): {
+ ('postal_code',): {
'min_length': 1,
},
- ('postal_code',): {
+ ('region',): {
'min_length': 1,
},
}
@@ -96,10 +96,10 @@ def openapi_types():
return {
'city': (str,), # noqa: E501
'country': (str,), # noqa: E501
- 'region': (str,), # noqa: E501
- 'line2': (str,), # noqa: E501
'line1': (str,), # noqa: E501
+ 'line2': (str,), # noqa: E501
'postal_code': (str,), # noqa: E501
+ 'region': (str,), # noqa: E501
}
@cached_property
@@ -110,10 +110,10 @@ def discriminator():
attribute_map = {
'city': 'city', # noqa: E501
'country': 'country', # noqa: E501
- 'region': 'region', # noqa: E501
- 'line2': 'line2', # noqa: E501
'line1': 'line1', # noqa: E501
+ 'line2': 'line2', # noqa: E501
'postal_code': 'postal_code', # noqa: E501
+ 'region': 'region', # noqa: E501
}
read_only_vars = {
@@ -159,10 +159,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- region (str): 2-letter State code.. [optional] # noqa: E501
- line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ region (str): 2-letter State code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -246,10 +246,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- region (str): 2-letter State code.. [optional] # noqa: E501
- line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ region (str): 2-letter State code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_authorization_request.py b/finix/model/create_authorization_request.py
index 8124964..4990035 100644
--- a/finix/model/create_authorization_request.py
+++ b/finix/model/create_authorization_request.py
@@ -32,14 +32,14 @@ def lazy_import():
from finix.model.additional_purchase_data import AdditionalPurchaseData
from finix.model.create_authorization_request3d_secure_authentication import CreateAuthorizationRequest3dSecureAuthentication
from finix.model.currency import Currency
+ from finix.model.l3_additional_purchase_data import L3AdditionalPurchaseData
from finix.model.operation_key import OperationKey
- from finix.model.tags import Tags
globals()['AdditionalBuyerCharges'] = AdditionalBuyerCharges
globals()['AdditionalPurchaseData'] = AdditionalPurchaseData
globals()['CreateAuthorizationRequest3dSecureAuthentication'] = CreateAuthorizationRequest3dSecureAuthentication
globals()['Currency'] = Currency
+ globals()['L3AdditionalPurchaseData'] = L3AdditionalPurchaseData
globals()['OperationKey'] = OperationKey
- globals()['Tags'] = Tags
class CreateAuthorizationRequest(ModelNormal):
@@ -92,18 +92,21 @@ def openapi_types():
"""
lazy_import()
return {
- 'amount': (int,), # noqa: E501
- 'currency': (Currency,), # noqa: E501
'additional_buyer_charges': (AdditionalBuyerCharges,), # noqa: E501
'additional_purchase_data': (AdditionalPurchaseData,), # noqa: E501
- 'device': (str, none_type,), # noqa: E501
+ 'amount': (int,), # noqa: E501
+ 'currency': (Currency,), # noqa: E501
+ 'device': (str,), # noqa: E501
'fraud_session_id': (str,), # noqa: E501
+ 'hsa_fsa_payment': (bool, none_type,), # noqa: E501
'idempotency_id': (str, none_type,), # noqa: E501
- 'merchant': (str, none_type,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
'operation_key': (OperationKey,), # noqa: E501
- 'source': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'security_code': (str,), # noqa: E501
+ 'source': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'_3d_secure_authentication': (CreateAuthorizationRequest3dSecureAuthentication,), # noqa: E501
+ 'additional_purchase_data_': (L3AdditionalPurchaseData,), # noqa: E501
}
@cached_property
@@ -112,18 +115,21 @@ def discriminator():
attribute_map = {
- 'amount': 'amount', # noqa: E501
- 'currency': 'currency', # noqa: E501
'additional_buyer_charges': 'additional_buyer_charges', # noqa: E501
'additional_purchase_data': 'additional_purchase_data', # noqa: E501
+ 'amount': 'amount', # noqa: E501
+ 'currency': 'currency', # noqa: E501
'device': 'device', # noqa: E501
'fraud_session_id': 'fraud_session_id', # noqa: E501
+ 'hsa_fsa_payment': 'hsa_fsa_payment', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
'merchant': 'merchant', # noqa: E501
'operation_key': 'operation_key', # noqa: E501
+ 'security_code': 'security_code', # noqa: E501
'source': 'source', # noqa: E501
'tags': 'tags', # noqa: E501
'_3d_secure_authentication': '3d_secure_authentication', # noqa: E501
+ 'additional_purchase_data_': 'additional_purchase_data ', # noqa: E501
}
read_only_vars = {
@@ -133,13 +139,9 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
"""CreateAuthorizationRequest - a model defined in OpenAPI
- Args:
- amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
- currency (Currency):
-
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -173,14 +175,19 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
- device (str, none_type): The ID of the resource.. [optional] # noqa: E501
- fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
- merchant (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
+ device (str): The ID of the `Device` that the `Authorization` was created under.. [optional] # noqa: E501
+ fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/guides/payments/fraud-detection/).. [optional] # noqa: E501
+ hsa_fsa_payment (bool, none_type): Set to to **true** to process a payment using a `Payment Instrument` [created from a health savings account (HSA) or flexible spending account (FSA)](/guides/making-a-payment/hsa-fsa/).. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` that the `Authorization` was created under.. [optional] # noqa: E501
operation_key (OperationKey): [optional] # noqa: E501
- source (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ security_code (str): The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Authorization`.. [optional] # noqa: E501
+ source (str): The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
_3d_secure_authentication (CreateAuthorizationRequest3dSecureAuthentication): [optional] # noqa: E501
+ additional_purchase_data_ (L3AdditionalPurchaseData): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -208,8 +215,6 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
- self.amount = amount
- self.currency = currency
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -230,13 +235,9 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
+ def __init__(self, *args, **kwargs): # noqa: E501
"""CreateAuthorizationRequest - a model defined in OpenAPI
- Args:
- amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
- currency (Currency):
-
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -270,14 +271,19 @@ def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
- device (str, none_type): The ID of the resource.. [optional] # noqa: E501
- fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
- merchant (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
+ device (str): The ID of the `Device` that the `Authorization` was created under.. [optional] # noqa: E501
+ fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/guides/payments/fraud-detection/).. [optional] # noqa: E501
+ hsa_fsa_payment (bool, none_type): Set to to **true** to process a payment using a `Payment Instrument` [created from a health savings account (HSA) or flexible spending account (FSA)](/guides/making-a-payment/hsa-fsa/).. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` that the `Authorization` was created under.. [optional] # noqa: E501
operation_key (OperationKey): [optional] # noqa: E501
- source (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ security_code (str): The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Authorization`.. [optional] # noqa: E501
+ source (str): The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
_3d_secure_authentication (CreateAuthorizationRequest3dSecureAuthentication): [optional] # noqa: E501
+ additional_purchase_data_ (L3AdditionalPurchaseData): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -303,8 +309,6 @@ def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
- self.amount = amount
- self.currency = currency
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_authorization_request3d_secure_authentication.py b/finix/model/create_authorization_request3d_secure_authentication.py
index 28de99c..5fd55de 100644
--- a/finix/model/create_authorization_request3d_secure_authentication.py
+++ b/finix/model/create_authorization_request3d_secure_authentication.py
@@ -77,8 +77,8 @@ def openapi_types():
"""
return {
'cardholder_authentication': (str,), # noqa: E501
- 'cardholder_ip_address': (str,), # noqa: E501
'electronic_commerce_indicator': (str,), # noqa: E501
+ 'cardholder_ip_address': (str,), # noqa: E501
'transaction_id': (str,), # noqa: E501
}
@@ -89,8 +89,8 @@ def discriminator():
attribute_map = {
'cardholder_authentication': 'cardholder_authentication', # noqa: E501
- 'cardholder_ip_address': 'cardholder_ip_address', # noqa: E501
'electronic_commerce_indicator': 'electronic_commerce_indicator', # noqa: E501
+ 'cardholder_ip_address': 'cardholder_ip_address', # noqa: E501
'transaction_id': 'transaction_id', # noqa: E501
}
@@ -101,9 +101,13 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, cardholder_authentication, electronic_commerce_indicator, *args, **kwargs): # noqa: E501
"""CreateAuthorizationRequest3dSecureAuthentication - a model defined in OpenAPI
+ Args:
+ cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
+ electronic_commerce_indicator (str): - **AUTHENTICATED**: Approved by 3D Secure Vendor. - **ATTEMPTED**: Issuer or cardholder doesn't support 3D Secure.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -135,10 +139,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.. [optional] # noqa: E501
- cardholder_ip_address (str): Only required for American Express cards. Format is nnn.nnn.nnn.nnn. [optional] # noqa: E501
- electronic_commerce_indicator (str): AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED: Issuer or cardholder does not support 3D Secure. [optional] # noqa: E501
- transaction_id (str): Only valid for Visa transactions. [optional] # noqa: E501
+ cardholder_ip_address (str): Only required for **American Express** cards.. [optional] # noqa: E501
+ transaction_id (str): Only required for **Visa** cards.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -166,6 +168,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.cardholder_authentication = cardholder_authentication
+ self.electronic_commerce_indicator = electronic_commerce_indicator
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -186,9 +190,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, *args, **kwargs): # noqa: E501
+ def __init__(self, cardholder_authentication, electronic_commerce_indicator, *args, **kwargs): # noqa: E501
"""CreateAuthorizationRequest3dSecureAuthentication - a model defined in OpenAPI
+ Args:
+ cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
+ electronic_commerce_indicator (str): - **AUTHENTICATED**: Approved by 3D Secure Vendor. - **ATTEMPTED**: Issuer or cardholder doesn't support 3D Secure.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -220,10 +228,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.. [optional] # noqa: E501
- cardholder_ip_address (str): Only required for American Express cards. Format is nnn.nnn.nnn.nnn. [optional] # noqa: E501
- electronic_commerce_indicator (str): AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED: Issuer or cardholder does not support 3D Secure. [optional] # noqa: E501
- transaction_id (str): Only valid for Visa transactions. [optional] # noqa: E501
+ cardholder_ip_address (str): Only required for **American Express** cards.. [optional] # noqa: E501
+ transaction_id (str): Only required for **Visa** cards.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -249,6 +255,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.cardholder_authentication = cardholder_authentication
+ self.electronic_commerce_indicator = electronic_commerce_indicator
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_balance_transfer_request.py b/finix/model/create_balance_transfer_request.py
index 42e208a..4a9ff6d 100644
--- a/finix/model/create_balance_transfer_request.py
+++ b/finix/model/create_balance_transfer_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.currency import Currency
- from finix.model.tags import Tags
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class CreateBalanceTransferRequest(ModelNormal):
@@ -99,7 +97,7 @@ def openapi_types():
'destination': (str, none_type,), # noqa: E501
'processor_type': (str,), # noqa: E501
'source': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -166,7 +164,7 @@ def _from_openapi_data(cls, amount, currency, description, destination, processo
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -262,7 +260,7 @@ def __init__(self, amount, currency, description, destination, processor_type, s
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_device.py b/finix/model/create_device.py
index a653e32..f552d91 100644
--- a/finix/model/create_device.py
+++ b/finix/model/create_device.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.configuration_details import ConfigurationDetails
- from finix.model.tags import Tags
globals()['ConfigurationDetails'] = ConfigurationDetails
- globals()['Tags'] = Tags
class CreateDevice(ModelNormal):
@@ -58,16 +56,29 @@ class CreateDevice(ModelNormal):
allowed_values = {
('model',): {
'BBPOS': "BBPOS",
- 'MX915': "MX915",
- 'MX925': "MX925",
+ 'DESK_3500': "DESK_3500",
+ 'DESK_5000': "DESK_5000",
'IPP320': "IPP320",
'IPP350': "IPP350",
'ISC250': "ISC250",
'ISC480': "ISC480",
'ISMP4': "ISMP4",
- 'ANDROID': "ANDROID",
'LANE_3000': "LANE_3000",
+ 'LANE_5000': "LANE_5000",
+ 'LANE_7000': "LANE_7000",
+ 'LANE_8000': "LANE_8000",
'LINK_2500': "LINK_2500",
+ 'MOVE_5000': "MOVE_5000",
+ 'MX915': "MX915",
+ 'MX925': "MX925",
+ 'PAX_A30': "PAX_A30",
+ 'PAX_A35': "PAX_A35",
+ 'PAX_A60': "PAX_A60",
+ 'PAX_A77': "PAX_A77",
+ 'PAX_A920PRO': "PAX_A920PRO",
+ 'PAX_ARIES6': "PAX_ARIES6",
+ 'PAX_ARIES8': "PAX_ARIES8",
+ 'PAX_IM30': "PAX_IM30",
},
}
@@ -101,7 +112,7 @@ def openapi_types():
'name': (str,), # noqa: E501
'configuration': (ConfigurationDetails,), # noqa: E501
'description': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -164,7 +175,7 @@ def _from_openapi_data(cls, model, name, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
configuration (ConfigurationDetails): [optional] # noqa: E501
description (str): Additional information about device (e.g. self serving terminal).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -254,7 +265,7 @@ def __init__(self, model, name, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
configuration (ConfigurationDetails): [optional] # noqa: E501
description (str): Additional information about device (e.g. self serving terminal).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_external_link_request.py b/finix/model/create_external_link_request.py
index 5c32579..108ec89 100644
--- a/finix/model/create_external_link_request.py
+++ b/finix/model/create_external_link_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateExternalLinkRequest(ModelNormal):
"""
@@ -70,7 +66,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -85,10 +80,9 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'duration': (int,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
}
@@ -145,7 +139,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
duration (int): Set how long (in minutes) the external link should be active for. The link can be active for up to 7 days in the future.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str):
- Set to UPLOAD to create a link that can be used to upload files to Finix.
- Set to DOWNLOAD to create a link where the uploaded file can be downloaded from.
- Set to VIEW to create a link that displays the file in browser.. [optional] # noqa: E501
"""
@@ -229,7 +223,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
duration (int): Set how long (in minutes) the external link should be active for. The link can be active for up to 7 days in the future.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str):
- Set to UPLOAD to create a link that can be used to upload files to Finix.
- Set to DOWNLOAD to create a link where the uploaded file can be downloaded from.
- Set to VIEW to create a link that displays the file in browser.. [optional] # noqa: E501
"""
diff --git a/finix/model/create_fee_profile_request.py b/finix/model/create_fee_profile_request.py
index 93d8f84..1caaa67 100644
--- a/finix/model/create_fee_profile_request.py
+++ b/finix/model/create_fee_profile_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateFeeProfileRequest(ModelNormal):
"""
@@ -69,7 +65,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -84,7 +79,6 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'application': (str,), # noqa: E501
'ach_basis_points': (int,), # noqa: E501
@@ -100,6 +94,8 @@ def openapi_types():
'ancillary_fixed_fee_primary': (int, none_type,), # noqa: E501
'ancillary_fixed_fee_secondary': (int, none_type,), # noqa: E501
'basis_points': (int,), # noqa: E501
+ 'card_cross_border_basis_points': (int, none_type,), # noqa: E501
+ 'card_cross_border_fixed_fee': (int, none_type,), # noqa: E501
'charge_interchange': (bool,), # noqa: E501
'diners_club_basis_points': (int, none_type,), # noqa: E501
'diners_club_charge_interchange': (bool, none_type,), # noqa: E501
@@ -128,7 +124,6 @@ def openapi_types():
'mastercard_fixed_fee': (int, none_type,), # noqa: E501
'qualified_tiers': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'rounding_mode': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
'visa_acquirer_processing_fixed_fee': (int, none_type,), # noqa: E501
'visa_assessments_basis_points': (int, none_type,), # noqa: E501
'visa_base_ii_credit_voucher_fixed_fee': (int, none_type,), # noqa: E501
@@ -160,6 +155,8 @@ def discriminator():
'ancillary_fixed_fee_primary': 'ancillary_fixed_fee_primary', # noqa: E501
'ancillary_fixed_fee_secondary': 'ancillary_fixed_fee_secondary', # noqa: E501
'basis_points': 'basis_points', # noqa: E501
+ 'card_cross_border_basis_points': 'card_cross_border_basis_points', # noqa: E501
+ 'card_cross_border_fixed_fee': 'card_cross_border_fixed_fee', # noqa: E501
'charge_interchange': 'charge_interchange', # noqa: E501
'diners_club_basis_points': 'diners_club_basis_points', # noqa: E501
'diners_club_charge_interchange': 'diners_club_charge_interchange', # noqa: E501
@@ -188,7 +185,6 @@ def discriminator():
'mastercard_fixed_fee': 'mastercard_fixed_fee', # noqa: E501
'qualified_tiers': 'qualified_tiers', # noqa: E501
'rounding_mode': 'rounding_mode', # noqa: E501
- 'tags': 'tags', # noqa: E501
'visa_acquirer_processing_fixed_fee': 'visa_acquirer_processing_fixed_fee', # noqa: E501
'visa_assessments_basis_points': 'visa_assessments_basis_points', # noqa: E501
'visa_base_ii_credit_voucher_fixed_fee': 'visa_base_II_credit_voucher_fixed_fee', # noqa: E501
@@ -211,7 +207,7 @@ def _from_openapi_data(cls, application, *args, **kwargs): # noqa: E501
"""CreateFeeProfileRequest - a model defined in OpenAPI
Args:
- application (str): The ID of the resource.
+ application (str): The ID of the `Application` associated with the `Fee Profile`.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -257,6 +253,8 @@ def _from_openapi_data(cls, application, *args, **kwargs): # noqa: E501
ancillary_fixed_fee_primary (int, none_type): An additional fixed fee that can be charged per `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_secondary (int, none_type): An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included.. [optional] # noqa: E501
basis_points (int): Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_basis_points (int, none_type): Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_fixed_fee (int, none_type): Fee in cents charged against every `Transfer` that includes non-US cards.. [optional] # noqa: E501
charge_interchange (bool): Set to **True** to incur interchange fees for card-based `Transfers`.. [optional] # noqa: E501
diners_club_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
diners_club_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Diners `Transfers`.. [optional] # noqa: E501
@@ -285,7 +283,6 @@ def _from_openapi_data(cls, application, *args, **kwargs): # noqa: E501
mastercard_fixed_fee (int, none_type): Fee in cents incurred for each individual MasterCard `Transfer`.. [optional] # noqa: E501
qualified_tiers ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): The top of the qualified tier tree.. [optional] # noqa: E501
rounding_mode (str):
- Include AGGREGATE if you want to round after the settlement calculation.
- By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)
. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
visa_acquirer_processing_fixed_fee (int, none_type): Applied to all U.S.-based credit card authorizations acquired in the U.S. regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations.. [optional] # noqa: E501
visa_assessments_basis_points (int, none_type): Applies to all Visa credit transactions.. [optional] # noqa: E501
visa_base_ii_credit_voucher_fixed_fee (int, none_type): Applies to all U.S.-based refunds.. [optional] # noqa: E501
@@ -347,7 +344,7 @@ def __init__(self, application, *args, **kwargs): # noqa: E501
"""CreateFeeProfileRequest - a model defined in OpenAPI
Args:
- application (str): The ID of the resource.
+ application (str): The ID of the `Application` associated with the `Fee Profile`.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -393,6 +390,8 @@ def __init__(self, application, *args, **kwargs): # noqa: E501
ancillary_fixed_fee_primary (int, none_type): An additional fixed fee that can be charged per `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_secondary (int, none_type): An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included.. [optional] # noqa: E501
basis_points (int): Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_basis_points (int, none_type): Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_fixed_fee (int, none_type): Fee in cents charged against every `Transfer` that includes non-US cards.. [optional] # noqa: E501
charge_interchange (bool): Set to **True** to incur interchange fees for card-based `Transfers`.. [optional] # noqa: E501
diners_club_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
diners_club_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Diners `Transfers`.. [optional] # noqa: E501
@@ -421,7 +420,6 @@ def __init__(self, application, *args, **kwargs): # noqa: E501
mastercard_fixed_fee (int, none_type): Fee in cents incurred for each individual MasterCard `Transfer`.. [optional] # noqa: E501
qualified_tiers ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): The top of the qualified tier tree.. [optional] # noqa: E501
rounding_mode (str): - Include AGGREGATE if you want to round after the settlement calculation.
- By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)
. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
visa_acquirer_processing_fixed_fee (int, none_type): Applied to all U.S.-based credit card authorizations acquired in the U.S. regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations.. [optional] # noqa: E501
visa_assessments_basis_points (int, none_type): Applies to all Visa credit transactions.. [optional] # noqa: E501
visa_base_ii_credit_voucher_fixed_fee (int, none_type): Applies to all U.S.-based refunds.. [optional] # noqa: E501
diff --git a/finix/model/create_fee_request.py b/finix/model/create_fee_request.py
index 591b032..ccb55dd 100644
--- a/finix/model/create_fee_request.py
+++ b/finix/model/create_fee_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.currency import Currency
- from finix.model.tags import Tags
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class CreateFeeRequest(ModelNormal):
@@ -100,12 +98,12 @@ def openapi_types():
'currency': (Currency,), # noqa: E501
'fee_subtype': (str,), # noqa: E501
'fee_type': (str,), # noqa: E501
- 'merchant_id': (str, none_type,), # noqa: E501
+ 'merchant_id': (str,), # noqa: E501
'label': (str,), # noqa: E501
'linked_id': (str,), # noqa: E501
'linked_type': (str,), # noqa: E501
'settlement_delay_days': (int, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -139,7 +137,7 @@ def _from_openapi_data(cls, amount, currency, merchant_id, *args, **kwargs): #
Args:
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency (Currency):
- merchant_id (str, none_type): The ID of the resource.
+ merchant_id (str): The ID of the `Merchant` resource used to create the `Fee`.
Keyword Args:
fee_subtype (str): Subtype of the fee. Set to **CUSTOM**.. defaults to "CUSTOM", must be one of ["CUSTOM", ] # noqa: E501
@@ -177,8 +175,8 @@ def _from_openapi_data(cls, amount, currency, merchant_id, *args, **kwargs): #
label (str): The display name of the `Fee` that can be used for filtering purposes.. [optional] # noqa: E501
linked_id (str): ID of the linked resource. [optional] # noqa: E501
linked_type (str): The type of entity the fee is linked to (**null** by default).. [optional] # noqa: E501
- settlement_delay_days (int, none_type): Delays in days, when the fee will be submitted for settlement.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_delay_days (int, none_type): Delays in days, when the `Transfer` the `Fee` creates will be submitted for settlement.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
fee_subtype = kwargs.get('fee_subtype', "CUSTOM")
@@ -239,7 +237,7 @@ def __init__(self, amount, currency, merchant_id, *args, **kwargs): # noqa: E50
Args:
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency (Currency):
- merchant_id (str, none_type): The ID of the resource.
+ merchant_id (str): The ID of the `Merchant` resource used to create the `Fee`.
Keyword Args:
fee_subtype (str): Subtype of the fee. Set to **CUSTOM**.. defaults to "CUSTOM", must be one of ["CUSTOM", ] # noqa: E501
@@ -277,8 +275,8 @@ def __init__(self, amount, currency, merchant_id, *args, **kwargs): # noqa: E50
label (str): The display name of the `Fee` that can be used for filtering purposes.. [optional] # noqa: E501
linked_id (str): ID of the linked resource. [optional] # noqa: E501
linked_type (str): The type of entity the fee is linked to (**null** by default).. [optional] # noqa: E501
- settlement_delay_days (int, none_type): Delays in days, when the fee will be submitted for settlement.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_delay_days (int, none_type): Delays in days, when the `Transfer` the `Fee` creates will be submitted for settlement.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
fee_subtype = kwargs.get('fee_subtype', "CUSTOM")
diff --git a/finix/model/create_file_request.py b/finix/model/create_file_request.py
index 012cec6..c525697 100644
--- a/finix/model/create_file_request.py
+++ b/finix/model/create_file_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateFileRequest(ModelNormal):
"""
@@ -78,7 +74,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -93,11 +88,10 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'display_name': (str,), # noqa: E501
'linked_to': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
}
@@ -156,7 +150,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
display_name (str): The name of the `File` you'll create.. [optional] # noqa: E501
linked_to (str): The resource ID that you want linked to the `File` (e.g. Merchant ID).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): The type of document. | Available values include:
Identity Verification- **DRIVERS\\_LICENSE\\_FRONT**
- **DRIVERS\\_LICENSE\\_BACK**
- **IDENTIFICATION\\_CARD\\_FRONT**
- **IDENTIFICATION\\_CARD\\_BACK**
Bank account validationBusiness Verification- **TAX\\_DOCUMENT**
- **BUSINESS\\_REGISTRATION**
- **BUSINESS\\_ADDRESS\\_VERIFICATION**
Additional- **OTHER**
- **PCI\\_DOCUMENT**
- **PASSPORT**
. [optional] # noqa: E501
"""
@@ -241,7 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
display_name (str): The name of the `File` you'll create.. [optional] # noqa: E501
linked_to (str): The resource ID that you want linked to the `File` (e.g. Merchant ID).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): The type of document. | Available values include:
Identity Verification- **DRIVERS\\_LICENSE\\_FRONT**
- **DRIVERS\\_LICENSE\\_BACK**
- **IDENTIFICATION\\_CARD\\_FRONT**
- **IDENTIFICATION\\_CARD\\_BACK**
Bank account validationBusiness Verification- **TAX\\_DOCUMENT**
- **BUSINESS\\_REGISTRATION**
- **BUSINESS\\_ADDRESS\\_VERIFICATION**
Additional- **OTHER**
- **PCI\\_DOCUMENT**
- **PASSPORT**
. [optional] # noqa: E501
"""
diff --git a/finix/model/create_identity_request.py b/finix/model/create_identity_request.py
index 1626b36..ac4da67 100644
--- a/finix/model/create_identity_request.py
+++ b/finix/model/create_identity_request.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.create_identity_request_additional_underwriting_data import CreateIdentityRequestAdditionalUnderwritingData
from finix.model.create_identity_request_entity import CreateIdentityRequestEntity
- from finix.model.tags import Tags
globals()['CreateIdentityRequestAdditionalUnderwritingData'] = CreateIdentityRequestAdditionalUnderwritingData
globals()['CreateIdentityRequestEntity'] = CreateIdentityRequestEntity
- globals()['Tags'] = Tags
class CreateIdentityRequest(ModelNormal):
@@ -88,7 +86,7 @@ def openapi_types():
return {
'additional_underwriting_data': (CreateIdentityRequestAdditionalUnderwritingData,), # noqa: E501
'entity': (CreateIdentityRequestEntity,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -145,7 +143,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_underwriting_data (CreateIdentityRequestAdditionalUnderwritingData): [optional] # noqa: E501
entity (CreateIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,7 +227,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_underwriting_data (CreateIdentityRequestAdditionalUnderwritingData): [optional] # noqa: E501
entity (CreateIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_identity_request_additional_underwriting_data.py b/finix/model/create_identity_request_additional_underwriting_data.py
index a3c1862..ed3c7d1 100644
--- a/finix/model/create_identity_request_additional_underwriting_data.py
+++ b/finix/model/create_identity_request_additional_underwriting_data.py
@@ -60,6 +60,7 @@ class CreateIdentityRequestAdditionalUnderwritingData(ModelNormal):
'NO_REFUNDS': "NO_REFUNDS",
'MERCHANDISE_EXCHANGE_ONLY': "MERCHANDISE_EXCHANGE_ONLY",
'30_DAYS': "30_DAYS",
+ 'OTHER': "OTHER",
},
}
@@ -111,11 +112,11 @@ def openapi_types():
'average_ach_transfer_amount': (int,), # noqa: E501
'average_card_transfer_amount': (int,), # noqa: E501
'business_description': (str,), # noqa: E501
+ 'card_volume_distribution': (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution,), # noqa: E501
'credit_check_allowed': (bool,), # noqa: E501
'credit_check_ip_address': (str,), # noqa: E501
'credit_check_timestamp': (str,), # noqa: E501
'credit_check_user_agent': (str,), # noqa: E501
- 'card_volume_distribution': (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution,), # noqa: E501
'merchant_agreement_accepted': (bool,), # noqa: E501
'merchant_agreement_ip_address': (str,), # noqa: E501
'merchant_agreement_timestamp': (str,), # noqa: E501
@@ -134,11 +135,11 @@ def discriminator():
'average_ach_transfer_amount': 'average_ach_transfer_amount', # noqa: E501
'average_card_transfer_amount': 'average_card_transfer_amount', # noqa: E501
'business_description': 'business_description', # noqa: E501
+ 'card_volume_distribution': 'card_volume_distribution', # noqa: E501
'credit_check_allowed': 'credit_check_allowed', # noqa: E501
'credit_check_ip_address': 'credit_check_ip_address', # noqa: E501
'credit_check_timestamp': 'credit_check_timestamp', # noqa: E501
'credit_check_user_agent': 'credit_check_user_agent', # noqa: E501
- 'card_volume_distribution': 'card_volume_distribution', # noqa: E501
'merchant_agreement_accepted': 'merchant_agreement_accepted', # noqa: E501
'merchant_agreement_ip_address': 'merchant_agreement_ip_address', # noqa: E501
'merchant_agreement_timestamp': 'merchant_agreement_timestamp', # noqa: E501
@@ -192,11 +193,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
+ card_volume_distribution (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
credit_check_ip_address (str): The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.113 ).. [optional] # noqa: E501
credit_check_timestamp (str): A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
credit_check_user_agent (str): The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
- card_volume_distribution (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
merchant_agreement_accepted (bool): Sets whether this merchant has accepted the terms and conditions of the merchant agreement.. [optional] # noqa: E501
merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
merchant_agreement_timestamp (str): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
@@ -288,11 +289,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
+ card_volume_distribution (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
credit_check_ip_address (str): The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.113 ).. [optional] # noqa: E501
credit_check_timestamp (str): A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
credit_check_user_agent (str): The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
- card_volume_distribution (CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
merchant_agreement_accepted (bool): Sets whether this merchant has accepted the terms and conditions of the merchant agreement.. [optional] # noqa: E501
merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
merchant_agreement_timestamp (str): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
diff --git a/finix/model/create_identity_request_entity.py b/finix/model/create_identity_request_entity.py
index 2899149..1e6fb98 100644
--- a/finix/model/create_identity_request_entity.py
+++ b/finix/model/create_identity_request_entity.py
@@ -28,7 +28,13 @@
def lazy_import():
+ from finix.model.create_identity_request_entity_business_address import CreateIdentityRequestEntityBusinessAddress
+ from finix.model.create_identity_request_entity_dob import CreateIdentityRequestEntityDob
+ from finix.model.create_identity_request_entity_incorporation_date import CreateIdentityRequestEntityIncorporationDate
from finix.model.create_identity_request_entity_personal_address import CreateIdentityRequestEntityPersonalAddress
+ globals()['CreateIdentityRequestEntityBusinessAddress'] = CreateIdentityRequestEntityBusinessAddress
+ globals()['CreateIdentityRequestEntityDob'] = CreateIdentityRequestEntityDob
+ globals()['CreateIdentityRequestEntityIncorporationDate'] = CreateIdentityRequestEntityIncorporationDate
globals()['CreateIdentityRequestEntityPersonalAddress'] = CreateIdentityRequestEntityPersonalAddress
@@ -54,6 +60,21 @@ class CreateIdentityRequestEntity(ModelNormal):
"""
allowed_values = {
+ ('business_type',): {
+ 'INDIVIDUAL_SOLE_PROPRIETORSHIP': "INDIVIDUAL_SOLE_PROPRIETORSHIP",
+ 'CORPORATION': "CORPORATION",
+ 'LIMITED_LIABILITY_COMPANY': "LIMITED_LIABILITY_COMPANY",
+ 'PARTNERSHIP': "PARTNERSHIP",
+ 'ASSOCIATION_ESTATE_TRUST': "ASSOCIATION_ESTATE_TRUST",
+ 'TAX_EXEMPT_ORGANIZATION': "TAX_EXEMPT_ORGANIZATION",
+ 'INTERNATIONAL_ORGANIZATION': "INTERNATIONAL_ORGANIZATION",
+ 'GOVERNMENT_AGENCY': "GOVERNMENT_AGENCY",
+ },
+ ('ownership_type',): {
+ 'None': None,
+ 'PUBLIC': "PUBLIC",
+ 'PRIVATE': "PRIVATE",
+ },
}
validations = {
@@ -82,11 +103,30 @@ def openapi_types():
"""
lazy_import()
return {
+ 'annual_card_volume': (int,), # noqa: E501
+ 'business_address': (CreateIdentityRequestEntityBusinessAddress,), # noqa: E501
+ 'business_name': (str, none_type,), # noqa: E501
+ 'business_phone': (str,), # noqa: E501
+ 'business_tax_id': (str,), # noqa: E501
+ 'business_type': (str,), # noqa: E501
+ 'default_statement_descriptor': (str,), # noqa: E501
+ 'dob': (CreateIdentityRequestEntityDob,), # noqa: E501
+ 'doing_business_as': (str,), # noqa: E501
'email': (str,), # noqa: E501
'first_name': (str,), # noqa: E501
+ 'has_accepted_credit_cards_previously': (bool,), # noqa: E501
+ 'incorporation_date': (CreateIdentityRequestEntityIncorporationDate,), # noqa: E501
'last_name': (str,), # noqa: E501
+ 'max_transaction_amount': (int,), # noqa: E501
+ 'ach_max_transaction_amount': (int,), # noqa: E501
+ 'mcc': (str,), # noqa: E501
+ 'ownership_type': (str, none_type,), # noqa: E501
'personal_address': (CreateIdentityRequestEntityPersonalAddress,), # noqa: E501
'phone': (str,), # noqa: E501
+ 'principal_percentage_ownership': (int,), # noqa: E501
+ 'tax_id': (str,), # noqa: E501
+ 'title': (str,), # noqa: E501
+ 'url': (str,), # noqa: E501
}
@cached_property
@@ -95,11 +135,30 @@ def discriminator():
attribute_map = {
+ 'annual_card_volume': 'annual_card_volume', # noqa: E501
+ 'business_address': 'business_address', # noqa: E501
+ 'business_name': 'business_name', # noqa: E501
+ 'business_phone': 'business_phone', # noqa: E501
+ 'business_tax_id': 'business_tax_id', # noqa: E501
+ 'business_type': 'business_type', # noqa: E501
+ 'default_statement_descriptor': 'default_statement_descriptor', # noqa: E501
+ 'dob': 'dob', # noqa: E501
+ 'doing_business_as': 'doing_business_as', # noqa: E501
'email': 'email', # noqa: E501
'first_name': 'first_name', # noqa: E501
+ 'has_accepted_credit_cards_previously': 'has_accepted_credit_cards_previously', # noqa: E501
+ 'incorporation_date': 'incorporation_date', # noqa: E501
'last_name': 'last_name', # noqa: E501
+ 'max_transaction_amount': 'max_transaction_amount', # noqa: E501
+ 'ach_max_transaction_amount': 'ach_max_transaction_amount', # noqa: E501
+ 'mcc': 'mcc', # noqa: E501
+ 'ownership_type': 'ownership_type', # noqa: E501
'personal_address': 'personal_address', # noqa: E501
'phone': 'phone', # noqa: E501
+ 'principal_percentage_ownership': 'principal_percentage_ownership', # noqa: E501
+ 'tax_id': 'tax_id', # noqa: E501
+ 'title': 'title', # noqa: E501
+ 'url': 'url', # noqa: E501
}
read_only_vars = {
@@ -109,9 +168,35 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, annual_card_volume, business_address, business_name, business_phone, business_tax_id, business_type, default_statement_descriptor, dob, doing_business_as, email, first_name, has_accepted_credit_cards_previously, incorporation_date, last_name, max_transaction_amount, ach_max_transaction_amount, mcc, ownership_type, personal_address, phone, principal_percentage_ownership, tax_id, title, url, *args, **kwargs): # noqa: E501
"""CreateIdentityRequestEntity - a model defined in OpenAPI
+ Args:
+ annual_card_volume (int): The annual credit card sales (in cents) expected to be processed (max 19 characters).
+ business_address (CreateIdentityRequestEntityBusinessAddress):
+ business_name (str, none_type): The merchant's legal business name (max 120 characters).- If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner's legal first name, last name and middle initial.
- Special characters (e.g.,
.,_-?+* or /.) are not allowed.
+ business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).
+ business_type (str): The business entity type of the Merchant.
+ default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.
+ dob (CreateIdentityRequestEntityDob):
+ doing_business_as (str): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).
+ email (str): The email address of the buyer where they can be reached (max 100 characters).
+ first_name (str): The legal first name of the buyer (max 20 characters).
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.
+ incorporation_date (CreateIdentityRequestEntityIncorporationDate):
+ last_name (str): The legal last name of the buyer (max 20 characters).
+ max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
+ ach_max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single ACH transaction (max 12 characters).
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ ownership_type (str, none_type): Avalible values include: - PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses. For `business_type` of **GOVERNMENT_AGENCY** and **TAX_EXEMPT_ORGANIZATION** the `ownership_type` should be set to **PUBLIC**. For `business_type` **INDIVIDUAL_SOLE_PROPRIETORSHIP**, the `ownership_type` should be set to **PRIVATE**.
+ personal_address (CreateIdentityRequestEntityPersonalAddress):
+ phone (str): Phone number where the buyer can be reached.
+ principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).
+ tax_id (str): Pass one of the following values (nine digits):
- Social Security Number (SSN)
- Tax Identification Number (TIN)
- Individual Taxpayer Identification Number (ITIN)
+ title (str): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).
+ url (str): The URL of the merchant's public website.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -143,11 +228,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- email (str): The email address of the buyer where they can be reached (max 100 characters).. [optional] # noqa: E501
- first_name (str): The legal first name of the buyer (max 20 characters).. [optional] # noqa: E501
- last_name (str): The legal last name of the buyer (max 20 characters).. [optional] # noqa: E501
- personal_address (CreateIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
- phone (str): Phone number where the buyer can be reached.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -175,6 +255,30 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.annual_card_volume = annual_card_volume
+ self.business_address = business_address
+ self.business_name = business_name
+ self.business_phone = business_phone
+ self.business_tax_id = business_tax_id
+ self.business_type = business_type
+ self.default_statement_descriptor = default_statement_descriptor
+ self.dob = dob
+ self.doing_business_as = doing_business_as
+ self.email = email
+ self.first_name = first_name
+ self.has_accepted_credit_cards_previously = has_accepted_credit_cards_previously
+ self.incorporation_date = incorporation_date
+ self.last_name = last_name
+ self.max_transaction_amount = max_transaction_amount
+ self.ach_max_transaction_amount = ach_max_transaction_amount
+ self.mcc = mcc
+ self.ownership_type = ownership_type
+ self.personal_address = personal_address
+ self.phone = phone
+ self.principal_percentage_ownership = principal_percentage_ownership
+ self.tax_id = tax_id
+ self.title = title
+ self.url = url
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -195,9 +299,35 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, *args, **kwargs): # noqa: E501
+ def __init__(self, annual_card_volume, business_address, business_name, business_phone, business_tax_id, business_type, default_statement_descriptor, dob, doing_business_as, email, first_name, has_accepted_credit_cards_previously, incorporation_date, last_name, max_transaction_amount, ach_max_transaction_amount, mcc, ownership_type, personal_address, phone, principal_percentage_ownership, tax_id, title, url, *args, **kwargs): # noqa: E501
"""CreateIdentityRequestEntity - a model defined in OpenAPI
+ Args:
+ annual_card_volume (int): The annual credit card sales (in cents) expected to be processed (max 19 characters).
+ business_address (CreateIdentityRequestEntityBusinessAddress):
+ business_name (str, none_type): The merchant's legal business name (max 120 characters).- If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner's legal first name, last name and middle initial.
- Special characters (e.g.,
.,_-?+* or /.) are not allowed.
+ business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).
+ business_type (str): The business entity type of the Merchant.
+ default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.
+ dob (CreateIdentityRequestEntityDob):
+ doing_business_as (str): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).
+ email (str): The email address of the buyer where they can be reached (max 100 characters).
+ first_name (str): The legal first name of the buyer (max 20 characters).
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.
+ incorporation_date (CreateIdentityRequestEntityIncorporationDate):
+ last_name (str): The legal last name of the buyer (max 20 characters).
+ max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
+ ach_max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single ACH transaction (max 12 characters).
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ ownership_type (str, none_type): Avalible values include: - PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses. For `business_type` of **GOVERNMENT_AGENCY** and **TAX_EXEMPT_ORGANIZATION** the `ownership_type` should be set to **PUBLIC**. For `business_type` **INDIVIDUAL_SOLE_PROPRIETORSHIP**, the `ownership_type` should be set to **PRIVATE**.
+ personal_address (CreateIdentityRequestEntityPersonalAddress):
+ phone (str): Phone number where the buyer can be reached.
+ principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).
+ tax_id (str): Pass one of the following values (nine digits):
- Social Security Number (SSN)
- Tax Identification Number (TIN)
- Individual Taxpayer Identification Number (ITIN)
+ title (str): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).
+ url (str): The URL of the merchant's public website.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -229,11 +359,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- email (str): The email address of the buyer where they can be reached (max 100 characters).. [optional] # noqa: E501
- first_name (str): The legal first name of the buyer (max 20 characters).. [optional] # noqa: E501
- last_name (str): The legal last name of the buyer (max 20 characters).. [optional] # noqa: E501
- personal_address (CreateIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
- phone (str): Phone number where the buyer can be reached.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -259,6 +384,30 @@ def __init__(self, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.annual_card_volume = annual_card_volume
+ self.business_address = business_address
+ self.business_name = business_name
+ self.business_phone = business_phone
+ self.business_tax_id = business_tax_id
+ self.business_type = business_type
+ self.default_statement_descriptor = default_statement_descriptor
+ self.dob = dob
+ self.doing_business_as = doing_business_as
+ self.email = email
+ self.first_name = first_name
+ self.has_accepted_credit_cards_previously = has_accepted_credit_cards_previously
+ self.incorporation_date = incorporation_date
+ self.last_name = last_name
+ self.max_transaction_amount = max_transaction_amount
+ self.ach_max_transaction_amount = ach_max_transaction_amount
+ self.mcc = mcc
+ self.ownership_type = ownership_type
+ self.personal_address = personal_address
+ self.phone = phone
+ self.principal_percentage_ownership = principal_percentage_ownership
+ self.tax_id = tax_id
+ self.title = title
+ self.url = url
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_identity_request_entity_business_address.py b/finix/model/create_identity_request_entity_business_address.py
new file mode 100644
index 0000000..8ae5a25
--- /dev/null
+++ b/finix/model/create_identity_request_entity_business_address.py
@@ -0,0 +1,302 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateIdentityRequestEntityBusinessAddress(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('city',): {
+ 'min_length': 1,
+ },
+ ('country',): {
+ 'min_length': 1,
+ },
+ ('region',): {
+ 'min_length': 1,
+ },
+ ('line1',): {
+ 'min_length': 1,
+ },
+ ('postal_code',): {
+ 'min_length': 1,
+ },
+ ('line2',): {
+ 'min_length': 1,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'city': (str,), # noqa: E501
+ 'country': (str,), # noqa: E501
+ 'region': (str,), # noqa: E501
+ 'line1': (str,), # noqa: E501
+ 'postal_code': (str,), # noqa: E501
+ 'line2': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'city': 'city', # noqa: E501
+ 'country': 'country', # noqa: E501
+ 'region': 'region', # noqa: E501
+ 'line1': 'line1', # noqa: E501
+ 'postal_code': 'postal_code', # noqa: E501
+ 'line2': 'line2', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, city, country, region, line1, postal_code, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityBusinessAddress - a model defined in OpenAPI
+
+ Args:
+ city (str): City (max 20 characters).
+ country (str): 3-Letter Country code (e.g. USA).
+ region (str): 2-letter state code.
+ line1 (str): First line of the address (max 35 characters).
+ postal_code (str): Zip or Postal code (max 7 characters).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.city = city
+ self.country = country
+ self.region = region
+ self.line1 = line1
+ self.postal_code = postal_code
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, city, country, region, line1, postal_code, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityBusinessAddress - a model defined in OpenAPI
+
+ Args:
+ city (str): City (max 20 characters).
+ country (str): 3-Letter Country code (e.g. USA).
+ region (str): 2-letter state code.
+ line1 (str): First line of the address (max 35 characters).
+ postal_code (str): Zip or Postal code (max 7 characters).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.city = city
+ self.country = country
+ self.region = region
+ self.line1 = line1
+ self.postal_code = postal_code
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_identity_request_entity_dob.py b/finix/model/create_identity_request_entity_dob.py
new file mode 100644
index 0000000..ca39604
--- /dev/null
+++ b/finix/model/create_identity_request_entity_dob.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateIdentityRequestEntityDob(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day': (int,), # noqa: E501
+ 'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day': 'day', # noqa: E501
+ 'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, day, month, year, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityDob - a model defined in OpenAPI
+
+ Args:
+ day (int): Day of birth (between 1 and 31).
+ month (int): Month of birth (between 1 and 12).
+ year (int): Year of birth (4-digit). Year must be greater than 1900
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.day = day
+ self.month = month
+ self.year = year
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, day, month, year, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityDob - a model defined in OpenAPI
+
+ Args:
+ day (int): Day of birth (between 1 and 31).
+ month (int): Month of birth (between 1 and 12).
+ year (int): Year of birth (4-digit). Year must be greater than 1900
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.day = day
+ self.month = month
+ self.year = year
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_identity_request_entity_incorporation_date.py b/finix/model/create_identity_request_entity_incorporation_date.py
new file mode 100644
index 0000000..742f2e7
--- /dev/null
+++ b/finix/model/create_identity_request_entity_incorporation_date.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateIdentityRequestEntityIncorporationDate(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day': (int,), # noqa: E501
+ 'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day': 'day', # noqa: E501
+ 'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, day, month, year, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityIncorporationDate - a model defined in OpenAPI
+
+ Args:
+ day (int): Day business was incorporated (between 1 and 31).
+ month (int): Month business was incorporated (between 1 and 12).
+ year (int): Year business was incorporated (4-digit).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.day = day
+ self.month = month
+ self.year = year
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, day, month, year, *args, **kwargs): # noqa: E501
+ """CreateIdentityRequestEntityIncorporationDate - a model defined in OpenAPI
+
+ Args:
+ day (int): Day business was incorporated (between 1 and 31).
+ month (int): Month business was incorporated (between 1 and 12).
+ year (int): Year business was incorporated (4-digit).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.day = day
+ self.month = month
+ self.year = year
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_identity_request_entity_personal_address.py b/finix/model/create_identity_request_entity_personal_address.py
index 94edecf..64330a5 100644
--- a/finix/model/create_identity_request_entity_personal_address.py
+++ b/finix/model/create_identity_request_entity_personal_address.py
@@ -79,9 +79,9 @@ def openapi_types():
'city': (str,), # noqa: E501
'country': (str,), # noqa: E501
'line1': (str,), # noqa: E501
- 'line2': (str,), # noqa: E501
'postal_code': (str,), # noqa: E501
'region': (str,), # noqa: E501
+ 'line2': (str,), # noqa: E501
}
@cached_property
@@ -93,9 +93,9 @@ def discriminator():
'city': 'city', # noqa: E501
'country': 'country', # noqa: E501
'line1': 'line1', # noqa: E501
- 'line2': 'line2', # noqa: E501
'postal_code': 'postal_code', # noqa: E501
'region': 'region', # noqa: E501
+ 'line2': 'line2', # noqa: E501
}
read_only_vars = {
@@ -105,9 +105,16 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, city, country, line1, postal_code, region, *args, **kwargs): # noqa: E501
"""CreateIdentityRequestEntityPersonalAddress - a model defined in OpenAPI
+ Args:
+ city (str): City (max 20 characters).
+ country (str): 3-Letter country code (e.g. USA).
+ line1 (str): First line of the address (max 35 characters).
+ postal_code (str): Zip or Postal code (max 7 characters).
+ region (str): 2-letter State code.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -139,12 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- city (str): City (max 20 characters).. [optional] # noqa: E501
- country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
- postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
- region (str): 2-letter State code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -172,6 +174,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.city = city
+ self.country = country
+ self.line1 = line1
+ self.postal_code = postal_code
+ self.region = region
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -192,9 +199,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, *args, **kwargs): # noqa: E501
+ def __init__(self, city, country, line1, postal_code, region, *args, **kwargs): # noqa: E501
"""CreateIdentityRequestEntityPersonalAddress - a model defined in OpenAPI
+ Args:
+ city (str): City (max 20 characters).
+ country (str): 3-Letter country code (e.g. USA).
+ line1 (str): First line of the address (max 35 characters).
+ postal_code (str): Zip or Postal code (max 7 characters).
+ region (str): 2-letter State code.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -226,12 +240,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- city (str): City (max 20 characters).. [optional] # noqa: E501
- country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
- postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
- region (str): 2-letter State code.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -257,6 +266,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.city = city
+ self.country = country
+ self.line1 = line1
+ self.postal_code = postal_code
+ self.region = region
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_merchant_underwriting_request.py b/finix/model/create_merchant_underwriting_request.py
index 0fd2309..b490b7f 100644
--- a/finix/model/create_merchant_underwriting_request.py
+++ b/finix/model/create_merchant_underwriting_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateMerchantUnderwritingRequest(ModelNormal):
"""
@@ -57,7 +53,7 @@ class CreateMerchantUnderwritingRequest(ModelNormal):
('gateway',): {
'TRIPOS_CLOUD_V1': "TRIPOS_CLOUD_V1",
'TRIPOS_MOBILE_V1': "TRIPOS_MOBILE_V1",
- 'EXPRESS_V1': "EXPRESS_V1",
+ 'DATACAP_V1': "DATACAP_V1",
},
}
@@ -70,7 +66,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -85,11 +80,10 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'processor': (str, none_type,), # noqa: E501
'gateway': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -147,8 +141,8 @@ def _from_openapi_data(cls, processor, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- gateway (str): Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchantto accept card present transactions.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ gateway (str): Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchant to accept card present transactions.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,8 +228,8 @@ def __init__(self, processor, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- gateway (str): Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchantto accept card present transactions.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ gateway (str): Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchant to accept card present transactions.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_onboarding_form_link_request.py b/finix/model/create_onboarding_form_link_request.py
index ca8560b..2eef23f 100644
--- a/finix/model/create_onboarding_form_link_request.py
+++ b/finix/model/create_onboarding_form_link_request.py
@@ -76,11 +76,11 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'terms_of_service_url': (str,), # noqa: E501
- 'return_url': (str,), # noqa: E501
- 'fee_details_url': (str,), # noqa: E501
- 'expired_session_url': (str,), # noqa: E501
'expiration_in_minutes': (int,), # noqa: E501
+ 'expired_session_url': (str,), # noqa: E501
+ 'fee_details_url': (str,), # noqa: E501
+ 'return_url': (str,), # noqa: E501
+ 'terms_of_service_url': (str,), # noqa: E501
}
@cached_property
@@ -89,11 +89,11 @@ def discriminator():
attribute_map = {
- 'terms_of_service_url': 'terms_of_service_url', # noqa: E501
- 'return_url': 'return_url', # noqa: E501
- 'fee_details_url': 'fee_details_url', # noqa: E501
- 'expired_session_url': 'expired_session_url', # noqa: E501
'expiration_in_minutes': 'expiration_in_minutes', # noqa: E501
+ 'expired_session_url': 'expired_session_url', # noqa: E501
+ 'fee_details_url': 'fee_details_url', # noqa: E501
+ 'return_url': 'return_url', # noqa: E501
+ 'terms_of_service_url': 'terms_of_service_url', # noqa: E501
}
read_only_vars = {
@@ -137,11 +137,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service.. [optional] # noqa: E501
- return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
- fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
+ expiration_in_minutes (int): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
expired_session_url (str): The URL users get sent to if the bearer token expires.. [optional] # noqa: E501
- expiration_in_minutes (int): How long (in minutes) the link is valid for.. [optional] # noqa: E501
+ fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
+ return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,11 +223,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service.. [optional] # noqa: E501
- return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
- fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
+ expiration_in_minutes (int): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
expired_session_url (str): The URL users get sent to if the bearer token expires.. [optional] # noqa: E501
- expiration_in_minutes (int): How long (in minutes) the link is valid for.. [optional] # noqa: E501
+ fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
+ return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_onboarding_form_request.py b/finix/model/create_onboarding_form_request.py
index 3524f14..76523bd 100644
--- a/finix/model/create_onboarding_form_request.py
+++ b/finix/model/create_onboarding_form_request.py
@@ -28,12 +28,12 @@
def lazy_import():
- from finix.model.create_onboarding_form_request_merchant_processors_inner import CreateOnboardingFormRequestMerchantProcessorsInner
- from finix.model.create_onboarding_form_request_onboarding_data import CreateOnboardingFormRequestOnboardingData
+ from finix.model.create_onboarding_form_request_merchant_processors import CreateOnboardingFormRequestMerchantProcessors
from finix.model.create_onboarding_form_request_onboarding_link_details import CreateOnboardingFormRequestOnboardingLinkDetails
- globals()['CreateOnboardingFormRequestMerchantProcessorsInner'] = CreateOnboardingFormRequestMerchantProcessorsInner
- globals()['CreateOnboardingFormRequestOnboardingData'] = CreateOnboardingFormRequestOnboardingData
+ from finix.model.onboarding_form_onboarding_data import OnboardingFormOnboardingData
+ globals()['CreateOnboardingFormRequestMerchantProcessors'] = CreateOnboardingFormRequestMerchantProcessors
globals()['CreateOnboardingFormRequestOnboardingLinkDetails'] = CreateOnboardingFormRequestOnboardingLinkDetails
+ globals()['OnboardingFormOnboardingData'] = OnboardingFormOnboardingData
class CreateOnboardingFormRequest(ModelNormal):
@@ -86,9 +86,10 @@ def openapi_types():
"""
lazy_import()
return {
- 'onboarding_data': (CreateOnboardingFormRequestOnboardingData,), # noqa: E501
- 'merchant_processors': ([CreateOnboardingFormRequestMerchantProcessorsInner],), # noqa: E501
+ 'onboarding_data': (OnboardingFormOnboardingData,), # noqa: E501
+ 'merchant_processors': ([CreateOnboardingFormRequestMerchantProcessors],), # noqa: E501
'onboarding_link_details': (CreateOnboardingFormRequestOnboardingLinkDetails,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -100,6 +101,7 @@ def discriminator():
'onboarding_data': 'onboarding_data', # noqa: E501
'merchant_processors': 'merchant_processors', # noqa: E501
'onboarding_link_details': 'onboarding_link_details', # noqa: E501
+ 'tags': 'tags', # noqa: E501
}
read_only_vars = {
@@ -143,9 +145,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- onboarding_data (CreateOnboardingFormRequestOnboardingData): [optional] # noqa: E501
- merchant_processors ([CreateOnboardingFormRequestMerchantProcessorsInner]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
+ onboarding_data (OnboardingFormOnboardingData): [optional] # noqa: E501
+ merchant_processors ([CreateOnboardingFormRequestMerchantProcessors]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_link_details (CreateOnboardingFormRequestOnboardingLinkDetails): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -227,9 +230,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- onboarding_data (CreateOnboardingFormRequestOnboardingData): [optional] # noqa: E501
- merchant_processors ([CreateOnboardingFormRequestMerchantProcessorsInner]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
+ onboarding_data (OnboardingFormOnboardingData): [optional] # noqa: E501
+ merchant_processors ([CreateOnboardingFormRequestMerchantProcessors]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_link_details (CreateOnboardingFormRequestOnboardingLinkDetails): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_onboarding_form_request_merchant_processors.py b/finix/model/create_onboarding_form_request_merchant_processors.py
new file mode 100644
index 0000000..8dc9c52
--- /dev/null
+++ b/finix/model/create_onboarding_form_request_merchant_processors.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateOnboardingFormRequestMerchantProcessors(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'processor': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'processor': 'processor', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """CreateOnboardingFormRequestMerchantProcessors - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ processor (str): The name of the processor you plan to onboard users to.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """CreateOnboardingFormRequestMerchantProcessors - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ processor (str): The name of the processor you plan to onboard users to.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_onboarding_form_request_onboarding_link_details.py b/finix/model/create_onboarding_form_request_onboarding_link_details.py
index eb6d8fe..ddbb4d2 100644
--- a/finix/model/create_onboarding_form_request_onboarding_link_details.py
+++ b/finix/model/create_onboarding_form_request_onboarding_link_details.py
@@ -76,11 +76,11 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'return_url': (str,), # noqa: E501
+ 'expiration_in_minutes': (str,), # noqa: E501
'expired_session_url': (str,), # noqa: E501
- 'terms_of_service_url': (str,), # noqa: E501
'fee_details_url': (str,), # noqa: E501
- 'expiration_in_minutes': (str,), # noqa: E501
+ 'return_url': (str,), # noqa: E501
+ 'terms_of_service_url': (str,), # noqa: E501
}
@cached_property
@@ -89,11 +89,11 @@ def discriminator():
attribute_map = {
- 'return_url': 'return_url', # noqa: E501
+ 'expiration_in_minutes': 'expiration_in_minutes', # noqa: E501
'expired_session_url': 'expired_session_url', # noqa: E501
- 'terms_of_service_url': 'terms_of_service_url', # noqa: E501
'fee_details_url': 'fee_details_url', # noqa: E501
- 'expiration_in_minutes': 'expiration_in_minutes', # noqa: E501
+ 'return_url': 'return_url', # noqa: E501
+ 'terms_of_service_url': 'terms_of_service_url', # noqa: E501
}
read_only_vars = {
@@ -137,11 +137,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ expiration_in_minutes (str): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
expired_session_url (str): The URL users get sent to if the bearer token expires.. [optional] # noqa: E501
- terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).. [optional] # noqa: E501
fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
- expiration_in_minutes (str): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
+ return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,11 +223,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ expiration_in_minutes (str): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
expired_session_url (str): The URL users get sent to if the bearer token expires.. [optional] # noqa: E501
- terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).. [optional] # noqa: E501
fee_details_url (str): The URL of the page where you display the fees related to processing payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).. [optional] # noqa: E501
- expiration_in_minutes (str): How long (in minutes) the link should be valid for. Defaults to 60 minutes.. [optional] # noqa: E501
+ return_url (str): The URL users get sent to after completing the onboarding flow.. [optional] # noqa: E501
+ terms_of_service_url (str): Your Terms of Service URL. The URL is provided to users for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_payment_instrument_request.py b/finix/model/create_payment_instrument_request.py
index 8365c0b..1c05cce 100644
--- a/finix/model/create_payment_instrument_request.py
+++ b/finix/model/create_payment_instrument_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.create_payment_instrument_request_address import CreatePaymentInstrumentRequestAddress
- from finix.model.tags import Tags
globals()['CreatePaymentInstrumentRequestAddress'] = CreatePaymentInstrumentRequestAddress
- globals()['Tags'] = Tags
class CreatePaymentInstrumentRequest(ModelNormal):
@@ -57,21 +55,29 @@ class CreatePaymentInstrumentRequest(ModelNormal):
allowed_values = {
('type',): {
- 'BANK_ACCOUNT': "BANK_ACCOUNT",
- 'TOKEN': "TOKEN",
'APPLE_PAY': "APPLE_PAY",
+ 'BANK_ACCOUNT': "BANK_ACCOUNT",
'GOOGLE_PAY': "GOOGLE_PAY",
'PAYMENT_CARD': "PAYMENT_CARD",
+ 'TOKEN': "TOKEN",
},
('account_type',): {
- 'CHECKING': "CHECKING",
- 'SAVINGS': "SAVINGS",
- 'CORPORATE': "CORPORATE",
- 'CORP_SAVINGS': "CORP_SAVINGS",
+ 'BUSINESS_CHECKING': "BUSINESS_CHECKING",
+ 'BUSINESS_SAVINGS': "BUSINESS_SAVINGS",
+ 'PERSONAL_CHECKING': "PERSONAL_CHECKING",
+ 'PERSONAL_SAVINGS': "PERSONAL_SAVINGS",
},
}
validations = {
+ ('account_number',): {
+ 'max_length': 17,
+ 'min_length': 5,
+ },
+ ('bank_code',): {
+ 'max_length': 9,
+ 'min_length': 9,
+ },
}
@cached_property
@@ -100,18 +106,17 @@ def openapi_types():
'address': (CreatePaymentInstrumentRequestAddress,), # noqa: E501
'expiration_month': (int,), # noqa: E501
'expiration_year': (int,), # noqa: E501
- 'identity': (str, none_type,), # noqa: E501
+ 'identity': (str,), # noqa: E501
'name': (str,), # noqa: E501
'number': (str,), # noqa: E501
'security_code': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
'third_party_token': (str,), # noqa: E501
'account_number': (str,), # noqa: E501
'account_type': (str,), # noqa: E501
'attempt_bank_account_validation_check': (bool,), # noqa: E501
'bank_code': (str,), # noqa: E501
- 'country': (str,), # noqa: E501
'token': (str,), # noqa: E501
'merchant_identity': (str,), # noqa: E501
}
@@ -136,7 +141,6 @@ def discriminator():
'account_type': 'account_type', # noqa: E501
'attempt_bank_account_validation_check': 'attempt_bank_account_validation_check', # noqa: E501
'bank_code': 'bank_code', # noqa: E501
- 'country': 'country', # noqa: E501
'token': 'token', # noqa: E501
'merchant_identity': 'merchant_identity', # noqa: E501
}
@@ -185,18 +189,17 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
address (CreatePaymentInstrumentRequestAddress): [optional] # noqa: E501
expiration_month (int): The expiration month of the card (e.g. 12 for December).. [optional] # noqa: E501
expiration_year (int): The 4-digit expiration year of the card.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- name (str): The name of the bank account or card owner.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
+ name (str): The name of the bank account or card owner. This value can get truncated to comply with processor requirements.. [optional] # noqa: E501
number (str): The card or bank account number (no dashes in between numbers).. [optional] # noqa: E501
security_code (str): The 3-4 digit security code of the card (i.e. CVV code).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Type of `Payment Instrument`.. [optional] # noqa: E501
third_party_token (str): Stringified token provided by Google. Required to process Google Pay transactions.. [optional] # noqa: E501
account_number (str): The bank account number (no dashes in between numbers).. [optional] # noqa: E501
- account_type (str): The type of bank account.. [optional] # noqa: E501
- attempt_bank_account_validation_check (bool): Set to **true** if you want to request a bank account validation. Default value is **false**.. [optional] if omitted the server will use the default value of False # noqa: E501
+ account_type (str): The type of bank account. Use the following respective enum when creating a `Payment Instrument` for:- PERSONAL_CHECKING: A personal checking account.
- PERSONAL_SAVINGS: A personal savings account.
- BUSINESS_CHECKING: A business checking account.
- BUSINESS_SAVINGS: A business savings account.
. [optional] # noqa: E501
+ attempt_bank_account_validation_check (bool): Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/) - Set to **True** to verify the `Payment Instrument` can be used for ACH payments. - Only `Payment Instruments` created from bank accounts can be used for ACH payments.. [optional] if omitted the server will use the default value of False # noqa: E501
bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
- country (str): 3 Letter country code (e.g. USA).. [optional] # noqa: E501
token (str): ID of the `Token` that was returned from the tokenization client or hosted fields. [optional] # noqa: E501
merchant_identity (str): The `id` of the identity used when registering the business with Google Pay through our registration API.. [optional] # noqa: E501
"""
@@ -283,18 +286,17 @@ def __init__(self, *args, **kwargs): # noqa: E501
address (CreatePaymentInstrumentRequestAddress): [optional] # noqa: E501
expiration_month (int): The expiration month of the card (e.g. 12 for December).. [optional] # noqa: E501
expiration_year (int): The 4-digit expiration year of the card.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- name (str): The name of the bank account or card owner.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
+ name (str): The name of the bank account or card owner. This value can get truncated to comply with processor requirements.. [optional] # noqa: E501
number (str): The card or bank account number (no dashes in between numbers).. [optional] # noqa: E501
security_code (str): The 3-4 digit security code of the card (i.e. CVV code).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Type of `Payment Instrument`.. [optional] # noqa: E501
third_party_token (str): Stringified token provided by Google. Required to process Google Pay transactions.. [optional] # noqa: E501
account_number (str): The bank account number (no dashes in between numbers).. [optional] # noqa: E501
- account_type (str): The type of bank account.. [optional] # noqa: E501
- attempt_bank_account_validation_check (bool): Set to **true** if you want to request a bank account validation. Default value is **false**.. [optional] if omitted the server will use the default value of False # noqa: E501
+ account_type (str): The type of bank account. Use the following respective enum when creating a `Payment Instrument` for:- PERSONAL_CHECKING: A personal checking account.
- PERSONAL_SAVINGS: A personal savings account.
- BUSINESS_CHECKING: A business checking account.
- BUSINESS_SAVINGS: A business savings account.
. [optional] # noqa: E501
+ attempt_bank_account_validation_check (bool): Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/) - Set to **True** to verify the `Payment Instrument` can be used for ACH payments. - Only `Payment Instruments` created from bank accounts can be used for ACH payments.. [optional] if omitted the server will use the default value of False # noqa: E501
bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
- country (str): 3 Letter country code (e.g. USA).. [optional] # noqa: E501
token (str): ID of the `Token` that was returned from the tokenization client or hosted fields. [optional] # noqa: E501
merchant_identity (str): The `id` of the identity used when registering the business with Google Pay through our registration API.. [optional] # noqa: E501
"""
diff --git a/finix/model/create_processor_request.py b/finix/model/create_processor_request.py
index c044791..95a869d 100644
--- a/finix/model/create_processor_request.py
+++ b/finix/model/create_processor_request.py
@@ -27,12 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.create_processor_request_config import CreateProcessorRequestConfig
- from finix.model.tags import Tags
- globals()['CreateProcessorRequestConfig'] = CreateProcessorRequestConfig
- globals()['Tags'] = Tags
-
class CreateProcessorRequest(ModelNormal):
"""
@@ -70,7 +64,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -85,11 +78,9 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'type': (str,), # noqa: E501
- 'config': (CreateProcessorRequestConfig,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -99,7 +90,6 @@ def discriminator():
attribute_map = {
'type': 'type', # noqa: E501
- 'config': 'config', # noqa: E501
'tags': 'tags', # noqa: E501
}
@@ -147,8 +137,7 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- config (CreateProcessorRequestConfig): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,8 +223,7 @@ def __init__(self, type, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- config (CreateProcessorRequestConfig): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_reversal_request.py b/finix/model/create_reversal_request.py
index 73a1688..84e996f 100644
--- a/finix/model/create_reversal_request.py
+++ b/finix/model/create_reversal_request.py
@@ -28,10 +28,10 @@
def lazy_import():
+ from finix.model.create_reversal_request_split_transfers import CreateReversalRequestSplitTransfers
from finix.model.currency import Currency
- from finix.model.tags import Tags
+ globals()['CreateReversalRequestSplitTransfers'] = CreateReversalRequestSplitTransfers
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class CreateReversalRequest(ModelNormal):
@@ -84,12 +84,14 @@ def openapi_types():
"""
lazy_import()
return {
+ 'idempotency_id': (str, none_type,), # noqa: E501
'refund_amount': (int,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'device': (str,), # noqa: E501
'amount': (int,), # noqa: E501
'currency': (Currency,), # noqa: E501
'operation_key': (str, none_type,), # noqa: E501
+ 'split_transfers': (CreateReversalRequestSplitTransfers,), # noqa: E501
}
@cached_property
@@ -98,12 +100,14 @@ def discriminator():
attribute_map = {
+ 'idempotency_id': 'idempotency_id', # noqa: E501
'refund_amount': 'refund_amount', # noqa: E501
'tags': 'tags', # noqa: E501
'device': 'device', # noqa: E501
'amount': 'amount', # noqa: E501
'currency': 'currency', # noqa: E501
'operation_key': 'operation_key', # noqa: E501
+ 'split_transfers': 'split_transfers', # noqa: E501
}
read_only_vars = {
@@ -147,12 +151,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ idempotency_id (str, none_type): Pass any randomly generated or internal ID to [idempotently](/api/overview/#section/Idempotency-Requests) identify `Transfers`, `Authorizations`, and refund requests.. [optional] # noqa: E501
refund_amount (int): The amount of the refund in cents. It must be equal to or less than the amount of the original `Transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
device (str): The ID of the `Device` used to process the transaction.. [optional] # noqa: E501
amount (int): The amount of the sale.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
operation_key (str, none_type): Describes the operation to be performed in the transaction. Use **CARD_PRESENT_UNREFERENCED_REFUND** for refunds where the card isn't avalible.. [optional] # noqa: E501
+ split_transfers (CreateReversalRequestSplitTransfers): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,12 +240,14 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ idempotency_id (str, none_type): Pass any randomly generated or internal ID to [idempotently](/api/overview/#section/Idempotency-Requests) identify `Transfers`, `Authorizations`, and refund requests.. [optional] # noqa: E501
refund_amount (int): The amount of the refund in cents. It must be equal to or less than the amount of the original `Transfer`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
device (str): The ID of the `Device` used to process the transaction.. [optional] # noqa: E501
amount (int): The amount of the sale.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
operation_key (str, none_type): Describes the operation to be performed in the transaction. Use **CARD_PRESENT_UNREFERENCED_REFUND** for refunds where the card isn't avalible.. [optional] # noqa: E501
+ split_transfers (CreateReversalRequestSplitTransfers): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_reversal_request_split_transfers.py b/finix/model/create_reversal_request_split_transfers.py
new file mode 100644
index 0000000..603a10e
--- /dev/null
+++ b/finix/model/create_reversal_request_split_transfers.py
@@ -0,0 +1,254 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateReversalRequestSplitTransfers(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'amount': (int,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'amount': 'amount', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """CreateReversalRequestSplitTransfers - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount (int): - The amount of funds that get split and paid out to the specified `Merchant`. - Must be less than or equal to the `amount` of the `Transfer.`. [optional] # noqa: E501
+ merchant (str): - The ID of the `Merchant` that will receive the specified `amount` under the `split_transfers` object. - In Split Transactions, the `Merchants` specified in the `split_transfers` object are the ancillary `Merchants.`. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """CreateReversalRequestSplitTransfers - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount (int): - The amount of funds that get split and paid out to the specified `Merchant`. - Must be less than or equal to the `amount` of the `Transfer.`. [optional] # noqa: E501
+ merchant (str): - The ID of the `Merchant` that will receive the specified `amount` under the `split_transfers` object. - In Split Transactions, the `Merchants` specified in the `split_transfers` object are the ancillary `Merchants.`. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_settlement_request.py b/finix/model/create_settlement_request.py
index 3a8753f..889dcf7 100644
--- a/finix/model/create_settlement_request.py
+++ b/finix/model/create_settlement_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.currency import Currency
- from finix.model.tags import Tags
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
class CreateSettlementRequest(ModelNormal):
@@ -87,7 +85,7 @@ def openapi_types():
'currency': (Currency,), # noqa: E501
'merchant_id': (str,), # noqa: E501
'processor': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -146,7 +144,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
merchant_id (str): If the `Application` has more than one associated `processor`, this field is required.. [optional] # noqa: E501
processor (str): If the `Application` has more than one associated `processor`, it's required when creating `settlements` to include the `processor` (e.g. **DUMMY_V1**).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -231,7 +229,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
currency (Currency): [optional] # noqa: E501
merchant_id (str): If the `Application` has more than one associated `processor`, this field is required.. [optional] # noqa: E501
processor (str): If the `Application` has more than one associated `processor`, it's required when creating `settlements` to include the `processor` (e.g. **DUMMY_V1**).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_split_transfer_request.py b/finix/model/create_split_transfer_request.py
new file mode 100644
index 0000000..7a731e7
--- /dev/null
+++ b/finix/model/create_split_transfer_request.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateSplitTransferRequest(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'id': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'id': 'id', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """CreateSplitTransferRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """CreateSplitTransferRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_subscription_amount_request.py b/finix/model/create_subscription_amount_request.py
index e07961b..9633377 100644
--- a/finix/model/create_subscription_amount_request.py
+++ b/finix/model/create_subscription_amount_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.create_subscription_amount_request_fee_amount_data import CreateSubscriptionAmountRequestFeeAmountData
- from finix.model.tags import Tags
globals()['CreateSubscriptionAmountRequestFeeAmountData'] = CreateSubscriptionAmountRequestFeeAmountData
- globals()['Tags'] = Tags
class CreateSubscriptionAmountRequest(ModelNormal):
@@ -90,7 +88,7 @@ def openapi_types():
'amount_type': (str,), # noqa: E501
'fee_amount_data': (CreateSubscriptionAmountRequestFeeAmountData,), # noqa: E501
'nickname': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -151,7 +149,7 @@ def _from_openapi_data(cls, amount_type, fee_amount_data, *args, **kwargs): # n
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
nickname (str): Human readable name.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -240,7 +238,7 @@ def __init__(self, amount_type, fee_amount_data, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
nickname (str): Human readable name.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_subscription_enrollment_request.py b/finix/model/create_subscription_enrollment_request.py
index 06684ff..aed91c8 100644
--- a/finix/model/create_subscription_enrollment_request.py
+++ b/finix/model/create_subscription_enrollment_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateSubscriptionEnrollmentRequest(ModelNormal):
"""
@@ -77,7 +73,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -92,13 +87,12 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'merchant': (str,), # noqa: E501
'nickname': (str,), # noqa: E501
'started_at': (str,), # noqa: E501
'ended_at': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -161,7 +155,7 @@ def _from_openapi_data(cls, merchant, nickname, started_at, *args, **kwargs): #
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
ended_at (str, none_type): When the `subscription_enrollment` will end in **DateTime** format. If left **null**, the Fee will continue in perpetuity and won't end.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -252,7 +246,7 @@ def __init__(self, merchant, nickname, started_at, *args, **kwargs): # noqa: E5
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
ended_at (str, none_type): When the `subscription_enrollment` will end in **DateTime** format. If left **null**, the Fee will continue in perpetuity and won't end.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_subscription_schedule_request.py b/finix/model/create_subscription_schedule_request.py
index b9feb84..90ccb0a 100644
--- a/finix/model/create_subscription_schedule_request.py
+++ b/finix/model/create_subscription_schedule_request.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.create_subscription_schedule_request_fixed_time_interval_offset import CreateSubscriptionScheduleRequestFixedTimeIntervalOffset
from finix.model.create_subscription_schedule_request_period_offset import CreateSubscriptionScheduleRequestPeriodOffset
- from finix.model.tags import Tags
globals()['CreateSubscriptionScheduleRequestFixedTimeIntervalOffset'] = CreateSubscriptionScheduleRequestFixedTimeIntervalOffset
globals()['CreateSubscriptionScheduleRequestPeriodOffset'] = CreateSubscriptionScheduleRequestPeriodOffset
- globals()['Tags'] = Tags
class CreateSubscriptionScheduleRequest(ModelNormal):
@@ -102,7 +100,7 @@ def openapi_types():
'subscription_type': (str,), # noqa: E501
'fixed_time_interval_offset': (CreateSubscriptionScheduleRequestFixedTimeIntervalOffset,), # noqa: E501
'period_offset': (CreateSubscriptionScheduleRequestPeriodOffset,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -167,7 +165,7 @@ def _from_openapi_data(cls, nickname, subscription_type, *args, **kwargs): # no
_visited_composed_classes = (Animal,)
fixed_time_interval_offset (CreateSubscriptionScheduleRequestFixedTimeIntervalOffset): [optional] # noqa: E501
period_offset (CreateSubscriptionScheduleRequestPeriodOffset): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
line_item_type = kwargs.get('line_item_type', "FEE")
@@ -260,7 +258,7 @@ def __init__(self, nickname, subscription_type, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
fixed_time_interval_offset (CreateSubscriptionScheduleRequestFixedTimeIntervalOffset): [optional] # noqa: E501
period_offset (CreateSubscriptionScheduleRequestPeriodOffset): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
line_item_type = kwargs.get('line_item_type', "FEE")
diff --git a/finix/model/create_transfer_request.py b/finix/model/create_transfer_request.py
index ef677ec..877968b 100644
--- a/finix/model/create_transfer_request.py
+++ b/finix/model/create_transfer_request.py
@@ -30,18 +30,18 @@
def lazy_import():
from finix.model.additional_buyer_charges import AdditionalBuyerCharges
from finix.model.additional_purchase_data import AdditionalPurchaseData
- from finix.model.card_present_instrument_form import CardPresentInstrumentForm
from finix.model.configuration_details import ConfigurationDetails
from finix.model.create_transfer_request3d_secure_authentication import CreateTransferRequest3dSecureAuthentication
+ from finix.model.create_transfer_request_split_transfers import CreateTransferRequestSplitTransfers
from finix.model.currency import Currency
- from finix.model.tags import Tags
+ from finix.model.l3_additional_purchase_data import L3AdditionalPurchaseData
globals()['AdditionalBuyerCharges'] = AdditionalBuyerCharges
globals()['AdditionalPurchaseData'] = AdditionalPurchaseData
- globals()['CardPresentInstrumentForm'] = CardPresentInstrumentForm
globals()['ConfigurationDetails'] = ConfigurationDetails
globals()['CreateTransferRequest3dSecureAuthentication'] = CreateTransferRequest3dSecureAuthentication
+ globals()['CreateTransferRequestSplitTransfers'] = CreateTransferRequestSplitTransfers
globals()['Currency'] = Currency
- globals()['Tags'] = Tags
+ globals()['L3AdditionalPurchaseData'] = L3AdditionalPurchaseData
class CreateTransferRequest(ModelNormal):
@@ -68,18 +68,21 @@ class CreateTransferRequest(ModelNormal):
allowed_values = {
('operation_key',): {
'None': None,
- 'PUSH_TO_CARD': "PUSH_TO_CARD",
- 'PULL_FROM_CARD': "PULL_FROM_CARD",
'CARD_PRESENT_DEBIT': "CARD_PRESENT_DEBIT",
'CARD_PRESENT_UNREFERENCED_REFUND': "CARD_PRESENT_UNREFERENCED_REFUND",
- 'SALE': "SALE",
- 'UNREFERENCED_REFUND': "UNREFERENCED_REFUND",
'MERCHANT_CREDIT_ADJUSTMENT': "MERCHANT_CREDIT_ADJUSTMENT",
'MERCHANT_DEBIT_ADJUSTMENT': "MERCHANT_DEBIT_ADJUSTMENT",
+ 'PULL_FROM_CARD': "PULL_FROM_CARD",
+ 'PUSH_TO_CARD': "PUSH_TO_CARD",
+ 'SALE': "SALE",
+ 'UNREFERENCED_REFUND': "UNREFERENCED_REFUND",
},
}
validations = {
+ ('statement_descriptor',): {
+ 'max_length': 20,
+ },
}
@cached_property
@@ -105,25 +108,28 @@ def openapi_types():
"""
lazy_import()
return {
- 'amount': (int,), # noqa: E501
- 'currency': (Currency,), # noqa: E501
'additional_buyer_charges': (AdditionalBuyerCharges,), # noqa: E501
'additional_purchase_data': (AdditionalPurchaseData,), # noqa: E501
'adjustment_request': (bool, none_type,), # noqa: E501
+ 'amount': (int,), # noqa: E501
+ 'currency': (Currency,), # noqa: E501
'destination': (str, none_type,), # noqa: E501
'device': (str, none_type,), # noqa: E501
- 'device_configuration': (ConfigurationDetails,), # noqa: E501
'fee': (int,), # noqa: E501
'fraud_session_id': (str,), # noqa: E501
+ 'hsa_fsa_payment': (bool, none_type,), # noqa: E501
'idempotency_id': (str, none_type,), # noqa: E501
'merchant': (str, none_type,), # noqa: E501
'operation_key': (str, none_type,), # noqa: E501
- 'payment_instrument': (CardPresentInstrumentForm,), # noqa: E501
'processor': (str,), # noqa: E501
'source': (str,), # noqa: E501
+ 'security_code': (str, none_type,), # noqa: E501
'statement_descriptor': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'_3d_secure_authentication': (CreateTransferRequest3dSecureAuthentication,), # noqa: E501
+ 'additional_purchase_data_': (L3AdditionalPurchaseData,), # noqa: E501
+ 'device_configuration': (ConfigurationDetails,), # noqa: E501
+ 'split_transfers': (CreateTransferRequestSplitTransfers,), # noqa: E501
}
@cached_property
@@ -132,25 +138,28 @@ def discriminator():
attribute_map = {
- 'amount': 'amount', # noqa: E501
- 'currency': 'currency', # noqa: E501
'additional_buyer_charges': 'additional_buyer_charges', # noqa: E501
'additional_purchase_data': 'additional_purchase_data', # noqa: E501
'adjustment_request': 'adjustment_request', # noqa: E501
+ 'amount': 'amount', # noqa: E501
+ 'currency': 'currency', # noqa: E501
'destination': 'destination', # noqa: E501
'device': 'device', # noqa: E501
- 'device_configuration': 'device_configuration', # noqa: E501
'fee': 'fee', # noqa: E501
'fraud_session_id': 'fraud_session_id', # noqa: E501
+ 'hsa_fsa_payment': 'hsa_fsa_payment', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
'merchant': 'merchant', # noqa: E501
'operation_key': 'operation_key', # noqa: E501
- 'payment_instrument': 'payment_instrument', # noqa: E501
'processor': 'processor', # noqa: E501
'source': 'source', # noqa: E501
+ 'security_code': 'security_code', # noqa: E501
'statement_descriptor': 'statement_descriptor', # noqa: E501
'tags': 'tags', # noqa: E501
'_3d_secure_authentication': '3d_secure_authentication', # noqa: E501
+ 'additional_purchase_data_': 'additional_purchase_data ', # noqa: E501
+ 'device_configuration': 'device_configuration', # noqa: E501
+ 'split_transfers': 'split_transfers', # noqa: E501
}
read_only_vars = {
@@ -160,13 +169,9 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
"""CreateTransferRequest - a model defined in OpenAPI
- Args:
- amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
- currency (Currency):
-
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -201,20 +206,25 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
adjustment_request (bool, none_type): Details if the `transfer` was created to adjust funds.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited from the buyer in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
destination (str, none_type): ID of the `Payment Instrument` where funds will be sent.. [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
- device_configuration (ConfigurationDetails): [optional] # noqa: E501
- fee (int): The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
- fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
- merchant (str, none_type): ID of the `Merchant` the `Transfer` was created under.. [optional] # noqa: E501
- operation_key (str, none_type): Details the operation that'll be performed in the transaction.. [optional] # noqa: E501
- payment_instrument (CardPresentInstrumentForm): [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.. [optional] # noqa: E501
+ fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/guides/payments/fraud-detection/).. [optional] # noqa: E501
+ hsa_fsa_payment (bool, none_type): Set to to **true** to process a payment using a `Payment Instrument` [created from a health savings account (HSA) or flexible spending account (FSA)](/guides/making-a-payment/hsa-fsa/).. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
+ merchant (str, none_type): - ID of the primary `Merchant` that's processing the `Transfer` for the buyer. - In Split Transactions, the `Merchant` specified in the `Transfer` request is the primary `Merchant`.. [optional] # noqa: E501
+ operation_key (str, none_type): Details the operation that's be performed in the transaction.. [optional] # noqa: E501
processor (str): Name of the transaction processor.. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
- statement_descriptor (str, none_type): The description of the transaction that appears on the buyer's bank or card statement.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ security_code (str, none_type): The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Transfer`.. [optional] # noqa: E501
+ statement_descriptor (str, none_type): - The description of the transaction that appears on the buyer's bank or card statement.
- statement_descriptors for `Transfers` in live enviroments will have a FI * prefix.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
_3d_secure_authentication (CreateTransferRequest3dSecureAuthentication): [optional] # noqa: E501
+ additional_purchase_data_ (L3AdditionalPurchaseData): [optional] # noqa: E501
+ device_configuration (ConfigurationDetails): [optional] # noqa: E501
+ split_transfers (CreateTransferRequestSplitTransfers): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -242,8 +252,6 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
- self.amount = amount
- self.currency = currency
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -264,13 +272,9 @@ def _from_openapi_data(cls, amount, currency, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
+ def __init__(self, *args, **kwargs): # noqa: E501
"""CreateTransferRequest - a model defined in OpenAPI
- Args:
- amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
- currency (Currency):
-
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -305,20 +309,25 @@ def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
adjustment_request (bool, none_type): Details if the `transfer` was created to adjust funds.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited from the buyer in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
destination (str, none_type): ID of the `Payment Instrument` where funds will be sent.. [optional] # noqa: E501
device (str, none_type): The ID of the activated device.. [optional] # noqa: E501
- device_configuration (ConfigurationDetails): [optional] # noqa: E501
- fee (int): The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
- fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).. [optional] # noqa: E501
- idempotency_id (str, none_type): A randomly generated value that'll be associated with the request.. [optional] # noqa: E501
- merchant (str, none_type): ID of the `Merchant` the `Transfer` was created under.. [optional] # noqa: E501
- operation_key (str, none_type): Details the operation that'll be performed in the transaction.. [optional] # noqa: E501
- payment_instrument (CardPresentInstrumentForm): [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.. [optional] # noqa: E501
+ fraud_session_id (str): The `fraud_session_session` ID you want to review for fraud. For more info, see [Fraud Detection](/guides/payments/fraud-detection/).. [optional] # noqa: E501
+ hsa_fsa_payment (bool, none_type): Set to to **true** to process a payment using a `Payment Instrument` [created from a health savings account (HSA) or flexible spending account (FSA)](/guides/making-a-payment/hsa-fsa/).. [optional] # noqa: E501
+ idempotency_id (str, none_type): A randomly generated value that gets tied with the request.. [optional] # noqa: E501
+ merchant (str, none_type): - ID of the primary `Merchant` that's processing the `Transfer` for the buyer. - In Split Transactions, the `Merchant` specified in the `Transfer` request is the primary `Merchant`.. [optional] # noqa: E501
+ operation_key (str, none_type): Details the operation that's be performed in the transaction.. [optional] # noqa: E501
processor (str): Name of the transaction processor.. [optional] # noqa: E501
source (str): ID of the `Payment Instrument` where funds get debited.. [optional] # noqa: E501
- statement_descriptor (str, none_type): The description of the transaction that appears on the buyer's bank or card statement.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ security_code (str, none_type): The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Transfer`.. [optional] # noqa: E501
+ statement_descriptor (str, none_type):
- The description of the transaction that appears on the buyer's bank or card statement.
- statement_descriptors for `Transfers` in live enviroments will have a FI * prefix.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
_3d_secure_authentication (CreateTransferRequest3dSecureAuthentication): [optional] # noqa: E501
+ additional_purchase_data_ (L3AdditionalPurchaseData): [optional] # noqa: E501
+ device_configuration (ConfigurationDetails): [optional] # noqa: E501
+ split_transfers (CreateTransferRequestSplitTransfers): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -344,8 +353,6 @@ def __init__(self, amount, currency, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
- self.amount = amount
- self.currency = currency
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_transfer_request3d_secure_authentication.py b/finix/model/create_transfer_request3d_secure_authentication.py
index b34c428..a494a1c 100644
--- a/finix/model/create_transfer_request3d_secure_authentication.py
+++ b/finix/model/create_transfer_request3d_secure_authentication.py
@@ -77,8 +77,8 @@ def openapi_types():
"""
return {
'cardholder_authentication': (str,), # noqa: E501
- 'cardholder_ip_address': (str,), # noqa: E501
'electronic_commerce_indicator': (str,), # noqa: E501
+ 'cardholder_ip_address': (str,), # noqa: E501
'transaction_id': (str,), # noqa: E501
}
@@ -89,8 +89,8 @@ def discriminator():
attribute_map = {
'cardholder_authentication': 'cardholder_authentication', # noqa: E501
- 'cardholder_ip_address': 'cardholder_ip_address', # noqa: E501
'electronic_commerce_indicator': 'electronic_commerce_indicator', # noqa: E501
+ 'cardholder_ip_address': 'cardholder_ip_address', # noqa: E501
'transaction_id': 'transaction_id', # noqa: E501
}
@@ -101,9 +101,13 @@ def discriminator():
@classmethod
@convert_js_args_to_python_args
- def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ def _from_openapi_data(cls, cardholder_authentication, electronic_commerce_indicator, *args, **kwargs): # noqa: E501
"""CreateTransferRequest3dSecureAuthentication - a model defined in OpenAPI
+ Args:
+ cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
+ electronic_commerce_indicator (str): - **AUTHENTICATED**: Approved by 3D Secure Vendor. - **ATTEMPTED**: Issuer or cardholder does not support 3D Secure.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -135,10 +139,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.. [optional] # noqa: E501
- cardholder_ip_address (str): Only required for American Express cards. Format is nnn.nnn.nnn.nnn. [optional] # noqa: E501
- electronic_commerce_indicator (str): AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED: Issuer or cardholder does not support 3D Secure. [optional] # noqa: E501
- transaction_id (str): Only valid for Visa transactions. [optional] # noqa: E501
+ cardholder_ip_address (str): Only required for **American Express** cards.. [optional] # noqa: E501
+ transaction_id (str): Only required for **Visa** cards.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -166,6 +168,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.cardholder_authentication = cardholder_authentication
+ self.electronic_commerce_indicator = electronic_commerce_indicator
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
@@ -186,9 +190,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
])
@convert_js_args_to_python_args
- def __init__(self, *args, **kwargs): # noqa: E501
+ def __init__(self, cardholder_authentication, electronic_commerce_indicator, *args, **kwargs): # noqa: E501
"""CreateTransferRequest3dSecureAuthentication - a model defined in OpenAPI
+ Args:
+ cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
+ electronic_commerce_indicator (str): - **AUTHENTICATED**: Approved by 3D Secure Vendor. - **ATTEMPTED**: Issuer or cardholder does not support 3D Secure.
+
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -220,10 +228,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- cardholder_authentication (str): Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.. [optional] # noqa: E501
- cardholder_ip_address (str): Only required for American Express cards. Format is nnn.nnn.nnn.nnn. [optional] # noqa: E501
- electronic_commerce_indicator (str): AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED: Issuer or cardholder does not support 3D Secure. [optional] # noqa: E501
- transaction_id (str): Only valid for Visa transactions. [optional] # noqa: E501
+ cardholder_ip_address (str): Only required for **American Express** cards.. [optional] # noqa: E501
+ transaction_id (str): Only required for **Visa** cards.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -249,6 +255,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.cardholder_authentication = cardholder_authentication
+ self.electronic_commerce_indicator = electronic_commerce_indicator
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
diff --git a/finix/model/create_transfer_request_split_transfers.py b/finix/model/create_transfer_request_split_transfers.py
new file mode 100644
index 0000000..dd91766
--- /dev/null
+++ b/finix/model/create_transfer_request_split_transfers.py
@@ -0,0 +1,258 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class CreateTransferRequestSplitTransfers(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'amount': (int,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'amount': 'amount', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
+ 'tags': 'tags', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """CreateTransferRequestSplitTransfers - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount (int): - The amount of funds that get split and paid out to the specified `Merchant`. - Must be less than or equal to the `amount` of the `Transfer.`. [optional] # noqa: E501
+ merchant (str): - The ID of the `Merchant` that will receive the specified `amount` under the `split_transfers` object. - In Split Transactions, the `Merchants` specified in the `split_transfers` object are the ancillary `Merchants.`. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """CreateTransferRequestSplitTransfers - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amount (int): - The amount of funds that get split and paid out to the specified `Merchant`. - Must be less than or equal to the `amount` of the `Transfer.`. [optional] # noqa: E501
+ merchant (str): - The ID of the `Merchant` that will receive the specified `amount` under the `split_transfers` object. - In Split Transactions, the `Merchants` specified in the `split_transfers` object are the ancillary `Merchants.`. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/create_user_request.py b/finix/model/create_user_request.py
index 5368ab3..a00b775 100644
--- a/finix/model/create_user_request.py
+++ b/finix/model/create_user_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class CreateUserRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,10 +75,9 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'enabled': (bool,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -138,7 +132,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Details if the `user` is enabled and active. Set to **false** to disable the `user`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -221,7 +215,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Details if the `user` is enabled and active. Set to **false** to disable the `user`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_verification_request.py b/finix/model/create_verification_request.py
index 7fe353b..6392afa 100644
--- a/finix/model/create_verification_request.py
+++ b/finix/model/create_verification_request.py
@@ -28,8 +28,8 @@
def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
+ from finix.model.address import Address
+ globals()['Address'] = Address
class CreateVerificationRequest(ModelNormal):
@@ -54,6 +54,11 @@ class CreateVerificationRequest(ModelNormal):
"""
allowed_values = {
+ ('processor',): {
+ 'DUMMY_V1': "DUMMY_V1",
+ 'MASTERCARD_V1': "MASTERCARD_V1",
+ 'VISA_V1': "VISA_V1",
+ },
}
validations = {
@@ -82,10 +87,13 @@ def openapi_types():
"""
lazy_import()
return {
- 'identity': (str,), # noqa: E501
'merchant': (str,), # noqa: E501
- 'processor': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'processor': (str,), # noqa: E501
+ 'security_code': (str,), # noqa: E501
+ 'verify_payment_card': (bool,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'address': (Address,), # noqa: E501
+ 'identity': (str,), # noqa: E501
}
@cached_property
@@ -94,10 +102,13 @@ def discriminator():
attribute_map = {
- 'identity': 'identity', # noqa: E501
'merchant': 'merchant', # noqa: E501
'processor': 'processor', # noqa: E501
+ 'security_code': 'security_code', # noqa: E501
+ 'verify_payment_card': 'verify_payment_card', # noqa: E501
'tags': 'tags', # noqa: E501
+ 'address': 'address', # noqa: E501
+ 'identity': 'identity', # noqa: E501
}
read_only_vars = {
@@ -141,10 +152,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ merchant (str): - The ID of the `Merchant`. - Must be included when `verify_payment_card` is set to **true**.. [optional] # noqa: E501
+ processor (str): Set the acquiring processor. Avalible values include:
- DUMMY_V1
- MASTERCARD_V1
- VISA_V1
Use DUMMY_V1 or null to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.. [optional] if omitted the server will use the default value of "DUMMY_V1" # noqa: E501
+ security_code (str): The ID of the `Merchant`.. [optional] # noqa: E501
+ verify_payment_card (bool): - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. - When set to **true**, `merchant` must also be included with your request.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ address (Address): [optional] # noqa: E501
identity (str): ID of the `Identity` resource associated with the `Merchant`.. [optional] # noqa: E501
- merchant (str): The ID of the `Merchant`.. [optional] # noqa: E501
- processor (str, none_type): Set the acquiring processor. Avalible values include: - DUMMY_V1
- LITLE_V1
- MASTERCARD_V1
- VISA_V1
- NMI_V1
- VANTIV_V1
Use DUMMY_V1 or null to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -226,10 +240,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ merchant (str): - The ID of the `Merchant`. - Must be included when `verify_payment_card` is set to **true**.. [optional] # noqa: E501
+ processor (str): Set the acquiring processor. Avalible values include: - DUMMY_V1
- MASTERCARD_V1
- VISA_V1
Use DUMMY_V1 or null to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.. [optional] if omitted the server will use the default value of "DUMMY_V1" # noqa: E501
+ security_code (str): The ID of the `Merchant`.. [optional] # noqa: E501
+ verify_payment_card (bool): - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. - When set to **true**, `merchant` must also be included with your request.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ address (Address): [optional] # noqa: E501
identity (str): ID of the `Identity` resource associated with the `Merchant`.. [optional] # noqa: E501
- merchant (str): The ID of the `Merchant`.. [optional] # noqa: E501
- processor (str, none_type): Set the acquiring processor. Avalible values include: - DUMMY_V1
- LITLE_V1
- MASTERCARD_V1
- VISA_V1
- NMI_V1
- VANTIV_V1
Use DUMMY_V1 or null to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/create_webhook_request.py b/finix/model/create_webhook_request.py
index 8202291..c8294cb 100644
--- a/finix/model/create_webhook_request.py
+++ b/finix/model/create_webhook_request.py
@@ -29,7 +29,9 @@
def lazy_import():
from finix.model.create_webhook_request_authentication import CreateWebhookRequestAuthentication
+ from finix.model.webhook_enabled_events import WebhookEnabledEvents
globals()['CreateWebhookRequestAuthentication'] = CreateWebhookRequestAuthentication
+ globals()['WebhookEnabledEvents'] = WebhookEnabledEvents
class CreateWebhookRequest(ModelNormal):
@@ -88,6 +90,7 @@ def openapi_types():
'url': (str,), # noqa: E501
'authentication': (CreateWebhookRequestAuthentication,), # noqa: E501
'enabled': (bool,), # noqa: E501
+ 'enabled_events': (WebhookEnabledEvents,), # noqa: E501
}
@cached_property
@@ -99,6 +102,7 @@ def discriminator():
'url': 'url', # noqa: E501
'authentication': 'authentication', # noqa: E501
'enabled': 'enabled', # noqa: E501
+ 'enabled_events': 'enabled_events', # noqa: E501
}
read_only_vars = {
@@ -147,6 +151,7 @@ def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
authentication (CreateWebhookRequestAuthentication): [optional] # noqa: E501
enabled (bool): Set to false to disable Webhooks. Default value when created is true.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,6 +239,7 @@ def __init__(self, url, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
authentication (CreateWebhookRequestAuthentication): [optional] # noqa: E501
enabled (bool): Set to false to disable Webhooks. Default value when created is true.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/device.py b/finix/model/device.py
index 236142b..b0d477b 100644
--- a/finix/model/device.py
+++ b/finix/model/device.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.device_config_details import DeviceConfigDetails
from finix.model.device_links import DeviceLinks
- from finix.model.tags import Tags
globals()['DeviceConfigDetails'] = DeviceConfigDetails
globals()['DeviceLinks'] = DeviceLinks
- globals()['Tags'] = Tags
class Device(ModelNormal):
@@ -58,6 +56,10 @@ class Device(ModelNormal):
"""
allowed_values = {
+ ('connection',): {
+ 'OPEN': "OPEN",
+ 'CLOSED': "CLOSED",
+ },
}
validations = {
@@ -86,7 +88,7 @@ def openapi_types():
"""
lazy_import()
return {
- 'id': (str, none_type,), # noqa: E501
+ 'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'configuration_details': (DeviceConfigDetails,), # noqa: E501
@@ -98,7 +100,7 @@ def openapi_types():
'model': (str,), # noqa: E501
'name': (str,), # noqa: E501
'serial_number': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (DeviceLinks,), # noqa: E501
}
@@ -165,7 +167,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the activated `Device`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
configuration_details (DeviceConfigDetails): [optional] # noqa: E501
@@ -177,7 +179,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
model (str): Details the model of the card reader.. [optional] # noqa: E501
name (str): Name of the `Device`.. [optional] # noqa: E501
serial_number (str, none_type): Serial number of the device.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (DeviceLinks): [optional] # noqa: E501
"""
@@ -260,7 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the activated `Device`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
configuration_details (DeviceConfigDetails): [optional] # noqa: E501
@@ -272,7 +274,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
model (str): Details the model of the card reader.. [optional] # noqa: E501
name (str): Name of the `Device`.. [optional] # noqa: E501
serial_number (str, none_type): Serial number of the device.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (DeviceLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/device_links.py b/finix/model/device_links.py
index e08c8de..74c8081 100644
--- a/finix/model/device_links.py
+++ b/finix/model/device_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.device_links_merchant import DeviceLinksMerchant
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['DeviceLinksMerchant'] = DeviceLinksMerchant
@@ -86,10 +86,10 @@ def openapi_types():
"""
lazy_import()
return {
- 'authorizations': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'authorizations': (ApplicationLinksAuthorizations,), # noqa: E501
'merchant': (DeviceLinksMerchant,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'transfers': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -145,10 +145,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
merchant (DeviceLinksMerchant): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -230,10 +230,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
merchant (DeviceLinksMerchant): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/dispute.py b/finix/model/dispute.py
index e057b53..d2c98ad 100644
--- a/finix/model/dispute.py
+++ b/finix/model/dispute.py
@@ -28,12 +28,10 @@
def lazy_import():
- from finix.model.currency import Currency
+ from finix.model.dispute_dispute_details import DisputeDisputeDetails
from finix.model.dispute_links import DisputeLinks
- from finix.model.tags import Tags
- globals()['Currency'] = Currency
+ globals()['DisputeDisputeDetails'] = DisputeDisputeDetails
globals()['DisputeLinks'] = DisputeLinks
- globals()['Tags'] = Tags
class Dispute(ModelNormal):
@@ -58,6 +56,13 @@ class Dispute(ModelNormal):
"""
allowed_values = {
+ ('evidence_submitted',): {
+ 'CHARGEBACK': "CHARGEBACK",
+ 'NOT_SUPPORTED': "NOT_SUPPORTED",
+ 'NONE': "NONE",
+ 'UNKNOWN': "UNKNOWN",
+ 'INQUIRY': "INQUIRY",
+ },
('reason',): {
'CLERICAL': "CLERICAL",
'FRAUD': "FRAUD",
@@ -65,12 +70,18 @@ class Dispute(ModelNormal):
'QUALITY': "QUALITY",
'TECHNICAL': "TECHNICAL",
},
+ ('response_state',): {
+ 'NEEDS_RESPONSE': "NEEDS_RESPONSE",
+ 'RESPONDED': "RESPONDED",
+ 'ACCEPTED': "ACCEPTED",
+ 'NO_RESPONSE_ALLOWED': "NO_RESPONSE_ALLOWED",
+ 'UNKNOWN': "UNKNOWN",
+ },
('state',): {
'INQUIRY': "INQUIRY",
'PENDING': "PENDING",
'WON': "WON",
'LOST': "LOST",
- 'ARBITRATION': "ARBITRATION",
},
}
@@ -106,15 +117,17 @@ def openapi_types():
'action': (str, none_type,), # noqa: E501
'amount': (int, none_type,), # noqa: E501
'application': (str,), # noqa: E501
- 'currency': (Currency,), # noqa: E501
- 'dispute_details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
- 'identity': (str, none_type,), # noqa: E501
+ 'dispute_details': (DisputeDisputeDetails,), # noqa: E501
+ 'evidence_submitted': (str,), # noqa: E501
+ 'identity': (str,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
'message': (str, none_type,), # noqa: E501
'occurred_at': (datetime, none_type,), # noqa: E501
'reason': (str,), # noqa: E501
'respond_by': (datetime, none_type,), # noqa: E501
+ 'response_state': (str,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'transfer': (str,), # noqa: E501
'links': (DisputeLinks,), # noqa: E501
}
@@ -131,13 +144,15 @@ def discriminator():
'action': 'action', # noqa: E501
'amount': 'amount', # noqa: E501
'application': 'application', # noqa: E501
- 'currency': 'currency', # noqa: E501
'dispute_details': 'dispute_details', # noqa: E501
+ 'evidence_submitted': 'evidence_submitted', # noqa: E501
'identity': 'identity', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
'message': 'message', # noqa: E501
'occurred_at': 'occurred_at', # noqa: E501
'reason': 'reason', # noqa: E501
'respond_by': 'respond_by', # noqa: E501
+ 'response_state': 'response_state', # noqa: E501
'state': 'state', # noqa: E501
'tags': 'tags', # noqa: E501
'transfer': 'transfer', # noqa: E501
@@ -190,16 +205,18 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
action (str, none_type): The next `action` required to move forward with the `Dispute`.. [optional] # noqa: E501
amount (int, none_type): The total amount of the `Dispute` (in cents).. [optional] # noqa: E501
- application (str): The ID of the `Application` resource the `Dispute` was created under.. [optional] # noqa: E501
- currency (Currency): [optional] # noqa: E501
- dispute_details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Details about the `Dispute` recieved by the `Processor`. May be any type of data.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource that the `Dispute` was created under.. [optional] # noqa: E501
+ dispute_details (DisputeDisputeDetails): [optional] # noqa: E501
+ evidence_submitted (str): The status of the uploaded evidence. [See `Dispute#response_details` for the next steps to move the `Dispute` forward](/api/tag/Disputes/#tag/Disputes/operation/getDispute!c=200&path=response_state&t=response).. [optional] # noqa: E501
+ identity (str): - The ID of the seller's `Identity` resource. - This is the `Identity` resource that was used to create the seller's `Merchant`.. [optional] # noqa: E501
+ merchant (str): - The ID of the seller's `Merchant` resource. - This is the `Merchant` account the `Dispute` was filed against.. [optional] # noqa: E501
message (str, none_type): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
- occurred_at (datetime, none_type): Point in time when dispute occurred.. [optional] # noqa: E501
+ occurred_at (datetime, none_type): Point in time when the `Transfer` that's getting disputed got created.. [optional] # noqa: E501
reason (str): The system-defined reason for the `Dispute`. Available values include:- **INQUIRY**
- **QUALITY**
- **FRAUD**. [optional] # noqa: E501
- respond_by (datetime, none_type): Point in time when dispute has to be resolved and the `Merchant` needs to respond by.. [optional] # noqa: E501
+ respond_by (datetime, none_type): Point in time, the `Merchant` needs to respond to the dispute by.. [optional] # noqa: E501
+ response_state (str): Details the state of the `Dispute` and what action the `Merchant` needs to take. - **NEEDS_RESPONSE**: The `Merchant` needs to respond to the `Dispute` by `Dispute#respond_by`. For details on how to respond to a `Dispute`, see [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/). - **RESPONDED**: The issuing bank has received the evidence and actively reviewing it. No action needed from the `Merchant`. - **ACCEPTED**: The `Merchant` has accepted the `Dispute`. When a `Dispute` is accepted, you concede that the dispute is not worth challenging or representing. For details on how to accept a `Dispute`, see [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/). - **NO_RESPONSE_ALLOWED**: The final `Dispute#response_state` when a `Dispute` is either **WON** or **LOST**. - **UNKNOWN**: `Dispute` details couldn't be submitted to the processor. Comes up when testing `Disputes` in sandbox or on the **DUMMY_V1** processor.. [optional] # noqa: E501
state (str): The current state of the `Dispute`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
transfer (str): ID of the `Transfer` resource.. [optional] # noqa: E501
links (DisputeLinks): [optional] # noqa: E501
"""
@@ -288,16 +305,18 @@ def __init__(self, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
action (str, none_type): The next `action` required to move forward with the `Dispute`.. [optional] # noqa: E501
amount (int, none_type): The total amount of the `Dispute` (in cents).. [optional] # noqa: E501
- application (str): The ID of the `Application` resource the `Dispute` was created under.. [optional] # noqa: E501
- currency (Currency): [optional] # noqa: E501
- dispute_details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Details about the `Dispute` recieved by the `Processor`. May be any type of data.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource that the `Dispute` was created under.. [optional] # noqa: E501
+ dispute_details (DisputeDisputeDetails): [optional] # noqa: E501
+ evidence_submitted (str): The status of the uploaded evidence. [See `Dispute#response_details` for the next steps to move the `Dispute` forward](/api/tag/Disputes/#tag/Disputes/operation/getDispute!c=200&path=response_state&t=response).. [optional] # noqa: E501
+ identity (str): - The ID of the seller's `Identity` resource. - This is the `Identity` resource that was used to create the seller's `Merchant`.. [optional] # noqa: E501
+ merchant (str): - The ID of the seller's `Merchant` resource. - This is the `Merchant` account the `Dispute` was filed against.. [optional] # noqa: E501
message (str, none_type): Message field that provides additional details. This field is typically **null**.. [optional] # noqa: E501
- occurred_at (datetime, none_type): Point in time when dispute occurred.. [optional] # noqa: E501
+ occurred_at (datetime, none_type): Point in time when the `Transfer` that's getting disputed got created.. [optional] # noqa: E501
reason (str): The system-defined reason for the `Dispute`. Available values include:
- **INQUIRY**
- **QUALITY**
- **FRAUD**. [optional] # noqa: E501
- respond_by (datetime, none_type): Point in time when dispute has to be resolved and the `Merchant` needs to respond by.. [optional] # noqa: E501
+ respond_by (datetime, none_type): Point in time, the `Merchant` needs to respond to the dispute by.. [optional] # noqa: E501
+ response_state (str): Details the state of the `Dispute` and what action the `Merchant` needs to take. - **NEEDS_RESPONSE**: The `Merchant` needs to respond to the `Dispute` by `Dispute#respond_by`. For details on how to respond to a `Dispute`, see [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/). - **RESPONDED**: The issuing bank has received the evidence and actively reviewing it. No action needed from the `Merchant`. - **ACCEPTED**: The `Merchant` has accepted the `Dispute`. When a `Dispute` is accepted, you concede that the dispute is not worth challenging or representing. For details on how to accept a `Dispute`, see [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/). - **NO_RESPONSE_ALLOWED**: The final `Dispute#response_state` when a `Dispute` is either **WON** or **LOST**. - **UNKNOWN**: `Dispute` details couldn't be submitted to the processor. Comes up when testing `Disputes` in sandbox or on the **DUMMY_V1** processor.. [optional] # noqa: E501
state (str): The current state of the `Dispute`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
transfer (str): ID of the `Transfer` resource.. [optional] # noqa: E501
links (DisputeLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/dispute_dispute_details.py b/finix/model/dispute_dispute_details.py
new file mode 100644
index 0000000..2c6716d
--- /dev/null
+++ b/finix/model/dispute_dispute_details.py
@@ -0,0 +1,258 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class DisputeDisputeDetails(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'case_id': (str, none_type,), # noqa: E501
+ 'pin_debit_adjustment_number': (str, none_type,), # noqa: E501
+ 'reason_code': (str, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'case_id': 'case_id', # noqa: E501
+ 'pin_debit_adjustment_number': 'pin_debit_adjustment_number', # noqa: E501
+ 'reason_code': 'reason_code', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """DisputeDisputeDetails - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ case_id (str, none_type): The case number the `Processor` has given the dispute in their internal database.. [optional] # noqa: E501
+ pin_debit_adjustment_number (str, none_type): Used by the processor to identify the funds that are getting disputed.. [optional] # noqa: E501
+ reason_code (str, none_type): Used by the processor and card networks to identify why the dispute got filed.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """DisputeDisputeDetails - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ case_id (str, none_type): The case number the `Processor` has given the dispute in their internal database.. [optional] # noqa: E501
+ pin_debit_adjustment_number (str, none_type): Used by the processor to identify the funds that are getting disputed.. [optional] # noqa: E501
+ reason_code (str, none_type): Used by the processor and card networks to identify why the dispute got filed.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/dispute_evidence.py b/finix/model/dispute_evidence.py
index 4388b1c..95265c4 100644
--- a/finix/model/dispute_evidence.py
+++ b/finix/model/dispute_evidence.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.dispute_evidence_links import DisputeEvidenceLinks
- from finix.model.tags import Tags
globals()['DisputeEvidenceLinks'] = DisputeEvidenceLinks
- globals()['Tags'] = Tags
class DisputeEvidence(ModelNormal):
@@ -93,9 +91,12 @@ def openapi_types():
'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
+ 'application': (str,), # noqa: E501
'dispute': (str,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'identity': (str,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (DisputeEvidenceLinks,), # noqa: E501
}
@@ -108,8 +109,11 @@ def discriminator():
'id': 'id', # noqa: E501
'created_at': 'created_at', # noqa: E501
'updated_at': 'updated_at', # noqa: E501
+ 'application': 'application', # noqa: E501
'dispute': 'dispute', # noqa: E501
'state': 'state', # noqa: E501
+ 'identity': 'identity', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
'tags': 'tags', # noqa: E501
'links': '_links', # noqa: E501
}
@@ -158,9 +162,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
id (str): The ID of the `Dispute` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- dispute (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource that the `Dispute` was created under.. [optional] # noqa: E501
+ dispute (str): The ID of the `Dispute` associated with the evidence.. [optional] # noqa: E501
state (str): Result of the evidence uploaded. - **PENDING**: The evidence file has not yet been submitted to the Processor. No user action is required. - **SUCCEEDED**: The evidence file has been successfully sent to the Processor. No further user action is required. - **CANCELED**: The evidence file upload was not completed due to user action. - **FAILED**: An issue occurred. User action is required**. Any of the following issues could have occurred: - There was an error in the system and the user should retry uploading their evidence file. - There is an issue with the file and the user should retry uploading a different file. - There is an issue and the user should contact Support.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ identity (str): - The ID of the seller's `Identity` resource. - This is the `Identity` resource that was used to create the seller's `Merchant`.. [optional] # noqa: E501
+ merchant (str): - The ID of the seller's `Merchant` resource. - This is the `Merchant` account the `Dispute` was filed against.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (DisputeEvidenceLinks): [optional] # noqa: E501
"""
@@ -246,9 +253,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
id (str): The ID of the `Dispute` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- dispute (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource that the `Dispute` was created under.. [optional] # noqa: E501
+ dispute (str): The ID of the `Dispute` associated with the evidence.. [optional] # noqa: E501
state (str): Result of the evidence uploaded. - **PENDING**: The evidence file has not yet been submitted to the Processor. No user action is required. - **SUCCEEDED**: The evidence file has been successfully sent to the Processor. No further user action is required. - **CANCELED**: The evidence file upload was not completed due to user action. - **FAILED**: An issue occurred. User action is required**. Any of the following issues could have occurred: - There was an error in the system and the user should retry uploading their evidence file. - There is an issue with the file and the user should retry uploading a different file. - There is an issue and the user should contact Support.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ identity (str): - The ID of the seller's `Identity` resource. - This is the `Identity` resource that was used to create the seller's `Merchant`.. [optional] # noqa: E501
+ merchant (str): - The ID of the seller's `Merchant` resource. - This is the `Merchant` account the `Dispute` was filed against.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (DisputeEvidenceLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/dispute_links.py b/finix/model/dispute_links.py
index 5f4883a..aae9722 100644
--- a/finix/model/dispute_links.py
+++ b/finix/model/dispute_links.py
@@ -28,11 +28,11 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
from finix.model.dispute_links_transfer import DisputeLinksTransfer
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
globals()['DisputeLinksTransfer'] = DisputeLinksTransfer
@@ -88,9 +88,9 @@ def openapi_types():
"""
lazy_import()
return {
- 'adjustment_transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'adjustment_transfers': (ApplicationLinksAuthorizations,), # noqa: E501
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'evidence': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'evidence': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
'transfer': (DisputeLinksTransfer,), # noqa: E501
}
@@ -149,9 +149,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- adjustment_transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ adjustment_transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- evidence (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ evidence (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
transfer (DisputeLinksTransfer): [optional] # noqa: E501
"""
@@ -235,9 +235,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- adjustment_transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ adjustment_transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- evidence (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ evidence (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
transfer (DisputeLinksTransfer): [optional] # noqa: E501
"""
diff --git a/finix/model/error401_unauthorized_embedded.py b/finix/model/error401_unauthorized_embedded.py
index 4f23f59..fca61ee 100644
--- a/finix/model/error401_unauthorized_embedded.py
+++ b/finix/model/error401_unauthorized_embedded.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.error401_unauthorized_embedded_errors_inner import Error401UnauthorizedEmbeddedErrorsInner
- globals()['Error401UnauthorizedEmbeddedErrorsInner'] = Error401UnauthorizedEmbeddedErrorsInner
-
class Error401UnauthorizedEmbedded(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'errors': ([Error401UnauthorizedEmbeddedErrorsInner],), # noqa: E501
+ 'errors': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error401UnauthorizedEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error401UnauthorizedEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/error402_payment_required_embedded.py b/finix/model/error402_payment_required_embedded.py
index d762dab..189dbbb 100644
--- a/finix/model/error402_payment_required_embedded.py
+++ b/finix/model/error402_payment_required_embedded.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.error402_payment_required_embedded_errors_inner import Error402PaymentRequiredEmbeddedErrorsInner
- globals()['Error402PaymentRequiredEmbeddedErrorsInner'] = Error402PaymentRequiredEmbeddedErrorsInner
-
class Error402PaymentRequiredEmbedded(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'errors': ([Error402PaymentRequiredEmbeddedErrorsInner],), # noqa: E501
+ 'errors': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error402PaymentRequiredEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error402PaymentRequiredEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/error403_forbidden_list_embedded.py b/finix/model/error403_forbidden_list_embedded.py
index d7e1acd..169978b 100644
--- a/finix/model/error403_forbidden_list_embedded.py
+++ b/finix/model/error403_forbidden_list_embedded.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.error403_forbidden_list_embedded_errors_inner import Error403ForbiddenListEmbeddedErrorsInner
- globals()['Error403ForbiddenListEmbeddedErrorsInner'] = Error403ForbiddenListEmbeddedErrorsInner
-
class Error403ForbiddenListEmbedded(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'errors': ([Error403ForbiddenListEmbeddedErrorsInner],), # noqa: E501
+ 'errors': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error403ForbiddenListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error403ForbiddenListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/error404_not_found_list_embedded.py b/finix/model/error404_not_found_list_embedded.py
index 8640dbb..f98f420 100644
--- a/finix/model/error404_not_found_list_embedded.py
+++ b/finix/model/error404_not_found_list_embedded.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.error404_not_found_list_embedded_errors_inner import Error404NotFoundListEmbeddedErrorsInner
- globals()['Error404NotFoundListEmbeddedErrorsInner'] = Error404NotFoundListEmbeddedErrorsInner
-
class Error404NotFoundListEmbedded(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'errors': ([Error404NotFoundListEmbeddedErrorsInner],), # noqa: E501
+ 'errors': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error404NotFoundListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error404NotFoundListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/error422_invalid_field_list_embedded.py b/finix/model/error422_invalid_field_list_embedded.py
index aa2d9ec..dbf9e61 100644
--- a/finix/model/error422_invalid_field_list_embedded.py
+++ b/finix/model/error422_invalid_field_list_embedded.py
@@ -28,8 +28,8 @@
def lazy_import():
- from finix.model.error422_invalid_field_list_embedded_errors_inner import Error422InvalidFieldListEmbeddedErrorsInner
- globals()['Error422InvalidFieldListEmbeddedErrorsInner'] = Error422InvalidFieldListEmbeddedErrorsInner
+ from finix.model.error422_invalid_field_list_embedded_errors import Error422InvalidFieldListEmbeddedErrors
+ globals()['Error422InvalidFieldListEmbeddedErrors'] = Error422InvalidFieldListEmbeddedErrors
class Error422InvalidFieldListEmbedded(ModelNormal):
@@ -82,7 +82,7 @@ def openapi_types():
"""
lazy_import()
return {
- 'errors': ([Error422InvalidFieldListEmbeddedErrorsInner],), # noqa: E501
+ 'errors': ([Error422InvalidFieldListEmbeddedErrors],), # noqa: E501
}
@cached_property
@@ -135,7 +135,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error422InvalidFieldListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([Error422InvalidFieldListEmbeddedErrors]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +217,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- errors ([Error422InvalidFieldListEmbeddedErrorsInner]): [optional] # noqa: E501
+ errors ([Error422InvalidFieldListEmbeddedErrors]): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/error422_invalid_field_list_embedded_errors.py b/finix/model/error422_invalid_field_list_embedded_errors.py
new file mode 100644
index 0000000..e5d2441
--- /dev/null
+++ b/finix/model/error422_invalid_field_list_embedded_errors.py
@@ -0,0 +1,277 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.error422_invalid_field_list_embedded_links import Error422InvalidFieldListEmbeddedLinks
+ from finix.model.log_ref import LogRef
+ globals()['Error422InvalidFieldListEmbeddedLinks'] = Error422InvalidFieldListEmbeddedLinks
+ globals()['LogRef'] = LogRef
+
+
+class Error422InvalidFieldListEmbeddedErrors(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('code',): {
+ 'INVALID_FIELD': "INVALID_FIELD",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'code': (str,), # noqa: E501
+ 'field': (str,), # noqa: E501
+ 'logref': (LogRef,), # noqa: E501
+ 'message': (str,), # noqa: E501
+ 'links': (Error422InvalidFieldListEmbeddedLinks,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'code': 'code', # noqa: E501
+ 'field': 'field', # noqa: E501
+ 'logref': 'logref', # noqa: E501
+ 'message': 'message', # noqa: E501
+ 'links': '_links', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """Error422InvalidFieldListEmbeddedErrors - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ code (str): [optional] if omitted the server will use the default value of "INVALID_FIELD" # noqa: E501
+ field (str): [optional] # noqa: E501
+ logref (LogRef): [optional] # noqa: E501
+ message (str): [optional] # noqa: E501
+ links (Error422InvalidFieldListEmbeddedLinks): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """Error422InvalidFieldListEmbeddedErrors - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ code (str): [optional] if omitted the server will use the default value of "INVALID_FIELD" # noqa: E501
+ field (str): [optional] # noqa: E501
+ logref (LogRef): [optional] # noqa: E501
+ message (str): [optional] # noqa: E501
+ links (Error422InvalidFieldListEmbeddedLinks): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/error422_invalid_field_list_embedded_links.py b/finix/model/error422_invalid_field_list_embedded_links.py
new file mode 100644
index 0000000..8b6fe7d
--- /dev/null
+++ b/finix/model/error422_invalid_field_list_embedded_links.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
+
+
+class Error422InvalidFieldListEmbeddedLinks(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'source': (ApplicationLinksAuthorizations,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'source': 'source', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """Error422InvalidFieldListEmbeddedLinks - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ source (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """Error422InvalidFieldListEmbeddedLinks - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ source (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/external_link.py b/finix/model/external_link.py
index 4819207..4305e1e 100644
--- a/finix/model/external_link.py
+++ b/finix/model/external_link.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class ExternalLink(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,7 +75,6 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
@@ -88,7 +82,7 @@ def openapi_types():
'expired': (bool,), # noqa: E501
'expires_at': (str,), # noqa: E501
'file_id': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
'url': (str,), # noqa: E501
'user_id': (str,), # noqa: E501
@@ -159,7 +153,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
expired (bool):
- If TRUE the link has expired
- If FALSE, the link is active and files can still be uploaded or downloaded from the link.. [optional] # noqa: E501
expires_at (str): The timestamp that the external link expires at.. [optional] # noqa: E501
file_id (str): The `File` ID the `external_link` is related to.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Sets if the link is for uploading or downloading files from Finix.. [optional] # noqa: E501
url (str): The URL you can share with merchants to **UPLOAD** or **DOWNLOAD** files depending on the request sent.. [optional] # noqa: E501
user_id (str): The ID of the `user` that requested to create this link.. [optional] # noqa: E501
@@ -250,7 +244,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
expired (bool):
- If TRUE the link has expired
- If FALSE, the link is active and files can still be uploaded or downloaded from the link.. [optional] # noqa: E501
expires_at (str): The timestamp that the external link expires at.. [optional] # noqa: E501
file_id (str): The `File` ID the `external_link` is related to.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Sets if the link is for uploading or downloading files from Finix.. [optional] # noqa: E501
url (str): The URL you can share with merchants to **UPLOAD** or **DOWNLOAD** files depending on the request sent.. [optional] # noqa: E501
user_id (str): The ID of the `user` that requested to create this link.. [optional] # noqa: E501
diff --git a/finix/model/fee.py b/finix/model/fee.py
index ebf77f7..2c790ef 100644
--- a/finix/model/fee.py
+++ b/finix/model/fee.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.currency import Currency
from finix.model.fee_links import FeeLinks
- from finix.model.tags import Tags
globals()['Currency'] = Currency
globals()['FeeLinks'] = FeeLinks
- globals()['Tags'] = Tags
class Fee(ModelNormal):
@@ -158,7 +156,7 @@ def openapi_types():
'linked_id': (str,), # noqa: E501
'linked_type': (str,), # noqa: E501
'merchant': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (FeeLinks,), # noqa: E501
}
@@ -237,7 +235,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
linked_id (str): ID of the linked resource.. [optional] # noqa: E501
linked_type (str): The type of entity the `fee` is linked to (**null** by default).. [optional] # noqa: E501
merchant (str): The `Merchant` ID that the fee is being debited from.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (FeeLinks): [optional] # noqa: E501
"""
@@ -332,7 +330,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
linked_id (str): ID of the linked resource.. [optional] # noqa: E501
linked_type (str): The type of entity the `fee` is linked to (**null** by default).. [optional] # noqa: E501
merchant (str): The `Merchant` ID that the fee is being debited from.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (FeeLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/fee_profile.py b/finix/model/fee_profile.py
index da676b8..b62f080 100644
--- a/finix/model/fee_profile.py
+++ b/finix/model/fee_profile.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.fee_profile_links import FeeProfileLinks
- from finix.model.tags import Tags
globals()['FeeProfileLinks'] = FeeProfileLinks
- globals()['Tags'] = Tags
class FeeProfile(ModelNormal):
@@ -98,13 +96,15 @@ def openapi_types():
'american_express_assessment_basis_points': (int, none_type,), # noqa: E501
'american_express_basis_points': (int, none_type,), # noqa: E501
'american_express_charge_interchange': (bool, none_type,), # noqa: E501
- 'american_express_fixed_fee': (int, none_type,), # noqa: E501
'american_express_externally_funded_basis_points': (int, none_type,), # noqa: E501
'american_express_externally_funded_fixed_fee': (int, none_type,), # noqa: E501
+ 'american_express_fixed_fee': (int, none_type,), # noqa: E501
'ancillary_fixed_fee_primary': (int, none_type,), # noqa: E501
'ancillary_fixed_fee_secondary': (int, none_type,), # noqa: E501
'application': (str,), # noqa: E501
'basis_points': (int,), # noqa: E501
+ 'card_cross_border_basis_points': (int, none_type,), # noqa: E501
+ 'card_cross_border_fixed_fee': (int, none_type,), # noqa: E501
'charge_interchange': (bool,), # noqa: E501
'diners_club_basis_points': (int, none_type,), # noqa: E501
'diners_club_charge_interchange': (bool, none_type,), # noqa: E501
@@ -113,9 +113,9 @@ def openapi_types():
'discover_basis_points': (int, none_type,), # noqa: E501
'discover_charge_interchange': (bool, none_type,), # noqa: E501
'discover_data_usage_fixed_fee': (int, none_type,), # noqa: E501
- 'discover_fixed_fee': (int, none_type,), # noqa: E501
'discover_externally_funded_basis_points': (int, none_type,), # noqa: E501
'discover_externally_funded_fixed_fee': (int, none_type,), # noqa: E501
+ 'discover_fixed_fee': (int, none_type,), # noqa: E501
'discover_network_authorization_fixed_fee': (int, none_type,), # noqa: E501
'dispute_fixed_fee': (int, none_type,), # noqa: E501
'dispute_inquiry_fixed_fee': (int, none_type,), # noqa: E501
@@ -133,7 +133,6 @@ def openapi_types():
'mastercard_fixed_fee': (int, none_type,), # noqa: E501
'qualified_tiers': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'rounding_mode': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
'visa_acquirer_processing_fixed_fee': (int, none_type,), # noqa: E501
'visa_assessments_basis_points': (int, none_type,), # noqa: E501
'visa_base_ii_credit_voucher_fixed_fee': (int, none_type,), # noqa: E501
@@ -162,13 +161,15 @@ def discriminator():
'american_express_assessment_basis_points': 'american_express_assessment_basis_points', # noqa: E501
'american_express_basis_points': 'american_express_basis_points', # noqa: E501
'american_express_charge_interchange': 'american_express_charge_interchange', # noqa: E501
- 'american_express_fixed_fee': 'american_express_fixed_fee', # noqa: E501
'american_express_externally_funded_basis_points': 'american_express_externally_funded_basis_points', # noqa: E501
'american_express_externally_funded_fixed_fee': 'american_express_externally_funded_fixed_fee', # noqa: E501
+ 'american_express_fixed_fee': 'american_express_fixed_fee', # noqa: E501
'ancillary_fixed_fee_primary': 'ancillary_fixed_fee_primary', # noqa: E501
'ancillary_fixed_fee_secondary': 'ancillary_fixed_fee_secondary', # noqa: E501
'application': 'application', # noqa: E501
'basis_points': 'basis_points', # noqa: E501
+ 'card_cross_border_basis_points': 'card_cross_border_basis_points', # noqa: E501
+ 'card_cross_border_fixed_fee': 'card_cross_border_fixed_fee', # noqa: E501
'charge_interchange': 'charge_interchange', # noqa: E501
'diners_club_basis_points': 'diners_club_basis_points', # noqa: E501
'diners_club_charge_interchange': 'diners_club_charge_interchange', # noqa: E501
@@ -177,9 +178,9 @@ def discriminator():
'discover_basis_points': 'discover_basis_points', # noqa: E501
'discover_charge_interchange': 'discover_charge_interchange', # noqa: E501
'discover_data_usage_fixed_fee': 'discover_data_usage_fixed_fee', # noqa: E501
- 'discover_fixed_fee': 'discover_fixed_fee', # noqa: E501
'discover_externally_funded_basis_points': 'discover_externally_funded_basis_points', # noqa: E501
'discover_externally_funded_fixed_fee': 'discover_externally_funded_fixed_fee', # noqa: E501
+ 'discover_fixed_fee': 'discover_fixed_fee', # noqa: E501
'discover_network_authorization_fixed_fee': 'discover_network_authorization_fixed_fee', # noqa: E501
'dispute_fixed_fee': 'dispute_fixed_fee', # noqa: E501
'dispute_inquiry_fixed_fee': 'dispute_inquiry_fixed_fee', # noqa: E501
@@ -197,7 +198,6 @@ def discriminator():
'mastercard_fixed_fee': 'mastercard_fixed_fee', # noqa: E501
'qualified_tiers': 'qualified_tiers', # noqa: E501
'rounding_mode': 'rounding_mode', # noqa: E501
- 'tags': 'tags', # noqa: E501
'visa_acquirer_processing_fixed_fee': 'visa_acquirer_processing_fixed_fee', # noqa: E501
'visa_assessments_basis_points': 'visa_assessments_basis_points', # noqa: E501
'visa_base_ii_credit_voucher_fixed_fee': 'visa_base_II_credit_voucher_fixed_fee', # noqa: E501
@@ -251,23 +251,25 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str): [optional] # noqa: E501
+ id (str): The ID of the `Fee Profile` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
ach_basis_points (int): Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
- ach_credit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payments) credit return.. [optional] # noqa: E501
- ach_debit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payment) debit return.. [optional] # noqa: E501
+ ach_credit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payments) credit return.. [optional] # noqa: E501
+ ach_debit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payment) debit return.. [optional] # noqa: E501
ach_fixed_fee (int): Fee in cents incurred for each individual `Transfer`.. [optional] # noqa: E501
american_express_assessment_basis_points (int, none_type): Applies to gross American Express card volume.. [optional] # noqa: E501
american_express_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each American Express `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
american_express_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for American Express `Transfers`.. [optional] # noqa: E501
- american_express_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express `Transfer`.. [optional] # noqa: E501
american_express_externally_funded_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each American Express externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
american_express_externally_funded_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express externally funded `Transfer`.. [optional] # noqa: E501
+ american_express_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_primary (int, none_type): An additional fixed fee that can be charged per `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_secondary (int, none_type): An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` associated with the `Fee Profile`.. [optional] # noqa: E501
basis_points (int): Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
+ card_cross_border_basis_points (int, none_type): Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_fixed_fee (int, none_type): Fee in cents charged against every `Transfer` that includes non-US cards.. [optional] # noqa: E501
charge_interchange (bool): Set to **True** to incur interchange fees for card-based `Transfers`.. [optional] # noqa: E501
diners_club_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
diners_club_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Diners `Transfers`.. [optional] # noqa: E501
@@ -276,9 +278,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
discover_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Discover `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
discover_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Discover `Transfers`.. [optional] # noqa: E501
discover_data_usage_fixed_fee (int, none_type): Applies to all U.S.-based `authorization` transactions.. [optional] # noqa: E501
- discover_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover `Transfer`.. [optional] # noqa: E501
discover_externally_funded_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Discover externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
discover_externally_funded_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover externally funded `Transfer`.. [optional] # noqa: E501
+ discover_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover `Transfer`.. [optional] # noqa: E501
discover_network_authorization_fixed_fee (int, none_type): This fee applies to all Discover network `authorizations` and replaces the previously assessed Data Transmission.. [optional] # noqa: E501
dispute_fixed_fee (int, none_type): Applied when a `dispute` is created or updated to a **PENDING** state.. [optional] # noqa: E501
dispute_inquiry_fixed_fee (int, none_type): Applied when a `dispute` is created or updated to a **INQUIRY** state.. [optional] # noqa: E501
@@ -296,7 +298,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
mastercard_fixed_fee (int, none_type): Fee in cents incurred for each individual MasterCard `Transfer`.. [optional] # noqa: E501
qualified_tiers ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): The top of the qualified tier tree.. [optional] # noqa: E501
rounding_mode (str):
- Include AGGREGATE if you want to round after the settlement calculation.
- By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)
. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
visa_acquirer_processing_fixed_fee (int, none_type): Applied to all U.S.-based credit card authorizations acquired in the U.S. regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations. [optional] # noqa: E501
visa_assessments_basis_points (int, none_type): Applies to all Visa credit transactions.. [optional] # noqa: E501
visa_base_ii_credit_voucher_fixed_fee (int, none_type): Applies to all U.S.-based refunds.. [optional] # noqa: E501
@@ -388,23 +389,25 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str): [optional] # noqa: E501
+ id (str): The ID of the `Fee Profile` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
ach_basis_points (int): Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
- ach_credit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payments) credit return.. [optional] # noqa: E501
- ach_debit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the merchant for processing an echeck (also called ACH payment) debit return.. [optional] # noqa: E501
+ ach_credit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payments) credit return.. [optional] # noqa: E501
+ ach_debit_return_fixed_fee (int, none_type): A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payment) debit return.. [optional] # noqa: E501
ach_fixed_fee (int): Fee in cents incurred for each individual `Transfer`.. [optional] # noqa: E501
american_express_assessment_basis_points (int, none_type): Applies to gross American Express card volume.. [optional] # noqa: E501
american_express_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each American Express `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
american_express_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for American Express `Transfers`.. [optional] # noqa: E501
- american_express_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express `Transfer`.. [optional] # noqa: E501
american_express_externally_funded_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each American Express externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
american_express_externally_funded_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express externally funded `Transfer`.. [optional] # noqa: E501
+ american_express_fixed_fee (int, none_type): Fee in cents incurred for each individual American Express `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_primary (int, none_type): An additional fixed fee that can be charged per `Transfer`.. [optional] # noqa: E501
ancillary_fixed_fee_secondary (int, none_type): An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` associated with the `Fee Profile`.. [optional] # noqa: E501
basis_points (int): Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
+ card_cross_border_basis_points (int, none_type): Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
+ card_cross_border_fixed_fee (int, none_type): Fee in cents charged against every `Transfer` that includes non-US cards.. [optional] # noqa: E501
charge_interchange (bool): Set to **True** to incur interchange fees for card-based `Transfers`.. [optional] # noqa: E501
diners_club_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
diners_club_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Diners `Transfers`.. [optional] # noqa: E501
@@ -413,9 +416,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
discover_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Discover `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). [optional] # noqa: E501
discover_charge_interchange (bool, none_type): Set to **True** to incur interchange fees for Discover `Transfers`.. [optional] # noqa: E501
discover_data_usage_fixed_fee (int, none_type): Applies to all U.S.-based `authorization` transactions.. [optional] # noqa: E501
- discover_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover `Transfer`.. [optional] # noqa: E501
discover_externally_funded_basis_points (int, none_type): Percentage-based fee incurred against the full amount of each Discover externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).. [optional] # noqa: E501
discover_externally_funded_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover externally funded `Transfer`.. [optional] # noqa: E501
+ discover_fixed_fee (int, none_type): Fee in cents incurred for each individual Discover `Transfer`.. [optional] # noqa: E501
discover_network_authorization_fixed_fee (int, none_type): This fee applies to all Discover network `authorizations` and replaces the previously assessed Data Transmission.. [optional] # noqa: E501
dispute_fixed_fee (int, none_type): Applied when a `dispute` is created or updated to a **PENDING** state.. [optional] # noqa: E501
dispute_inquiry_fixed_fee (int, none_type): Applied when a `dispute` is created or updated to a **INQUIRY** state.. [optional] # noqa: E501
@@ -433,7 +436,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
mastercard_fixed_fee (int, none_type): Fee in cents incurred for each individual MasterCard `Transfer`.. [optional] # noqa: E501
qualified_tiers ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): The top of the qualified tier tree.. [optional] # noqa: E501
rounding_mode (str): - Include AGGREGATE if you want to round after the settlement calculation.
- By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)
. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
visa_acquirer_processing_fixed_fee (int, none_type): Applied to all U.S.-based credit card authorizations acquired in the U.S. regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations. [optional] # noqa: E501
visa_assessments_basis_points (int, none_type): Applies to all Visa credit transactions.. [optional] # noqa: E501
visa_base_ii_credit_voucher_fixed_fee (int, none_type): Applies to all U.S.-based refunds.. [optional] # noqa: E501
diff --git a/finix/model/fee_profile_links.py b/finix/model/fee_profile_links.py
index f0446c7..d798ddf 100644
--- a/finix/model/fee_profile_links.py
+++ b/finix/model/fee_profile_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
@@ -87,10 +87,10 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'owner_identity': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'processors': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'owner_identity': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'processors': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'users': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'users': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -148,10 +148,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,10 +234,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/fee_type.py b/finix/model/fee_type.py
index 10b2c8b..cb97a18 100644
--- a/finix/model/fee_type.py
+++ b/finix/model/fee_type.py
@@ -145,10 +145,10 @@ def __init__(self, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] (str): The type of fee.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
+ args[0] (str): Details the type of fee if the `Transfer` includes a `fee`.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
Keyword Args:
- value (str): The type of fee.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
+ value (str): Details the type of fee if the `Transfer` includes a `fee`.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
@@ -235,10 +235,10 @@ def _from_openapi_data(cls, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] (str): The type of fee.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
+ args[0] (str): Details the type of fee if the `Transfer` includes a `fee`.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
Keyword Args:
- value (str): The type of fee.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
+ value (str): Details the type of fee if the `Transfer` includes a `fee`.., must be one of ["APPLICATION_FEE", "ACH_BASIS_POINTS", "ACH_FIXED", "CARD_BASIS_POINTS", "CARD_FIXED", "CARD_INTERCHANGE", "VISA_BASIS_POINTS", "VISA_FIXED", "VISA_INTERCHANGE", "VISA_ASSESSMENT_BASIS_POINTS", "VISA_ACQUIRER_PROCESSING_FIXED", "VISA_CREDIT_VOUCHER_FIXED", "VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED", "VISA_BASE_II_CREDIT_VOUCHER_FIXED", "VISA_KILOBYTE_ACCESS_FIXED", "DISCOVER_BASIS_POINTS", "DISCOVER_FIXED", "DISCOVER_INTERCHANGE", "DISCOVER_ASSESSMENT_BASIS_POINTS", "DISCOVER_DATA_USAGE_FIXED", "DISCOVER_NETWORK_AUTHORIZATION_FIXED", "DINERS_CLUB_BASIS_POINTS", "DINERS_CLUB_FIXED", "DINERS_CLUB_INTERCHANGE", "MASTERCARD_BASIS_POINTS", "MASTERCARD_FIXED", "MASTERCARD_INTERCHANGE", "MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS", "MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS", "MASTERCARD_ACQUIRER_FEE_BASIS_POINTS", "JCB_BASIS_POINTS", "JCB_FIXED", "JCB_INTERCHANGE", "AMERICAN_EXPRESS_BASIS_POINTS", "AMERICAN_EXPRESS_FIXED", "AMERICAN_EXPRESS_INTERCHANGE", "AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS", "DISPUTE_INQUIRY_FIXED_FEE", "DISPUTE_FIXED_FEE", "QUALIFIED_TIER_BASIS_POINTS_FEE", "QUALIFIED_TIER_FIXED_FEE", "CUSTOM", "ACH_DEBIT_RETURN_FIXED_FEE", "ACH_CREDIT_RETURN_FIXED_FEE", "ANCILLARY_FIXED_FEE_PRIMARY", "ANCILLARY_FIXED_FEE_SECONDARY", "SETTLEMENT_V2_TRANSFER", ] # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
diff --git a/finix/model/file.py b/finix/model/file.py
index ed2d99f..67f7dc0 100644
--- a/finix/model/file.py
+++ b/finix/model/file.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class File(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,7 +75,6 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
@@ -93,7 +87,7 @@ def openapi_types():
'linked_type': (str,), # noqa: E501
'platform_id': (str,), # noqa: E501
'status': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
}
@@ -170,7 +164,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
linked_type (str): Autofills to **Merchant**.. [optional] # noqa: E501
platform_id (str): The ID of the `Platform` that the `File` was created under.. [optional] # noqa: E501
status (str): The status of the file's review. The statuses available includes:
- REQUIRES_UPLOAD: A file still needs to be uploaded to the file object.
- PENDING: Finix's underwriting team is still reviewing the uploaded files.
- INVALID: The file couldn't be read.
- UPLOADED: The file has been uploaded to the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): The type of document.. [optional] # noqa: E501
"""
@@ -264,7 +258,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
linked_type (str): Autofills to **Merchant**.. [optional] # noqa: E501
platform_id (str): The ID of the `Platform` that the `File` was created under.. [optional] # noqa: E501
status (str): The status of the file's review. The statuses available includes:
- REQUIRES_UPLOAD: A file still needs to be uploaded to the file object.
- PENDING: Finix's underwriting team is still reviewing the uploaded files.
- INVALID: The file couldn't be read.
- UPLOADED: The file has been uploaded to the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): The type of document.. [optional] # noqa: E501
"""
diff --git a/finix/model/get_device_connection_query_params.py b/finix/model/get_device_connection_query_params.py
new file mode 100644
index 0000000..d8b35d4
--- /dev/null
+++ b/finix/model/get_device_connection_query_params.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class GetDeviceConnectionQueryParams(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'include_connection': (bool,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'include_connection': 'include_connection', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """GetDeviceConnectionQueryParams - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ include_connection (bool): Specifies whether the connection information should be included.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """GetDeviceConnectionQueryParams - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ include_connection (bool): Specifies whether the connection information should be included.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/identity.py b/finix/model/identity.py
index d38e78f..86f615b 100644
--- a/finix/model/identity.py
+++ b/finix/model/identity.py
@@ -31,11 +31,9 @@ def lazy_import():
from finix.model.identity_additional_underwriting_data import IdentityAdditionalUnderwritingData
from finix.model.identity_entity import IdentityEntity
from finix.model.identity_links import IdentityLinks
- from finix.model.tags import Tags
globals()['IdentityAdditionalUnderwritingData'] = IdentityAdditionalUnderwritingData
globals()['IdentityEntity'] = IdentityEntity
globals()['IdentityLinks'] = IdentityLinks
- globals()['Tags'] = Tags
class Identity(ModelNormal):
@@ -100,7 +98,7 @@ def openapi_types():
'additional_underwriting_data': (IdentityAdditionalUnderwritingData,), # noqa: E501
'application': (str,), # noqa: E501
'entity': (IdentityEntity,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (IdentityLinks,), # noqa: E501
}
@@ -167,7 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
additional_underwriting_data (IdentityAdditionalUnderwritingData): [optional] # noqa: E501
application (str): ID of the `Application` associated with the `Identity`.. [optional] # noqa: E501
entity (IdentityEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (IdentityLinks): [optional] # noqa: E501
"""
@@ -256,7 +254,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
additional_underwriting_data (IdentityAdditionalUnderwritingData): [optional] # noqa: E501
application (str): ID of the `Application` associated with the `Identity`.. [optional] # noqa: E501
entity (IdentityEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (IdentityLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/identity_additional_underwriting_data.py b/finix/model/identity_additional_underwriting_data.py
index 7da76d7..58af306 100644
--- a/finix/model/identity_additional_underwriting_data.py
+++ b/finix/model/identity_additional_underwriting_data.py
@@ -195,9 +195,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).. [optional] # noqa: E501
- average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
- average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this seller (max 10 characters).. [optional] # noqa: E501
+ average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this seller.. [optional] # noqa: E501
+ average_card_transfer_amount (int): The average credit card sale amount (in cents) for this seller.. [optional] # noqa: E501
business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
card_volume_distribution (IdentityAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
@@ -208,7 +208,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
merchant_agreement_timestamp (str): Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
merchant_agreement_user_agent (str): The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
- refund_policy (str): Include the value that best applies to the merchant's refund policy.. [optional] # noqa: E501
+ refund_policy (str): Include the value that best applies to the seller's refund policy.. [optional] # noqa: E501
volume_distribution_by_business_type (IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType): [optional] # noqa: E501
"""
@@ -291,9 +291,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).. [optional] # noqa: E501
- average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
- average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this seller (max 10 characters).. [optional] # noqa: E501
+ average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this seller.. [optional] # noqa: E501
+ average_card_transfer_amount (int): The average credit card sale amount (in cents) for this seller.. [optional] # noqa: E501
business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
card_volume_distribution (IdentityAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
@@ -304,7 +304,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
merchant_agreement_timestamp (str): Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
merchant_agreement_user_agent (str): The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
- refund_policy (str): Include the value that best applies to the merchant's refund policy.. [optional] # noqa: E501
+ refund_policy (str): Include the value that best applies to the seller's refund policy.. [optional] # noqa: E501
volume_distribution_by_business_type (IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType): [optional] # noqa: E501
"""
diff --git a/finix/model/identity_entity.py b/finix/model/identity_entity.py
index 1213a1b..0be2a7d 100644
--- a/finix/model/identity_entity.py
+++ b/finix/model/identity_entity.py
@@ -30,11 +30,11 @@
def lazy_import():
from finix.model.identity_entity_business_address import IdentityEntityBusinessAddress
from finix.model.identity_entity_dob import IdentityEntityDob
- from finix.model.identity_entity_incorporation_date import IdentityEntityIncorporationDate
+ from finix.model.identity_entity_form_incorporation_date import IdentityEntityFormIncorporationDate
from finix.model.identity_entity_personal_address import IdentityEntityPersonalAddress
globals()['IdentityEntityBusinessAddress'] = IdentityEntityBusinessAddress
globals()['IdentityEntityDob'] = IdentityEntityDob
- globals()['IdentityEntityIncorporationDate'] = IdentityEntityIncorporationDate
+ globals()['IdentityEntityFormIncorporationDate'] = IdentityEntityFormIncorporationDate
globals()['IdentityEntityPersonalAddress'] = IdentityEntityPersonalAddress
@@ -129,6 +129,7 @@ def openapi_types():
"""
lazy_import()
return {
+ 'amex_mid': (int, none_type,), # noqa: E501
'annual_card_volume': (int, none_type,), # noqa: E501
'business_address': (IdentityEntityBusinessAddress,), # noqa: E501
'business_name': (str, none_type,), # noqa: E501
@@ -142,7 +143,7 @@ def openapi_types():
'email': (str, none_type,), # noqa: E501
'first_name': (str, none_type,), # noqa: E501
'has_accepted_credit_cards_previously': (bool,), # noqa: E501
- 'incorporation_date': (IdentityEntityIncorporationDate,), # noqa: E501
+ 'incorporation_date': (IdentityEntityFormIncorporationDate,), # noqa: E501
'last_name': (str, none_type,), # noqa: E501
'max_transaction_amount': (int, none_type,), # noqa: E501
'mcc': (str, none_type,), # noqa: E501
@@ -163,6 +164,7 @@ def discriminator():
attribute_map = {
+ 'amex_mid': 'amex_mid', # noqa: E501
'annual_card_volume': 'annual_card_volume', # noqa: E501
'business_address': 'business_address', # noqa: E501
'business_name': 'business_name', # noqa: E501
@@ -232,6 +234,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): The merchant's legal business name (max 120 characters).
- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
@@ -245,10 +248,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (IdentityEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
@@ -339,6 +342,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).. [optional] # noqa: E501
business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
business_name (str, none_type): The merchant's legal business name (max 120 characters).
- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
@@ -352,10 +356,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
- incorporation_date (IdentityEntityIncorporationDate): [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
diff --git a/finix/model/identity_entity_form.py b/finix/model/identity_entity_form.py
index d147849..e50bdcb 100644
--- a/finix/model/identity_entity_form.py
+++ b/finix/model/identity_entity_form.py
@@ -75,6 +75,7 @@ class IdentityEntityForm(ModelNormal):
'JOINT_VENTURE': "JOINT_VENTURE",
},
('ownership_type',): {
+ 'None': None,
'PRIVATE': "PRIVATE",
'PUBLIC': "PUBLIC",
},
@@ -145,7 +146,7 @@ def openapi_types():
'incorporation_date': (IdentityEntityFormIncorporationDate,), # noqa: E501
'max_transaction_amount': (int,), # noqa: E501
'mcc': (str,), # noqa: E501
- 'ownership_type': (str,), # noqa: E501
+ 'ownership_type': (str, none_type,), # noqa: E501
'principal_percentage_ownership': (int,), # noqa: E501
'short_business_name': (str,), # noqa: E501
'tax_authority': (str,), # noqa: E501
@@ -245,14 +246,14 @@ def _from_openapi_data(cls, business_address, business_name, business_phone, bus
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
amex_mid (str, none_type): Assigned amex_Mid value. If included must be 10 or 11 digits.. [optional] # noqa: E501
- annual_card_volume (int): Approximate annual credit card sales expected to be processed in cents by this merchant (max 19 characters).. [optional] # noqa: E501
+ annual_card_volume (int): Approximate annual credit card sales expected to be processed in cents by this seller (max 19 characters).. [optional] # noqa: E501
default_statement_descriptor (str): Billing description displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters).. [optional] # noqa: E501
discover_mid (str): Assigned Discover Mid value.. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
max_transaction_amount (int): Maximum amount that can be transacted for a single transaction in cents (max 12 characters).. [optional] # noqa: E501
- mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) the merchant is classified under.. [optional] # noqa: E501
- ownership_type (str): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
principal_percentage_ownership (int): Percentage of company owned by the principal (min 0; max 100).. [optional] # noqa: E501
short_business_name (str): The short version of the business name. (Defaults to **null**).. [optional] # noqa: E501
tax_authority (str): Used and required when onboarding a `Merchant` with a `MCC` of **9311**. The `tax_authority` is the tax gathering entity (e.g San Francisco Water Authority).. [optional] # noqa: E501
@@ -368,14 +369,14 @@ def __init__(self, business_address, business_name, business_phone, business_tax
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
amex_mid (str, none_type): Assigned amex_Mid value. If included must be 10 or 11 digits.. [optional] # noqa: E501
- annual_card_volume (int): Approximate annual credit card sales expected to be processed in cents by this merchant (max 19 characters).. [optional] # noqa: E501
+ annual_card_volume (int): Approximate annual credit card sales expected to be processed in cents by this seller (max 19 characters).. [optional] # noqa: E501
default_statement_descriptor (str): Billing description displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters).. [optional] # noqa: E501
discover_mid (str): Assigned Discover Mid value.. [optional] # noqa: E501
has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
max_transaction_amount (int): Maximum amount that can be transacted for a single transaction in cents (max 12 characters).. [optional] # noqa: E501
- mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) the merchant is classified under.. [optional] # noqa: E501
- ownership_type (str): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
principal_percentage_ownership (int): Percentage of company owned by the principal (min 0; max 100).. [optional] # noqa: E501
short_business_name (str): The short version of the business name. (Defaults to **null**).. [optional] # noqa: E501
tax_authority (str): Used and required when onboarding a `Merchant` with a `MCC` of **9311**. The `tax_authority` is the tax gathering entity (e.g San Francisco Water Authority).. [optional] # noqa: E501
diff --git a/finix/model/identity_entity_form_dob.py b/finix/model/identity_entity_form_dob.py
index 12c68bb..ca1f667 100644
--- a/finix/model/identity_entity_form_dob.py
+++ b/finix/model/identity_entity_form_dob.py
@@ -76,9 +76,9 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'year': (int,), # noqa: E501
'day': (int,), # noqa: E501
'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
}
@cached_property
@@ -87,9 +87,9 @@ def discriminator():
attribute_map = {
- 'year': 'year', # noqa: E501
'day': 'day', # noqa: E501
'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
}
read_only_vars = {
@@ -133,9 +133,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): Year of birth (4-digit).. [optional] # noqa: E501
day (int): Day of birth (between 1 and 31).. [optional] # noqa: E501
month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year of birth (4-digit).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,9 +217,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): Year of birth (4-digit).. [optional] # noqa: E501
day (int): Day of birth (between 1 and 31).. [optional] # noqa: E501
month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year of birth (4-digit).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/identity_entity_form_incorporation_date.py b/finix/model/identity_entity_form_incorporation_date.py
index ab09d01..5480de6 100644
--- a/finix/model/identity_entity_form_incorporation_date.py
+++ b/finix/model/identity_entity_form_incorporation_date.py
@@ -63,7 +63,7 @@ def additional_properties_type():
"""
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
- _nullable = False
+ _nullable = True
@cached_property
def openapi_types():
@@ -76,9 +76,9 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'year': (int,), # noqa: E501
'day': (int,), # noqa: E501
'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
}
@cached_property
@@ -87,9 +87,9 @@ def discriminator():
attribute_map = {
- 'year': 'year', # noqa: E501
'day': 'day', # noqa: E501
'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
}
read_only_vars = {
@@ -133,9 +133,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
day (int): Day business was incorporated (between 1 and 31).. [optional] # noqa: E501
month (int): Month business was incorporated (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,9 +217,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
day (int): Day business was incorporated (between 1 and 31).. [optional] # noqa: E501
month (int): Month business was incorporated (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/l3_additional_purchase_data.py b/finix/model/l3_additional_purchase_data.py
new file mode 100644
index 0000000..7cbc2aa
--- /dev/null
+++ b/finix/model/l3_additional_purchase_data.py
@@ -0,0 +1,330 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.additional_purchase_data_order_date import AdditionalPurchaseDataOrderDate
+ from finix.model.l3_additional_purchase_data_item_data import L3AdditionalPurchaseDataItemData
+ globals()['AdditionalPurchaseDataOrderDate'] = AdditionalPurchaseDataOrderDate
+ globals()['L3AdditionalPurchaseDataItemData'] = L3AdditionalPurchaseDataItemData
+
+
+class L3AdditionalPurchaseData(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('customer_reference_number',): {
+ 'max_length': 17,
+ },
+ ('destination_postal_code',): {
+ 'max_length': 10,
+ },
+ ('invoice_reference_number',): {
+ 'max_length': 15,
+ },
+ ('ship_from_postal_code',): {
+ 'max_length': 10,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'customer_reference_number': (str,), # noqa: E501
+ 'customs_duty_amount': (int,), # noqa: E501
+ 'discount_amount': (int,), # noqa: E501
+ 'item_data': ([L3AdditionalPurchaseDataItemData],), # noqa: E501
+ 'sales_tax': (int,), # noqa: E501
+ 'shipping_amount': (int,), # noqa: E501
+ 'destination_country_code': (str,), # noqa: E501
+ 'destination_postal_code': (str,), # noqa: E501
+ 'invoice_reference_number': (str,), # noqa: E501
+ 'order_date': (AdditionalPurchaseDataOrderDate,), # noqa: E501
+ 'ship_from_postal_code': (str,), # noqa: E501
+ 'tax_exempt': (bool,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'customer_reference_number': 'customer_reference_number', # noqa: E501
+ 'customs_duty_amount': 'customs_duty_amount', # noqa: E501
+ 'discount_amount': 'discount_amount', # noqa: E501
+ 'item_data': 'item_data', # noqa: E501
+ 'sales_tax': 'sales_tax', # noqa: E501
+ 'shipping_amount': 'shipping_amount', # noqa: E501
+ 'destination_country_code': 'destination_country_code', # noqa: E501
+ 'destination_postal_code': 'destination_postal_code', # noqa: E501
+ 'invoice_reference_number': 'invoice_reference_number', # noqa: E501
+ 'order_date': 'order_date', # noqa: E501
+ 'ship_from_postal_code': 'ship_from_postal_code', # noqa: E501
+ 'tax_exempt': 'tax_exempt', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, customer_reference_number, customs_duty_amount, discount_amount, item_data, sales_tax, shipping_amount, *args, **kwargs): # noqa: E501
+ """L3AdditionalPurchaseData - a model defined in OpenAPI
+
+ Args:
+ customer_reference_number (str): The customer reference for the purchase (max 17 characters).
+ customs_duty_amount (int): The duty in cents on the total purchase amount for the order
+ discount_amount (int): The amount in cents of the discount for the order.
+ item_data ([L3AdditionalPurchaseDataItemData]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.
+ sales_tax (int): - Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. - For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**. - Request must align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.e**.
+ shipping_amount (int): The shipping cost in cents for the order.
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ destination_country_code (str): The ISO country code of the order destination.. [optional] # noqa: E501
+ destination_postal_code (str): The postal code of the order destination (10 characters). [optional] # noqa: E501
+ invoice_reference_number (str): The order's invoice number (max 15 characters). [optional] # noqa: E501
+ order_date (AdditionalPurchaseDataOrderDate): [optional] # noqa: E501
+ ship_from_postal_code (str): The postal code from where order is shipped (10 characters). [optional] # noqa: E501
+ tax_exempt (bool): - For tax exempt purchases set to **True**. - If set to **True**, request can't include `sales_tax`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.customer_reference_number = customer_reference_number
+ self.customs_duty_amount = customs_duty_amount
+ self.discount_amount = discount_amount
+ self.item_data = item_data
+ self.sales_tax = sales_tax
+ self.shipping_amount = shipping_amount
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, customer_reference_number, customs_duty_amount, discount_amount, item_data, sales_tax, shipping_amount, *args, **kwargs): # noqa: E501
+ """L3AdditionalPurchaseData - a model defined in OpenAPI
+
+ Args:
+ customer_reference_number (str): The customer reference for the purchase (max 17 characters).
+ customs_duty_amount (int): The duty in cents on the total purchase amount for the order
+ discount_amount (int): The amount in cents of the discount for the order.
+ item_data ([L3AdditionalPurchaseDataItemData]): Additional information about the transaction. Used for Level 2 and Level 3 Processing.
+ sales_tax (int): - Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. - For non-taxable transactions either set `sales_tax` to 0 or omit from payload and also set `tax_exempt` to **True**. - Request must align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.e**.
+ shipping_amount (int): The shipping cost in cents for the order.
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ destination_country_code (str): The ISO country code of the order destination.. [optional] # noqa: E501
+ destination_postal_code (str): The postal code of the order destination (10 characters). [optional] # noqa: E501
+ invoice_reference_number (str): The order's invoice number (max 15 characters). [optional] # noqa: E501
+ order_date (AdditionalPurchaseDataOrderDate): [optional] # noqa: E501
+ ship_from_postal_code (str): The postal code from where order is shipped (10 characters). [optional] # noqa: E501
+ tax_exempt (bool): - For tax exempt purchases set to **True**. - If set to **True**, request can't include `sales_tax`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.customer_reference_number = customer_reference_number
+ self.customs_duty_amount = customs_duty_amount
+ self.discount_amount = discount_amount
+ self.item_data = item_data
+ self.sales_tax = sales_tax
+ self.shipping_amount = shipping_amount
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/l3_additional_purchase_data_item_data.py b/finix/model/l3_additional_purchase_data_item_data.py
new file mode 100644
index 0000000..127c285
--- /dev/null
+++ b/finix/model/l3_additional_purchase_data_item_data.py
@@ -0,0 +1,320 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class L3AdditionalPurchaseDataItemData(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('commodity_code',): {
+ 'max_length': 12,
+ },
+ ('item_description',): {
+ 'max_length': 25,
+ },
+ ('merchant_product_code',): {
+ 'max_length': 12,
+ },
+ ('quantity',): {
+ 'inclusive_maximum': 99,
+ 'inclusive_minimum': 1,
+ },
+ ('unit_of_measure',): {
+ 'max_length': 3,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'amount_excluding_sales_tax': (int,), # noqa: E501
+ 'amount_including_sales_tax': (int,), # noqa: E501
+ 'commodity_code': (str,), # noqa: E501
+ 'cost_per_unit': (int,), # noqa: E501
+ 'item_description': (str,), # noqa: E501
+ 'item_discount_amount': (int,), # noqa: E501
+ 'merchant_product_code': (str,), # noqa: E501
+ 'quantity': (int,), # noqa: E501
+ 'unit_of_measure': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'amount_excluding_sales_tax': 'amount_excluding_sales_tax', # noqa: E501
+ 'amount_including_sales_tax': 'amount_including_sales_tax', # noqa: E501
+ 'commodity_code': 'commodity_code', # noqa: E501
+ 'cost_per_unit': 'cost_per_unit', # noqa: E501
+ 'item_description': 'item_description', # noqa: E501
+ 'item_discount_amount': 'item_discount_amount', # noqa: E501
+ 'merchant_product_code': 'merchant_product_code', # noqa: E501
+ 'quantity': 'quantity', # noqa: E501
+ 'unit_of_measure': 'unit_of_measure', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, amount_excluding_sales_tax, amount_including_sales_tax, commodity_code, cost_per_unit, item_description, item_discount_amount, merchant_product_code, quantity, unit_of_measure, *args, **kwargs): # noqa: E501
+ """L3AdditionalPurchaseDataItemData - a model defined in OpenAPI
+
+ Args:
+ amount_excluding_sales_tax (int): - Total cost of the line item in cents, excluding tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+ amount_including_sales_tax (int): - Total cost of the line item in cents, including tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+ commodity_code (str): A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters).
+ cost_per_unit (int): The price in cents of one unit of the item purchased
+ item_description (str): Required when `item_data` is supplied (max 25 characters)
+ item_discount_amount (int): Item discount amount in cents
+ merchant_product_code (str): Merchant defined product code (max 12 characters).
+ quantity (int): The number of items purchased. Must be greater than 0.
+ unit_of_measure (str): The unit of measure of the purchased item (max 3 characters).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.amount_excluding_sales_tax = amount_excluding_sales_tax
+ self.amount_including_sales_tax = amount_including_sales_tax
+ self.commodity_code = commodity_code
+ self.cost_per_unit = cost_per_unit
+ self.item_description = item_description
+ self.item_discount_amount = item_discount_amount
+ self.merchant_product_code = merchant_product_code
+ self.quantity = quantity
+ self.unit_of_measure = unit_of_measure
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, amount_excluding_sales_tax, amount_including_sales_tax, commodity_code, cost_per_unit, item_description, item_discount_amount, merchant_product_code, quantity, unit_of_measure, *args, **kwargs): # noqa: E501
+ """L3AdditionalPurchaseDataItemData - a model defined in OpenAPI
+
+ Args:
+ amount_excluding_sales_tax (int): - Total cost of the line item in cents, excluding tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+ amount_including_sales_tax (int): - Total cost of the line item in cents, including tax. - Must align with `sales_tax` so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.
+ commodity_code (str): A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters).
+ cost_per_unit (int): The price in cents of one unit of the item purchased
+ item_description (str): Required when `item_data` is supplied (max 25 characters)
+ item_discount_amount (int): Item discount amount in cents
+ merchant_product_code (str): Merchant defined product code (max 12 characters).
+ quantity (int): The number of items purchased. Must be greater than 0.
+ unit_of_measure (str): The unit of measure of the purchased item (max 3 characters).
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.amount_excluding_sales_tax = amount_excluding_sales_tax
+ self.amount_including_sales_tax = amount_including_sales_tax
+ self.commodity_code = commodity_code
+ self.cost_per_unit = cost_per_unit
+ self.item_description = item_description
+ self.item_discount_amount = item_discount_amount
+ self.merchant_product_code = merchant_product_code
+ self.quantity = quantity
+ self.unit_of_measure = unit_of_measure
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/list_authorizations_query_params.py b/finix/model/list_authorizations_query_params.py
index 5ffe38a..120f2e0 100644
--- a/finix/model/list_authorizations_query_params.py
+++ b/finix/model/list_authorizations_query_params.py
@@ -76,17 +76,20 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'amount': (int,), # noqa: E501
'amount_gt': (int,), # noqa: E501
'amount_gte': (int,), # noqa: E501
'amount_lt': (int,), # noqa: E501
'amount_lte': (int,), # noqa: E501
'before_cursor': (str,), # noqa: E501
+ 'after_cursor': (str,), # noqa: E501
'created_at_gte': (str,), # noqa: E501
'created_at_lte': (str,), # noqa: E501
'idempotency_id': (str,), # noqa: E501
'limit': (int,), # noqa: E501
- 'sort': (str,), # noqa: E501
+ 'tags_key': (str,), # noqa: E501
+ 'tags_value': (str,), # noqa: E501
'state': (str,), # noqa: E501
'updated_at_gte': (str,), # noqa: E501
'updated_at_lte': (str,), # noqa: E501
@@ -104,7 +107,7 @@ def openapi_types():
'instrument_card_last4': (str,), # noqa: E501
'merchant_processor_id': (str,), # noqa: E501
'type': (str,), # noqa: E501
- 'after_cursor': (str,), # noqa: E501
+ 'finix_version': (str,), # noqa: E501
}
@cached_property
@@ -113,17 +116,20 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'amount': 'amount', # noqa: E501
'amount_gt': 'amount.gt', # noqa: E501
'amount_gte': 'amount.gte', # noqa: E501
'amount_lt': 'amount.lt', # noqa: E501
'amount_lte': 'amount.lte', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
+ 'after_cursor': 'after_cursor', # noqa: E501
'created_at_gte': 'created_at.gte', # noqa: E501
'created_at_lte': 'created_at.lte', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
'limit': 'limit', # noqa: E501
- 'sort': 'sort', # noqa: E501
+ 'tags_key': 'tags.key', # noqa: E501
+ 'tags_value': 'tags.value', # noqa: E501
'state': 'state', # noqa: E501
'updated_at_gte': 'updated_at.gte', # noqa: E501
'updated_at_lte': 'updated_at.lte', # noqa: E501
@@ -141,7 +147,7 @@ def discriminator():
'instrument_card_last4': 'instrument_card_last4', # noqa: E501
'merchant_processor_id': 'merchant_processor_id', # noqa: E501
'type': 'type', # noqa: E501
- 'after_cursor': 'after_cursor', # noqa: E501
+ 'finix_version': 'Finix-Version', # noqa: E501
}
read_only_vars = {
@@ -185,17 +191,20 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
amount_lte (int): Filter by an amount less than or equal.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
idempotency_id (str): Filter by `idempotency_id`.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
state (str): Filter by Transaction state.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
@@ -213,7 +222,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
instrument_card_last4 (str): Filter by the payment card last 4 digits.. [optional] # noqa: E501
merchant_processor_id (str): Filter by `Processor` ID.. [optional] # noqa: E501
type (str): Type of the `Authorization`.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -295,17 +304,20 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
amount_lte (int): Filter by an amount less than or equal.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
idempotency_id (str): Filter by `idempotency_id`.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
state (str): Filter by Transaction state.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
@@ -323,7 +335,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
instrument_card_last4 (str): Filter by the payment card last 4 digits.. [optional] # noqa: E501
merchant_processor_id (str): Filter by `Processor` ID.. [optional] # noqa: E501
type (str): Type of the `Authorization`.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
+ finix_version (str): Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_balance_transfers_query_params.py b/finix/model/list_balance_transfers_query_params.py
index 32d8390..ccc3ff5 100644
--- a/finix/model/list_balance_transfers_query_params.py
+++ b/finix/model/list_balance_transfers_query_params.py
@@ -77,7 +77,6 @@ def openapi_types():
"""
return {
'limit': (int,), # noqa: E501
- 'offset': (int,), # noqa: E501
'page_number': (int,), # noqa: E501
'page_size': (int,), # noqa: E501
'created_at_gte': (str,), # noqa: E501
@@ -100,7 +99,6 @@ def discriminator():
attribute_map = {
'limit': 'limit', # noqa: E501
- 'offset': 'offset', # noqa: E501
'page_number': 'pageNumber', # noqa: E501
'page_size': 'pageSize', # noqa: E501
'created_at_gte': 'created_at.gte', # noqa: E501
@@ -158,7 +156,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
limit (int): The numbers of items to return.. [optional] # noqa: E501
- offset (int): The number of items to skip before starting to collect the result set.. [optional] # noqa: E501
page_number (int): The page number to list.. [optional] # noqa: E501
page_size (int): The size of the page.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
@@ -254,7 +251,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
limit (int): The numbers of items to return.. [optional] # noqa: E501
- offset (int): The number of items to skip before starting to collect the result set.. [optional] # noqa: E501
page_number (int): The page number to list.. [optional] # noqa: E501
page_size (int): The size of the page.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
diff --git a/finix/model/list_disputes_query_params.py b/finix/model/list_disputes_query_params.py
index e22a4bc..fb00a06 100644
--- a/finix/model/list_disputes_query_params.py
+++ b/finix/model/list_disputes_query_params.py
@@ -76,13 +76,36 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'sort': (str,), # noqa: E501
- 'offset': (int,), # noqa: E501
+ 'accept': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'created_at_gte': (str,), # noqa: E501
'created_at_lte': (str,), # noqa: E501
'updated_at_gte': (str,), # noqa: E501
'updated_at_lte': (str,), # noqa: E501
+ 'transfer_id': (str,), # noqa: E501
+ 'adjustment_transfer_id': (str,), # noqa: E501
+ 'amount': (int,), # noqa: E501
+ 'amount_gte': (int,), # noqa: E501
+ 'amount_gt': (int,), # noqa: E501
+ 'amount_lt': (int,), # noqa: E501
+ 'state': (str,), # noqa: E501
+ 'response_state': (str,), # noqa: E501
+ 'respond_by_lte': (str,), # noqa: E501
+ 'respond_by_gte': (str,), # noqa: E501
+ 'instrument_bin': (str,), # noqa: E501
+ 'instrument_brand_type': (str,), # noqa: E501
+ 'merchant_identity_id': (str,), # noqa: E501
+ 'merchant_identity_name': (str,), # noqa: E501
+ 'instrument_name': (str,), # noqa: E501
+ 'instrument_type': (str,), # noqa: E501
+ 'merchant_id': (str,), # noqa: E501
+ 'merchant_mid': (str,), # noqa: E501
+ 'instrument_card_last4': (str,), # noqa: E501
+ 'instrument_card_type': (str,), # noqa: E501
+ 'instrument_fingerprint': (str,), # noqa: E501
+ 'before_cursor': (str,), # noqa: E501
+ 'tags_key': (str,), # noqa: E501
+ 'tags_value': (str,), # noqa: E501
}
@cached_property
@@ -91,13 +114,36 @@ def discriminator():
attribute_map = {
- 'sort': 'sort', # noqa: E501
- 'offset': 'offset', # noqa: E501
+ 'accept': 'Accept', # noqa: E501
'limit': 'limit', # noqa: E501
'created_at_gte': 'created_at.gte', # noqa: E501
'created_at_lte': 'created_at.lte', # noqa: E501
'updated_at_gte': 'updated_at.gte', # noqa: E501
'updated_at_lte': 'updated_at.lte', # noqa: E501
+ 'transfer_id': 'transfer_id', # noqa: E501
+ 'adjustment_transfer_id': 'adjustment_transfer_id', # noqa: E501
+ 'amount': 'amount', # noqa: E501
+ 'amount_gte': 'amount.gte', # noqa: E501
+ 'amount_gt': 'amount.gt', # noqa: E501
+ 'amount_lt': 'amount.lt', # noqa: E501
+ 'state': 'state', # noqa: E501
+ 'response_state': 'response_state', # noqa: E501
+ 'respond_by_lte': 'respond_by.lte', # noqa: E501
+ 'respond_by_gte': 'respond_by.gte', # noqa: E501
+ 'instrument_bin': 'instrument_bin', # noqa: E501
+ 'instrument_brand_type': 'instrument_brand_type', # noqa: E501
+ 'merchant_identity_id': 'merchant_identity_id', # noqa: E501
+ 'merchant_identity_name': 'merchant_identity_name', # noqa: E501
+ 'instrument_name': 'instrument_name', # noqa: E501
+ 'instrument_type': 'instrument_type', # noqa: E501
+ 'merchant_id': 'merchant_id', # noqa: E501
+ 'merchant_mid': 'merchant_mid', # noqa: E501
+ 'instrument_card_last4': 'instrument_card_last4', # noqa: E501
+ 'instrument_card_type': 'instrument_card_type', # noqa: E501
+ 'instrument_fingerprint': 'instrument_fingerprint', # noqa: E501
+ 'before_cursor': 'before_cursor', # noqa: E501
+ 'tags_key': 'tags.key', # noqa: E501
+ 'tags_value': 'tags.value', # noqa: E501
}
read_only_vars = {
@@ -141,13 +187,36 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
- offset (int): The number of items to skip before starting to collect the result set.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
+ transfer_id (str): Filter by the ID of the `Transfer` that's being disputed.
**Note**: If included, all other filter parameters are ignored.. [optional] # noqa: E501
+ adjustment_transfer_id (str): Filter by the ID of the adjustment `Transfer`.
**Note**: If included, all other filter parameters are ignored.. [optional] # noqa: E501
+ amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
+ amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
+ amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
+ amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
+ state (str): Filter by the state of the `Dispute`.. [optional] # noqa: E501
+ response_state (str): Filter by the `response_state` of the `Dispute`.. [optional] # noqa: E501
+ respond_by_lte (str): Filter where `respond_by` is before the given date.. [optional] # noqa: E501
+ respond_by_gte (str): Filter where `respond_by` is after the given date.. [optional] # noqa: E501
+ instrument_bin (str): Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number.. [optional] # noqa: E501
+ instrument_brand_type (str): Filter by the card brand used.. [optional] # noqa: E501
+ merchant_identity_id (str): Filter by the ID of the `Identity` used by the `Merchant`.. [optional] # noqa: E501
+ merchant_identity_name (str): Filter by the name used by the `Merchant`.. [optional] # noqa: E501
+ instrument_name (str): Filter by the name of the `Payment Instrument`.. [optional] # noqa: E501
+ instrument_type (str): Filter by `Payment Instrument` type.. [optional] # noqa: E501
+ merchant_id (str): Filter by the ID of the `Merchant`.. [optional] # noqa: E501
+ merchant_mid (str): Filter by the MID of the `Merchant`.. [optional] # noqa: E501
+ instrument_card_last4 (str): Filter by the last 4 digits of the card used.. [optional] # noqa: E501
+ instrument_card_type (str): Filter by the card type.. [optional] # noqa: E501
+ instrument_fingerprint (str): Filter by the fingerprint of the `Payment Instrument`.. [optional] # noqa: E501
+ before_cursor (str): Returns every `Dispute` created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,13 +298,36 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
- offset (int): The number of items to skip before starting to collect the result set.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
+ transfer_id (str): Filter by the ID of the `Transfer` that's being disputed.
**Note**: If included, all other filter parameters are ignored.. [optional] # noqa: E501
+ adjustment_transfer_id (str): Filter by the ID of the adjustment `Transfer`.
**Note**: If included, all other filter parameters are ignored.. [optional] # noqa: E501
+ amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
+ amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
+ amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
+ amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
+ state (str): Filter by the state of the `Dispute`.. [optional] # noqa: E501
+ response_state (str): Filter by the `response_state` of the `Dispute`.. [optional] # noqa: E501
+ respond_by_lte (str): Filter where `respond_by` is before the given date.. [optional] # noqa: E501
+ respond_by_gte (str): Filter where `respond_by` is after the given date.. [optional] # noqa: E501
+ instrument_bin (str): Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number.. [optional] # noqa: E501
+ instrument_brand_type (str): Filter by the card brand used.. [optional] # noqa: E501
+ merchant_identity_id (str): Filter by the ID of the `Identity` used by the `Merchant`.. [optional] # noqa: E501
+ merchant_identity_name (str): Filter by the name used by the `Merchant`.. [optional] # noqa: E501
+ instrument_name (str): Filter by the name of the `Payment Instrument`.. [optional] # noqa: E501
+ instrument_type (str): Filter by `Payment Instrument` type.. [optional] # noqa: E501
+ merchant_id (str): Filter by the ID of the `Merchant`.. [optional] # noqa: E501
+ merchant_mid (str): Filter by the MID of the `Merchant`.. [optional] # noqa: E501
+ instrument_card_last4 (str): Filter by the last 4 digits of the card used.. [optional] # noqa: E501
+ instrument_card_type (str): Filter by the card type.. [optional] # noqa: E501
+ instrument_fingerprint (str): Filter by the fingerprint of the `Payment Instrument`.. [optional] # noqa: E501
+ before_cursor (str): Returns every `Dispute` created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_external_links_query_params.py b/finix/model/list_external_links_query_params.py
index 4a6fd79..f4a69a8 100644
--- a/finix/model/list_external_links_query_params.py
+++ b/finix/model/list_external_links_query_params.py
@@ -76,7 +76,6 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'sort': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'id': (str,), # noqa: E501
@@ -93,7 +92,6 @@ def discriminator():
attribute_map = {
- 'sort': 'sort', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
'id': 'id', # noqa: E501
@@ -145,7 +143,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
@@ -235,7 +232,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
diff --git a/finix/model/list_fee_profiles_query_params.py b/finix/model/list_fee_profiles_query_params.py
index 5762771..07a2777 100644
--- a/finix/model/list_fee_profiles_query_params.py
+++ b/finix/model/list_fee_profiles_query_params.py
@@ -76,6 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
@@ -87,6 +88,7 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
@@ -133,6 +135,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
@@ -217,6 +220,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
diff --git a/finix/model/list_files_query_params.py b/finix/model/list_files_query_params.py
index 3ee52a0..8ba223f 100644
--- a/finix/model/list_files_query_params.py
+++ b/finix/model/list_files_query_params.py
@@ -76,7 +76,6 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'sort': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'id': (str,), # noqa: E501
@@ -93,7 +92,6 @@ def discriminator():
attribute_map = {
- 'sort': 'sort', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
'id': 'id', # noqa: E501
@@ -145,7 +143,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
@@ -235,7 +232,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
diff --git a/finix/model/list_identities_query_params.py b/finix/model/list_identities_query_params.py
index 6ed03e0..e599075 100644
--- a/finix/model/list_identities_query_params.py
+++ b/finix/model/list_identities_query_params.py
@@ -76,7 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'sort': (str,), # noqa: E501
+ 'accept': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'id': (str,), # noqa: E501
@@ -90,6 +90,8 @@ def openapi_types():
'last_name': (str,), # noqa: E501
'title': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
+ 'tags_key': (str,), # noqa: E501
+ 'tags_value': (str,), # noqa: E501
}
@cached_property
@@ -98,7 +100,7 @@ def discriminator():
attribute_map = {
- 'sort': 'sort', # noqa: E501
+ 'accept': 'Accept', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
'id': 'id', # noqa: E501
@@ -112,6 +114,8 @@ def discriminator():
'last_name': 'last_name', # noqa: E501
'title': 'title', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
+ 'tags_key': 'tags.key', # noqa: E501
+ 'tags_value': 'tags.value', # noqa: E501
}
read_only_vars = {
@@ -155,7 +159,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
@@ -169,6 +173,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
last_name (str): Filter by the last name of the person associated to the `Identity`.. [optional] # noqa: E501
title (str): Filter by the title if available.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -250,7 +256,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
@@ -264,6 +270,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
last_name (str): Filter by the last name of the person associated to the `Identity`.. [optional] # noqa: E501
title (str): Filter by the title if available.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_merchant_profiles_query_params.py b/finix/model/list_merchant_profiles_query_params.py
index 414e1ff..2dda2a9 100644
--- a/finix/model/list_merchant_profiles_query_params.py
+++ b/finix/model/list_merchant_profiles_query_params.py
@@ -76,6 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'id': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
@@ -88,6 +89,7 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'id': 'id', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
@@ -135,6 +137,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
@@ -220,6 +223,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
diff --git a/finix/model/list_merchants_query_params.py b/finix/model/list_merchants_query_params.py
index 8ffc9c4..7f8e01d 100644
--- a/finix/model/list_merchants_query_params.py
+++ b/finix/model/list_merchants_query_params.py
@@ -76,13 +76,15 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'id': (str,), # noqa: E501
- 'created_at_gte': (str,), # noqa: E501
- 'created_at_lte': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
+ 'created_at_gte': (str,), # noqa: E501
+ 'created_at_lte': (str,), # noqa: E501
'limit': (int,), # noqa: E501
- 'sort': (str,), # noqa: E501
+ 'updated_at_gte': (str,), # noqa: E501
+ 'updated_at_lte': (str,), # noqa: E501
}
@cached_property
@@ -91,13 +93,15 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'id': 'id', # noqa: E501
- 'created_at_gte': 'created_at.gte', # noqa: E501
- 'created_at_lte': 'created_at.lte', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
+ 'created_at_gte': 'created_at.gte', # noqa: E501
+ 'created_at_lte': 'created_at.lte', # noqa: E501
'limit': 'limit', # noqa: E501
- 'sort': 'sort', # noqa: E501
+ 'updated_at_gte': 'updated_at.gte', # noqa: E501
+ 'updated_at_lte': 'updated_at.lte', # noqa: E501
}
read_only_vars = {
@@ -141,13 +145,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
- created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
- created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
+ created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
+ updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,13 +235,15 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
- created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
- created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
+ created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
+ updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_payment_instruments_query_params.py b/finix/model/list_payment_instruments_query_params.py
index e7450d9..88828a8 100644
--- a/finix/model/list_payment_instruments_query_params.py
+++ b/finix/model/list_payment_instruments_query_params.py
@@ -76,6 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'account_last4': (str,), # noqa: E501
'account_routing_number': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
@@ -86,11 +87,13 @@ def openapi_types():
'created_at_lte': (str,), # noqa: E501
'expiration_month': (str,), # noqa: E501
'expiration_year': (str,), # noqa: E501
- 'last_four': (str,), # noqa: E501
+ 'last4': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'name': (str,), # noqa: E501
'owner_identity_id': (str,), # noqa: E501
'type': (str,), # noqa: E501
+ 'tags_key': (str,), # noqa: E501
+ 'tags_value': (str,), # noqa: E501
}
@cached_property
@@ -99,6 +102,7 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'account_last4': 'account_last4', # noqa: E501
'account_routing_number': 'account_routing_number', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
@@ -109,11 +113,13 @@ def discriminator():
'created_at_lte': 'created_at.lte', # noqa: E501
'expiration_month': 'expiration_month', # noqa: E501
'expiration_year': 'expiration_year', # noqa: E501
- 'last_four': 'last_four', # noqa: E501
+ 'last4': 'last4', # noqa: E501
'limit': 'limit', # noqa: E501
'name': 'name', # noqa: E501
'owner_identity_id': 'owner_identity_id', # noqa: E501
'type': 'type', # noqa: E501
+ 'tags_key': 'tags.key', # noqa: E501
+ 'tags_value': 'tags.value', # noqa: E501
}
read_only_vars = {
@@ -157,6 +163,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
account_last4 (str): Filter by the last 4 digits of the account if available.. [optional] # noqa: E501
account_routing_number (str): Filter by the account routing number if available.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
@@ -167,11 +174,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
expiration_month (str): Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards.. [optional] # noqa: E501
expiration_year (str): Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.. [optional] # noqa: E501
- last_four (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional] # noqa: E501
+ last4 (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
name (str): Filter by the name.. [optional] # noqa: E501
owner_identity_id (str): Filter by the owner id of the associated `Identity`.. [optional] # noqa: E501
type (str): Filter by the `Payment Instrument` type.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -253,6 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
account_last4 (str): Filter by the last 4 digits of the account if available.. [optional] # noqa: E501
account_routing_number (str): Filter by the account routing number if available.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
@@ -263,11 +273,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
expiration_month (str): Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards.. [optional] # noqa: E501
expiration_year (str): Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.. [optional] # noqa: E501
- last_four (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional] # noqa: E501
+ last4 (str): Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
name (str): Filter by the name.. [optional] # noqa: E501
owner_identity_id (str): Filter by the owner id of the associated `Identity`.. [optional] # noqa: E501
type (str): Filter by the `Payment Instrument` type.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_payoutprofiles_query_params.py b/finix/model/list_payoutprofiles_query_params.py
new file mode 100644
index 0000000..601a7ea
--- /dev/null
+++ b/finix/model/list_payoutprofiles_query_params.py
@@ -0,0 +1,254 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class ListPayoutprofilesQueryParams(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'after_cursor': (str,), # noqa: E501
+ 'limit': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'after_cursor': 'after_cursor', # noqa: E501
+ 'limit': 'limit', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """ListPayoutprofilesQueryParams - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
+ limit (int): The numbers of items to return.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """ListPayoutprofilesQueryParams - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
+ limit (int): The numbers of items to return.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/list_settlement_funding_transfers_query_params.py b/finix/model/list_settlement_funding_transfers_query_params.py
index f2d766b..3823f6f 100644
--- a/finix/model/list_settlement_funding_transfers_query_params.py
+++ b/finix/model/list_settlement_funding_transfers_query_params.py
@@ -76,9 +76,8 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'limit': (int,), # noqa: E501
- 'after_cursor': (str,), # noqa: E501
- 'before_cursor': (str,), # noqa: E501
}
@cached_property
@@ -87,9 +86,8 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'limit': 'limit', # noqa: E501
- 'after_cursor': 'after_cursor', # noqa: E501
- 'before_cursor': 'before_cursor', # noqa: E501
}
read_only_vars = {
@@ -133,9 +131,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,9 +214,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_settlement_transfers_query_params.py b/finix/model/list_settlement_transfers_query_params.py
index 6685c79..1200edb 100644
--- a/finix/model/list_settlement_transfers_query_params.py
+++ b/finix/model/list_settlement_transfers_query_params.py
@@ -77,8 +77,6 @@ def openapi_types():
"""
return {
'limit': (int,), # noqa: E501
- 'after_cursor': (str,), # noqa: E501
- 'before_cursor': (str,), # noqa: E501
}
@cached_property
@@ -88,8 +86,6 @@ def discriminator():
attribute_map = {
'limit': 'limit', # noqa: E501
- 'after_cursor': 'after_cursor', # noqa: E501
- 'before_cursor': 'before_cursor', # noqa: E501
}
read_only_vars = {
@@ -134,8 +130,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -218,8 +212,6 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_settlements_query_params.py b/finix/model/list_settlements_query_params.py
index b97046a..3512db5 100644
--- a/finix/model/list_settlements_query_params.py
+++ b/finix/model/list_settlements_query_params.py
@@ -78,12 +78,15 @@ def openapi_types():
return {
'created_at_gte': (str,), # noqa: E501
'created_at_lte': (str,), # noqa: E501
- 'updated_at_gte': (str,), # noqa: E501
- 'updated_at_lte': (str,), # noqa: E501
- 'id': (str,), # noqa: E501
- 'limit': (int,), # noqa: E501
- 'after_cursor': (str,), # noqa: E501
- 'before_cursor': (str,), # noqa: E501
+ 'amount': (int,), # noqa: E501
+ 'amount_gt': (int,), # noqa: E501
+ 'amount_gte': (int,), # noqa: E501
+ 'amount_lt': (int,), # noqa: E501
+ 'amount_lte': (int,), # noqa: E501
+ 'status': (str,), # noqa: E501
+ 'transfer_id': (str,), # noqa: E501
+ 'funding_transfer_id': (str,), # noqa: E501
+ 'accept': (str,), # noqa: E501
}
@cached_property
@@ -94,12 +97,15 @@ def discriminator():
attribute_map = {
'created_at_gte': 'created_at.gte', # noqa: E501
'created_at_lte': 'created_at.lte', # noqa: E501
- 'updated_at_gte': 'updated_at.gte', # noqa: E501
- 'updated_at_lte': 'updated_at.lte', # noqa: E501
- 'id': 'id', # noqa: E501
- 'limit': 'limit', # noqa: E501
- 'after_cursor': 'after_cursor', # noqa: E501
- 'before_cursor': 'before_cursor', # noqa: E501
+ 'amount': 'amount', # noqa: E501
+ 'amount_gt': 'amount.gt', # noqa: E501
+ 'amount_gte': 'amount.gte', # noqa: E501
+ 'amount_lt': 'amount.lt', # noqa: E501
+ 'amount_lte': 'amount.lte', # noqa: E501
+ 'status': 'status', # noqa: E501
+ 'transfer_id': 'transfer_id', # noqa: E501
+ 'funding_transfer_id': 'funding_transfer_id', # noqa: E501
+ 'accept': 'Accept', # noqa: E501
}
read_only_vars = {
@@ -145,12 +151,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
- updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
- updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
- id (str): Filter by `id`.. [optional] # noqa: E501
- limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
+ amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
+ amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
+ amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
+ amount_lte (int): Filter by an amount less than or equal.. [optional] # noqa: E501
+ status (str): Filter by the status of the `Settlement`. Available values include:- **PENDING**
- **STAGED**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED**. For more information, see [Payouts](/docs/guides/payouts/payouts/).. [optional] # noqa: E501
+ transfer_id (str): Filter by a `transfer_id` a `Settlement` has accrued. Please note this filter is only available for non-versioned requests, or requests using `-H 'Finix-Version: 2018-01-01'`. We're actively working on making this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
+ funding_transfer_id (str): Filter by a `funding_transfer` a `Settlement` has created.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,12 +243,15 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
created_at_gte (str): Filter where `created_at` is after the given date.. [optional] # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
- updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
- updated_at_lte (str): Filter where `updated_at` is before the given date.. [optional] # noqa: E501
- id (str): Filter by `id`.. [optional] # noqa: E501
- limit (int): The numbers of items to return.. [optional] # noqa: E501
- after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
- before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
+ amount_gt (int): Filter by an amount greater than.. [optional] # noqa: E501
+ amount_gte (int): Filter by an amount greater than or equal.. [optional] # noqa: E501
+ amount_lt (int): Filter by an amount less than.. [optional] # noqa: E501
+ amount_lte (int): Filter by an amount less than or equal.. [optional] # noqa: E501
+ status (str): Filter by the status of the `Settlement`. Available values include:- **PENDING**
- **STAGED**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED**. For more information, see [Payouts](/docs/guides/payouts/payouts/).. [optional] # noqa: E501
+ transfer_id (str): Filter by a `transfer_id` a `Settlement` has accrued. Please note this filter is only available for non-versioned requests, or requests using `-H 'Finix-Version: 2018-01-01'`. We're actively working on making this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
+ funding_transfer_id (str): Filter by a `funding_transfer` a `Settlement` has created.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_transfer_reversals_query_params.py b/finix/model/list_transfer_reversals_query_params.py
index 6555e88..61e7573 100644
--- a/finix/model/list_transfer_reversals_query_params.py
+++ b/finix/model/list_transfer_reversals_query_params.py
@@ -76,6 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
@@ -87,6 +88,7 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'limit': 'limit', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
@@ -133,6 +135,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The number of entries to return.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
@@ -217,6 +220,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The number of entries to return.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
diff --git a/finix/model/list_transfers_query_params.py b/finix/model/list_transfers_query_params.py
index 313bc97..c41331f 100644
--- a/finix/model/list_transfers_query_params.py
+++ b/finix/model/list_transfers_query_params.py
@@ -76,7 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'sort': (str,), # noqa: E501
+ 'accept': (str,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'amount': (int,), # noqa: E501
@@ -88,9 +88,9 @@ def openapi_types():
'created_at_lte': (str,), # noqa: E501
'idempotency_id': (str,), # noqa: E501
'id': (str,), # noqa: E501
- 'state': (str,), # noqa: E501
'ready_to_settle_at_gte': (str,), # noqa: E501
'ready_to_settle_at_lte': (str,), # noqa: E501
+ 'state': (str,), # noqa: E501
'statement_descriptor': (int,), # noqa: E501
'trace_id': (str,), # noqa: E501
'updated_at_gte': (str,), # noqa: E501
@@ -108,6 +108,8 @@ def openapi_types():
'merchant_processor_id': (str,), # noqa: E501
'type': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
+ 'tags_key': (str,), # noqa: E501
+ 'tags_value': (str,), # noqa: E501
}
@cached_property
@@ -116,7 +118,7 @@ def discriminator():
attribute_map = {
- 'sort': 'sort', # noqa: E501
+ 'accept': 'Accept', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'limit': 'limit', # noqa: E501
'amount': 'amount', # noqa: E501
@@ -128,9 +130,9 @@ def discriminator():
'created_at_lte': 'created_at.lte', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
'id': 'id', # noqa: E501
- 'state': 'state', # noqa: E501
'ready_to_settle_at_gte': 'ready_to_settle_at.gte', # noqa: E501
'ready_to_settle_at_lte': 'ready_to_settle_at.lte', # noqa: E501
+ 'state': 'state', # noqa: E501
'statement_descriptor': 'statement_descriptor', # noqa: E501
'trace_id': 'trace_id', # noqa: E501
'updated_at_gte': 'updated_at.gte', # noqa: E501
@@ -148,6 +150,8 @@ def discriminator():
'merchant_processor_id': 'merchant_processor_id', # noqa: E501
'type': 'type', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
+ 'tags_key': 'tags.key', # noqa: E501
+ 'tags_value': 'tags.value', # noqa: E501
}
read_only_vars = {
@@ -191,7 +195,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
@@ -203,9 +207,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
idempotency_id (str): Filter by `idempotency_id`.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
+ ready_to_settle_at_gte (str): Filter where `ready_to_settle_at` is after the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
+ ready_to_settle_at_lte (str): Filter where `ready_to_settle_at` is before the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
state (str): Filter by Transaction state.. [optional] # noqa: E501
- ready_to_settle_at_gte (str): Filter by `ready_to_settle_at`.. [optional] # noqa: E501
- ready_to_settle_at_lte (str): Filter by `ready_to_settle_at`.. [optional] # noqa: E501
statement_descriptor (int): Filter by `statement_descriptor`.. [optional] # noqa: E501
trace_id (str): Filter by `trace_id`.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
@@ -223,6 +227,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
merchant_processor_id (str): Filter by `Processor` ID.. [optional] # noqa: E501
type (str): Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -304,7 +310,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- sort (str): Specify key to be used for sorting the collection.. [optional] # noqa: E501
+ accept (str): Body Header. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
amount (int): Filter by an amount equal to the given value.. [optional] # noqa: E501
@@ -316,9 +322,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
created_at_lte (str): Filter where `created_at` is before the given date.. [optional] # noqa: E501
idempotency_id (str): Filter by `idempotency_id`.. [optional] # noqa: E501
id (str): Filter by `id`.. [optional] # noqa: E501
+ ready_to_settle_at_gte (str): Filter where `ready_to_settle_at` is after the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
+ ready_to_settle_at_lte (str): Filter where `ready_to_settle_at` is before the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).. [optional] # noqa: E501
state (str): Filter by Transaction state.. [optional] # noqa: E501
- ready_to_settle_at_gte (str): Filter by `ready_to_settle_at`.. [optional] # noqa: E501
- ready_to_settle_at_lte (str): Filter by `ready_to_settle_at`.. [optional] # noqa: E501
statement_descriptor (int): Filter by `statement_descriptor`.. [optional] # noqa: E501
trace_id (str): Filter by `trace_id`.. [optional] # noqa: E501
updated_at_gte (str): Filter where `updated_at` is after the given date.. [optional] # noqa: E501
@@ -336,6 +342,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
merchant_processor_id (str): Filter by `Processor` ID.. [optional] # noqa: E501
type (str): Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
+ tags_key (str): Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).. [optional] # noqa: E501
+ tags_value (str): Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/list_verifications_query_params.py b/finix/model/list_verifications_query_params.py
index 1dea4e5..3db1716 100644
--- a/finix/model/list_verifications_query_params.py
+++ b/finix/model/list_verifications_query_params.py
@@ -76,6 +76,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'accept': (str,), # noqa: E501
'limit': (int,), # noqa: E501
'after_cursor': (str,), # noqa: E501
'before_cursor': (str,), # noqa: E501
@@ -87,6 +88,7 @@ def discriminator():
attribute_map = {
+ 'accept': 'Accept', # noqa: E501
'limit': 'limit', # noqa: E501
'after_cursor': 'after_cursor', # noqa: E501
'before_cursor': 'before_cursor', # noqa: E501
@@ -133,6 +135,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
@@ -217,6 +220,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ accept (str): Body Header. [optional] # noqa: E501
limit (int): The numbers of items to return.. [optional] # noqa: E501
after_cursor (str): Return every resource created after the cursor value.. [optional] # noqa: E501
before_cursor (str): Return every resource created before the cursor value.. [optional] # noqa: E501
diff --git a/finix/model/merchant.py b/finix/model/merchant.py
index 81478ef..6773a7f 100644
--- a/finix/model/merchant.py
+++ b/finix/model/merchant.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.merchant_links import MerchantLinks
from finix.model.merchant_processor_details import MerchantProcessorDetails
- from finix.model.tags import Tags
globals()['MerchantLinks'] = MerchantLinks
globals()['MerchantProcessorDetails'] = MerchantProcessorDetails
- globals()['Tags'] = Tags
class Merchant(ModelNormal):
@@ -58,11 +56,27 @@ class Merchant(ModelNormal):
"""
allowed_values = {
+ ('gateway',): {
+ 'None': None,
+ 'TRIPOS_MOBILE_V1': "TRIPOS_MOBILE_V1",
+ 'TRIPOS_CLOUD_V1': "TRIPOS_CLOUD_V1",
+ 'DATACAP_V1': "DATACAP_V1",
+ },
('onboarding_state',): {
'PROVISIONING': "PROVISIONING",
'APPROVED': "APPROVED",
'REJECTED': "REJECTED",
},
+ ('ready_to_settle_upon',): {
+ 'RECONCILIATION': "RECONCILIATION",
+ 'SUCCESSFUL_CAPTURE': "SUCCESSFUL_CAPTURE",
+ 'PROCESSOR_WINDOW': "PROCESSOR_WINDOW",
+ },
+ ('settlement_funding_identifier',): {
+ 'UNSET': "UNSET",
+ 'MID_AND_DATE': "MID_AND_DATE",
+ 'MID_AND_MERCHANT_NAME': "MID_AND_MERCHANT_NAME",
+ },
}
validations = {
@@ -100,6 +114,7 @@ def openapi_types():
'creating_transfer_from_report_enabled': (bool,), # noqa: E501
'convenience_charges_enabled': (bool,), # noqa: E501
'fee_ready_to_settle_upon': (str,), # noqa: E501
+ 'gateway': (str, none_type,), # noqa: E501
'gross_settlement_enabled': (bool,), # noqa: E501
'identity': (str,), # noqa: E501
'level_two_level_three_data_enabled': (bool,), # noqa: E501
@@ -115,7 +130,8 @@ def openapi_types():
'rent_surcharges_enabled': (bool,), # noqa: E501
'settlement_enabled': (bool,), # noqa: E501
'settlement_funding_identifier': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'surcharges_enabled': (bool,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'verification': (str,), # noqa: E501
'links': (MerchantLinks,), # noqa: E501
}
@@ -135,6 +151,7 @@ def discriminator():
'creating_transfer_from_report_enabled': 'creating_transfer_from_report_enabled', # noqa: E501
'convenience_charges_enabled': 'convenience_charges_enabled', # noqa: E501
'fee_ready_to_settle_upon': 'fee_ready_to_settle_upon', # noqa: E501
+ 'gateway': 'gateway', # noqa: E501
'gross_settlement_enabled': 'gross_settlement_enabled', # noqa: E501
'identity': 'identity', # noqa: E501
'level_two_level_three_data_enabled': 'level_two_level_three_data_enabled', # noqa: E501
@@ -150,6 +167,7 @@ def discriminator():
'rent_surcharges_enabled': 'rent_surcharges_enabled', # noqa: E501
'settlement_enabled': 'settlement_enabled', # noqa: E501
'settlement_funding_identifier': 'settlement_funding_identifier', # noqa: E501
+ 'surcharges_enabled': 'surcharges_enabled', # noqa: E501
'tags': 'tags', # noqa: E501
'verification': 'verification', # noqa: E501
'links': '_links', # noqa: E501
@@ -196,7 +214,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Merchant` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): ID of the `Application` the `Merchant` was created under.. [optional] # noqa: E501
@@ -205,10 +223,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
creating_transfer_from_report_enabled (bool): Set to **true** to automatically create `Transfers` once settlement reports get generated.. [optional] # noqa: E501
convenience_charges_enabled (bool): Set to **true** if you want to enable the `Merchant` to accept convenience fees and/or service fees.. [optional] # noqa: E501
fee_ready_to_settle_upon (str): Details how the `Merchant` settles fees.. [optional] # noqa: E501
+ gateway (str, none_type): Name of the gateway that routes the `Merchant's` transactions to the processor.. [optional] # noqa: E501
gross_settlement_enabled (bool): Set to **true** to enable gross settlements.. [optional] # noqa: E501
identity (str): The ID of the `Identity` resource associated with the `Merchant`.. [optional] # noqa: E501
level_two_level_three_data_enabled (bool): Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
merchant_name (str): The legal name saved in the `Merchant` resource.. [optional] # noqa: E501
merchant_profile (str): Details if a merchant's info was submitted to third-party processors for provisioning.. [optional] # noqa: E501
mid (str, none_type): MID of the `Merchant`.. [optional] # noqa: E501
@@ -216,11 +235,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
processor (str): Name of the transaction processor.. [optional] # noqa: E501
processor_details (MerchantProcessorDetails): [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Merchant`.. [optional] # noqa: E501
- ready_to_settle_upon (str): Details how `Authorizations` captured by the `Merchant` are settled.. [optional] # noqa: E501
+ ready_to_settle_upon (str): Details how transactions captured by the `Merchant` are settled.. [optional] # noqa: E501
rent_surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept rent charges.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Merchant`.. [optional] # noqa: E501
- settlement_funding_identifier (str): Include addtional information (like the MID) when submitting funding `Tranfers` to processors.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept surcharge fees. For more details, see [Buyer Charges](/guides/payments/modify/buyer-charges/).. [optional] if omitted the server will use the default value of False # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
verification (str): ID of the `Verification` that was submitted to verify the `Merchant`.. [optional] # noqa: E501
links (MerchantLinks): [optional] # noqa: E501
"""
@@ -304,7 +324,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Merchant` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): ID of the `Application` the `Merchant` was created under.. [optional] # noqa: E501
@@ -313,10 +333,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
creating_transfer_from_report_enabled (bool): Set to **true** to automatically create `Transfers` once settlement reports get generated.. [optional] # noqa: E501
convenience_charges_enabled (bool): Set to **true** if you want to enable the `Merchant` to accept convenience fees and/or service fees.. [optional] # noqa: E501
fee_ready_to_settle_upon (str): Details how the `Merchant` settles fees.. [optional] # noqa: E501
+ gateway (str, none_type): Name of the gateway that routes the `Merchant's` transactions to the processor.. [optional] # noqa: E501
gross_settlement_enabled (bool): Set to **true** to enable gross settlements.. [optional] # noqa: E501
identity (str): The ID of the `Identity` resource associated with the `Merchant`.. [optional] # noqa: E501
level_two_level_three_data_enabled (bool): Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.. [optional] # noqa: E501
- mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) that this merchant will be classified under.. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
merchant_name (str): The legal name saved in the `Merchant` resource.. [optional] # noqa: E501
merchant_profile (str): Details if a merchant's info was submitted to third-party processors for provisioning.. [optional] # noqa: E501
mid (str, none_type): MID of the `Merchant`.. [optional] # noqa: E501
@@ -324,11 +345,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
processor (str): Name of the transaction processor.. [optional] # noqa: E501
processor_details (MerchantProcessorDetails): [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Merchant`.. [optional] # noqa: E501
- ready_to_settle_upon (str): Details how `Authorizations` captured by the `Merchant` are settled.. [optional] # noqa: E501
+ ready_to_settle_upon (str): Details how transactions captured by the `Merchant` are settled.. [optional] # noqa: E501
rent_surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept rent charges.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Merchant`.. [optional] # noqa: E501
- settlement_funding_identifier (str): Include addtional information (like the MID) when submitting funding `Tranfers` to processors.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept surcharge fees. For more details, see [Buyer Charges](/guides/payments/modify/buyer-charges/).. [optional] if omitted the server will use the default value of False # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
verification (str): ID of the `Verification` that was submitted to verify the `Merchant`.. [optional] # noqa: E501
links (MerchantLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/merchant_profile.py b/finix/model/merchant_profile.py
index abdfee9..a835f45 100644
--- a/finix/model/merchant_profile.py
+++ b/finix/model/merchant_profile.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.merchant_profile_links import MerchantProfileLinks
- from finix.model.tags import Tags
globals()['MerchantProfileLinks'] = MerchantProfileLinks
- globals()['Tags'] = Tags
class MerchantProfile(ModelNormal):
@@ -84,13 +82,14 @@ def openapi_types():
"""
lazy_import()
return {
- 'id': (str, none_type,), # noqa: E501
+ 'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'application': (str,), # noqa: E501
'fee_profile': (str, none_type,), # noqa: E501
+ 'payout_profile': (str, none_type,), # noqa: E501
'risk_profile': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (MerchantProfileLinks,), # noqa: E501
}
@@ -105,6 +104,7 @@ def discriminator():
'updated_at': 'updated_at', # noqa: E501
'application': 'application', # noqa: E501
'fee_profile': 'fee_profile', # noqa: E501
+ 'payout_profile': 'payout_profile', # noqa: E501
'risk_profile': 'risk_profile', # noqa: E501
'tags': 'tags', # noqa: E501
'links': '_links', # noqa: E501
@@ -151,13 +151,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Merchant Profile` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
- fee_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- risk_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ application (str): The ID of the `Application` associated with the `Merchant Profile`.. [optional] # noqa: E501
+ fee_profile (str, none_type): The ID of the `Fee Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ payout_profile (str, none_type): The ID of the `Payout Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ risk_profile (str, none_type): The ID of the `Risk Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (MerchantProfileLinks): [optional] # noqa: E501
"""
@@ -240,13 +241,14 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Merchant Profile` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
- fee_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- risk_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ application (str): The ID of the `Application` associated with the `Merchant Profile`.. [optional] # noqa: E501
+ fee_profile (str, none_type): The ID of the `Fee Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ payout_profile (str, none_type): The ID of the `Payout Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ risk_profile (str, none_type): The ID of the `Risk Profile` associated with the `Merchant Profile` resource.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (MerchantProfileLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/merchant_profile_links.py b/finix/model/merchant_profile_links.py
index f2c8757..d1a1961 100644
--- a/finix/model/merchant_profile_links.py
+++ b/finix/model/merchant_profile_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
@@ -87,13 +87,13 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'fee_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'owner_identity': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'processors': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'reserve_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'risk_profile': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'fee_profile': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'owner_identity': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'processors': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'reserve_profile': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'risk_profile': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'users': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'users': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -154,13 +154,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- fee_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reserve_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- risk_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ fee_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reserve_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ risk_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -243,13 +243,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- fee_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- owner_identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- processors (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reserve_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- risk_profile (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ fee_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ owner_identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ processors (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reserve_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ risk_profile (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- users (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ users (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/messages.py b/finix/model/messages.py
index 793a9c3..3fd1e82 100644
--- a/finix/model/messages.py
+++ b/finix/model/messages.py
@@ -53,7 +53,7 @@ class Messages(ModelSimple):
additional_properties_type = None
- _nullable = False
+ _nullable = True
@cached_property
def openapi_types():
@@ -66,7 +66,7 @@ def openapi_types():
and the value is attribute type.
"""
return {
- 'value': ([str],),
+ 'value': ([str], none_type,),
}
@cached_property
@@ -96,10 +96,10 @@ def __init__(self, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] ([str]): Message field that provides additional details. This field is typically **null**.. # noqa: E501
+ args[0] ([str], none_type): Message field that provides additional details. This field is typically **null**.. # noqa: E501
Keyword Args:
- value ([str]): Message field that provides additional details. This field is typically **null**.. # noqa: E501
+ value ([str], none_type): Message field that provides additional details. This field is typically **null**.. # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
@@ -186,10 +186,10 @@ def _from_openapi_data(cls, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] ([str]): Message field that provides additional details. This field is typically **null**.. # noqa: E501
+ args[0] ([str], none_type): Message field that provides additional details. This field is typically **null**.. # noqa: E501
Keyword Args:
- value ([str]): Message field that provides additional details. This field is typically **null**.. # noqa: E501
+ value ([str], none_type): Message field that provides additional details. This field is typically **null**.. # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
diff --git a/finix/model/onboarding_form.py b/finix/model/onboarding_form.py
index 255a262..8780ea5 100644
--- a/finix/model/onboarding_form.py
+++ b/finix/model/onboarding_form.py
@@ -28,14 +28,12 @@
def lazy_import():
- from finix.model.create_onboarding_form_request_merchant_processors_inner import CreateOnboardingFormRequestMerchantProcessorsInner
+ from finix.model.create_onboarding_form_request_merchant_processors import CreateOnboardingFormRequestMerchantProcessors
from finix.model.onboarding_form_onboarding_data import OnboardingFormOnboardingData
from finix.model.onboarding_form_onboarding_link import OnboardingFormOnboardingLink
- from finix.model.tags import Tags
- globals()['CreateOnboardingFormRequestMerchantProcessorsInner'] = CreateOnboardingFormRequestMerchantProcessorsInner
+ globals()['CreateOnboardingFormRequestMerchantProcessors'] = CreateOnboardingFormRequestMerchantProcessors
globals()['OnboardingFormOnboardingData'] = OnboardingFormOnboardingData
globals()['OnboardingFormOnboardingLink'] = OnboardingFormOnboardingLink
- globals()['Tags'] = Tags
class OnboardingForm(ModelNormal):
@@ -93,13 +91,13 @@ def openapi_types():
lazy_import()
return {
'id': (str,), # noqa: E501
+ 'created_at': (datetime,), # noqa: E501
+ 'updated_at': (datetime,), # noqa: E501
+ 'merchant_processors': ([CreateOnboardingFormRequestMerchantProcessors],), # noqa: E501
'onboarding_data': (OnboardingFormOnboardingData,), # noqa: E501
- 'merchant_processors': ([CreateOnboardingFormRequestMerchantProcessorsInner],), # noqa: E501
'onboarding_link': (OnboardingFormOnboardingLink,), # noqa: E501
'status': (str,), # noqa: E501
- 'created_at': (datetime,), # noqa: E501
- 'updated_at': (datetime,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -109,12 +107,12 @@ def discriminator():
attribute_map = {
'id': 'id', # noqa: E501
- 'onboarding_data': 'onboarding_data', # noqa: E501
+ 'created_at': 'created_at', # noqa: E501
+ 'updated_at': 'updated_at', # noqa: E501
'merchant_processors': 'merchant_processors', # noqa: E501
+ 'onboarding_data': 'onboarding_data', # noqa: E501
'onboarding_link': 'onboarding_link', # noqa: E501
'status': 'status', # noqa: E501
- 'created_at': 'created_at', # noqa: E501
- 'updated_at': 'updated_at', # noqa: E501
'tags': 'tags', # noqa: E501
}
@@ -160,13 +158,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
id (str): The ID of the `onboarding_form` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ merchant_processors ([CreateOnboardingFormRequestMerchantProcessors]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_data (OnboardingFormOnboardingData): [optional] # noqa: E501
- merchant_processors ([CreateOnboardingFormRequestMerchantProcessorsInner]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_link (OnboardingFormOnboardingLink): [optional] # noqa: E501
status (str): Status of the `onboarding_from`.. [optional] # noqa: E501
- created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
- updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -249,13 +247,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
id (str): The ID of the `onboarding_form` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ merchant_processors ([CreateOnboardingFormRequestMerchantProcessors]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_data (OnboardingFormOnboardingData): [optional] # noqa: E501
- merchant_processors ([CreateOnboardingFormRequestMerchantProcessorsInner]): An array of objects with the processors and gateways users will be onboarded to.. [optional] # noqa: E501
onboarding_link (OnboardingFormOnboardingLink): [optional] # noqa: E501
status (str): Status of the `onboarding_from`.. [optional] # noqa: E501
- created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
- updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/onboarding_form_onboarding_data.py b/finix/model/onboarding_form_onboarding_data.py
index 17f2ddd..7b1c8d5 100644
--- a/finix/model/onboarding_form_onboarding_data.py
+++ b/finix/model/onboarding_form_onboarding_data.py
@@ -27,6 +27,16 @@
from finix.exceptions import ApiAttributeError
+def lazy_import():
+ from finix.model.create_associated_identity_request_entity import CreateAssociatedIdentityRequestEntity
+ from finix.model.onboarding_form_onboarding_data_additional_underwriting_data import OnboardingFormOnboardingDataAdditionalUnderwritingData
+ from finix.model.onboarding_form_onboarding_data_entity import OnboardingFormOnboardingDataEntity
+ from finix.model.onboarding_form_onboarding_data_payment_instruments import OnboardingFormOnboardingDataPaymentInstruments
+ globals()['CreateAssociatedIdentityRequestEntity'] = CreateAssociatedIdentityRequestEntity
+ globals()['OnboardingFormOnboardingDataAdditionalUnderwritingData'] = OnboardingFormOnboardingDataAdditionalUnderwritingData
+ globals()['OnboardingFormOnboardingDataEntity'] = OnboardingFormOnboardingDataEntity
+ globals()['OnboardingFormOnboardingDataPaymentInstruments'] = OnboardingFormOnboardingDataPaymentInstruments
+
class OnboardingFormOnboardingData(ModelNormal):
"""
@@ -61,6 +71,7 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
+ lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -75,11 +86,12 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
+ lazy_import()
return {
- 'entity': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
- 'associated_entities': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
- 'payment_instruments': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
- 'additional_underwriting_data': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
+ 'additional_underwriting_data': (OnboardingFormOnboardingDataAdditionalUnderwritingData,), # noqa: E501
+ 'associated_entities': ([CreateAssociatedIdentityRequestEntity],), # noqa: E501
+ 'entity': (OnboardingFormOnboardingDataEntity,), # noqa: E501
+ 'payment_instruments': (OnboardingFormOnboardingDataPaymentInstruments,), # noqa: E501
'max_transaction_amount': (int,), # noqa: E501
}
@@ -89,10 +101,10 @@ def discriminator():
attribute_map = {
- 'entity': 'entity', # noqa: E501
+ 'additional_underwriting_data': 'additional_underwriting_data', # noqa: E501
'associated_entities': 'associated_entities', # noqa: E501
+ 'entity': 'entity', # noqa: E501
'payment_instruments': 'payment_instruments', # noqa: E501
- 'additional_underwriting_data': 'additional_underwriting_data', # noqa: E501
'max_transaction_amount': 'max_transaction_amount', # noqa: E501
}
@@ -137,10 +149,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- entity ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The `entity` information saved in the `Identity` of the user.. [optional] # noqa: E501
- associated_entities ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): The `entities` saved in the `associated_identities` of the user. For more information, see [Create an Associated Identity](/api/#operation/createAssociatedIdentity).. [optional] # noqa: E501
- payment_instruments ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The `Payment Instrument` that'll be used to payout the user. For more information, see [Payouts](/guides/payouts).. [optional] # noqa: E501
- additional_underwriting_data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional underwriting data about the user.. [optional] # noqa: E501
+ additional_underwriting_data (OnboardingFormOnboardingDataAdditionalUnderwritingData): [optional] # noqa: E501
+ associated_entities ([CreateAssociatedIdentityRequestEntity]): The `entities` saved in the `associated_identities` of the user. For more information, see [Create an Associated Identity](/guides/onboarding/onboarding-form/#prefilling-fields).. [optional] # noqa: E501
+ entity (OnboardingFormOnboardingDataEntity): [optional] # noqa: E501
+ payment_instruments (OnboardingFormOnboardingDataPaymentInstruments): [optional] # noqa: E501
max_transaction_amount (int): Maximum amount that can be transacted for a single transaction in cents (max 12 characters). Must be equal to or less than your `max_transaction_amount`.. [optional] # noqa: E501
"""
@@ -223,10 +235,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- entity ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The `entity` information saved in the `Identity` of the user.. [optional] # noqa: E501
- associated_entities ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): The `entities` saved in the `associated_identities` of the user. For more information, see [Create an Associated Identity](/api/#operation/createAssociatedIdentity).. [optional] # noqa: E501
- payment_instruments ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The `Payment Instrument` that'll be used to payout the user. For more information, see [Payouts](/guides/payouts).. [optional] # noqa: E501
- additional_underwriting_data ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional underwriting data about the user.. [optional] # noqa: E501
+ additional_underwriting_data (OnboardingFormOnboardingDataAdditionalUnderwritingData): [optional] # noqa: E501
+ associated_entities ([CreateAssociatedIdentityRequestEntity]): The `entities` saved in the `associated_identities` of the user. For more information, see [Create an Associated Identity](/guides/onboarding/onboarding-form/#prefilling-fields).. [optional] # noqa: E501
+ entity (OnboardingFormOnboardingDataEntity): [optional] # noqa: E501
+ payment_instruments (OnboardingFormOnboardingDataPaymentInstruments): [optional] # noqa: E501
max_transaction_amount (int): Maximum amount that can be transacted for a single transaction in cents (max 12 characters). Must be equal to or less than your `max_transaction_amount`.. [optional] # noqa: E501
"""
diff --git a/finix/model/onboarding_form_onboarding_data_additional_underwriting_data.py b/finix/model/onboarding_form_onboarding_data_additional_underwriting_data.py
new file mode 100644
index 0000000..e3f1369
--- /dev/null
+++ b/finix/model/onboarding_form_onboarding_data_additional_underwriting_data.py
@@ -0,0 +1,344 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.identity_additional_underwriting_data_card_volume_distribution import IdentityAdditionalUnderwritingDataCardVolumeDistribution
+ from finix.model.identity_additional_underwriting_data_volume_distribution_by_business_type import IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType
+ globals()['IdentityAdditionalUnderwritingDataCardVolumeDistribution'] = IdentityAdditionalUnderwritingDataCardVolumeDistribution
+ globals()['IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType'] = IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType
+
+
+class OnboardingFormOnboardingDataAdditionalUnderwritingData(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('refund_policy',): {
+ 'NO_REFUNDS': "NO_REFUNDS",
+ 'MERCHANDISE_EXCHANGE_ONLY': "MERCHANDISE_EXCHANGE_ONLY",
+ 'WITHIN_30_DAYS': "WITHIN_30_DAYS",
+ 'OTHER': "OTHER",
+ },
+ }
+
+ validations = {
+ ('business_description',): {
+ 'min_length': 1,
+ },
+ ('credit_check_ip_address',): {
+ 'min_length': 1,
+ },
+ ('credit_check_timestamp',): {
+ 'min_length': 1,
+ },
+ ('credit_check_user_agent',): {
+ 'min_length': 1,
+ },
+ ('merchant_agreement_ip_address',): {
+ 'min_length': 1,
+ },
+ ('merchant_agreement_timestamp',): {
+ 'min_length': 1,
+ },
+ ('merchant_agreement_user_agent',): {
+ 'min_length': 1,
+ },
+ ('refund_policy',): {
+ 'min_length': 1,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'annual_ach_volume': (int,), # noqa: E501
+ 'average_ach_transfer_amount': (int,), # noqa: E501
+ 'average_card_transfer_amount': (int,), # noqa: E501
+ 'business_description': (str,), # noqa: E501
+ 'card_volume_distribution': (IdentityAdditionalUnderwritingDataCardVolumeDistribution,), # noqa: E501
+ 'credit_check_allowed': (bool,), # noqa: E501
+ 'credit_check_ip_address': (str,), # noqa: E501
+ 'credit_check_timestamp': (str,), # noqa: E501
+ 'credit_check_user_agent': (str,), # noqa: E501
+ 'merchant_agreement_accepted': (bool,), # noqa: E501
+ 'merchant_agreement_ip_address': (str,), # noqa: E501
+ 'merchant_agreement_timestamp': (str,), # noqa: E501
+ 'merchant_agreement_user_agent': (str,), # noqa: E501
+ 'refund_policy': (str,), # noqa: E501
+ 'volume_distribution_by_business_type': (IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'annual_ach_volume': 'annual_ach_volume', # noqa: E501
+ 'average_ach_transfer_amount': 'average_ach_transfer_amount', # noqa: E501
+ 'average_card_transfer_amount': 'average_card_transfer_amount', # noqa: E501
+ 'business_description': 'business_description', # noqa: E501
+ 'card_volume_distribution': 'card_volume_distribution', # noqa: E501
+ 'credit_check_allowed': 'credit_check_allowed', # noqa: E501
+ 'credit_check_ip_address': 'credit_check_ip_address', # noqa: E501
+ 'credit_check_timestamp': 'credit_check_timestamp', # noqa: E501
+ 'credit_check_user_agent': 'credit_check_user_agent', # noqa: E501
+ 'merchant_agreement_accepted': 'merchant_agreement_accepted', # noqa: E501
+ 'merchant_agreement_ip_address': 'merchant_agreement_ip_address', # noqa: E501
+ 'merchant_agreement_timestamp': 'merchant_agreement_timestamp', # noqa: E501
+ 'merchant_agreement_user_agent': 'merchant_agreement_user_agent', # noqa: E501
+ 'refund_policy': 'refund_policy', # noqa: E501
+ 'volume_distribution_by_business_type': 'volume_distribution_by_business_type', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataAdditionalUnderwritingData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).. [optional] # noqa: E501
+ average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
+ card_volume_distribution (IdentityAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
+ credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
+ credit_check_ip_address (str): The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 ).. [optional] # noqa: E501
+ credit_check_timestamp (str): A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
+ credit_check_user_agent (str): The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
+ merchant_agreement_accepted (bool): Sets whether this merchant has accepted the terms and conditions of the merchant agreement.. [optional] # noqa: E501
+ merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
+ merchant_agreement_timestamp (str): Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
+ merchant_agreement_user_agent (str): The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
+ refund_policy (str): Include the value that best applies to the merchant's refund policy.. [optional] # noqa: E501
+ volume_distribution_by_business_type (IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataAdditionalUnderwritingData - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ annual_ach_volume (int): The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).. [optional] # noqa: E501
+ average_ach_transfer_amount (int): The approximate average ACH sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ average_card_transfer_amount (int): The average credit card sale amount (in cents) for this merchant.. [optional] # noqa: E501
+ business_description (str): Description of this merchant's business (max 200 characters).. [optional] # noqa: E501
+ card_volume_distribution (IdentityAdditionalUnderwritingDataCardVolumeDistribution): [optional] # noqa: E501
+ credit_check_allowed (bool): Sets if this merchant has consented and accepted to a credit check.. [optional] # noqa: E501
+ credit_check_ip_address (str): The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 ).. [optional] # noqa: E501
+ credit_check_timestamp (str): A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
+ credit_check_user_agent (str): The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
+ merchant_agreement_accepted (bool): Sets whether this merchant has accepted the terms and conditions of the merchant agreement.. [optional] # noqa: E501
+ merchant_agreement_ip_address (str): IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).. [optional] # noqa: E501
+ merchant_agreement_timestamp (str): Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z).. [optional] # noqa: E501
+ merchant_agreement_user_agent (str): The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).. [optional] # noqa: E501
+ refund_policy (str): Include the value that best applies to the merchant's refund policy.. [optional] # noqa: E501
+ volume_distribution_by_business_type (IdentityAdditionalUnderwritingDataVolumeDistributionByBusinessType): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/onboarding_form_onboarding_data_entity.py b/finix/model/onboarding_form_onboarding_data_entity.py
new file mode 100644
index 0000000..89b8c98
--- /dev/null
+++ b/finix/model/onboarding_form_onboarding_data_entity.py
@@ -0,0 +1,407 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.identity_entity_business_address import IdentityEntityBusinessAddress
+ from finix.model.identity_entity_dob import IdentityEntityDob
+ from finix.model.identity_entity_personal_address import IdentityEntityPersonalAddress
+ from finix.model.onboarding_form_onboarding_data_entity_incorporation_date import OnboardingFormOnboardingDataEntityIncorporationDate
+ globals()['IdentityEntityBusinessAddress'] = IdentityEntityBusinessAddress
+ globals()['IdentityEntityDob'] = IdentityEntityDob
+ globals()['IdentityEntityPersonalAddress'] = IdentityEntityPersonalAddress
+ globals()['OnboardingFormOnboardingDataEntityIncorporationDate'] = OnboardingFormOnboardingDataEntityIncorporationDate
+
+
+class OnboardingFormOnboardingDataEntity(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('ownership_type',): {
+ 'None': None,
+ 'PUBLIC': "PUBLIC",
+ 'PRIVATE': "PRIVATE",
+ },
+ }
+
+ validations = {
+ ('business_name',): {
+ 'min_length': 1,
+ },
+ ('business_phone',): {
+ 'min_length': 1,
+ },
+ ('default_statement_descriptor',): {
+ 'min_length': 1,
+ },
+ ('doing_business_as',): {
+ 'min_length': 1,
+ },
+ ('email',): {
+ 'min_length': 1,
+ },
+ ('first_name',): {
+ 'min_length': 1,
+ },
+ ('last_name',): {
+ 'min_length': 1,
+ },
+ ('mcc',): {
+ 'min_length': 1,
+ },
+ ('ownership_type',): {
+ 'min_length': 1,
+ },
+ ('phone',): {
+ 'min_length': 1,
+ },
+ ('title',): {
+ 'min_length': 1,
+ },
+ ('url',): {
+ 'min_length': 1,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'amex_mid': (int, none_type,), # noqa: E501
+ 'annual_card_volume': (int, none_type,), # noqa: E501
+ 'business_address': (IdentityEntityBusinessAddress,), # noqa: E501
+ 'business_name': (str, none_type,), # noqa: E501
+ 'business_phone': (str, none_type,), # noqa: E501
+ 'business_tax_id_provided': (bool,), # noqa: E501
+ 'business_type': (str, none_type,), # noqa: E501
+ 'default_statement_descriptor': (str, none_type,), # noqa: E501
+ 'discover_mid': (int, none_type,), # noqa: E501
+ 'dob': (IdentityEntityDob,), # noqa: E501
+ 'doing_business_as': (str, none_type,), # noqa: E501
+ 'email': (str, none_type,), # noqa: E501
+ 'first_name': (str, none_type,), # noqa: E501
+ 'has_accepted_credit_cards_previously': (bool,), # noqa: E501
+ 'incorporation_date': (OnboardingFormOnboardingDataEntityIncorporationDate,), # noqa: E501
+ 'last_name': (str, none_type,), # noqa: E501
+ 'max_transaction_amount': (int, none_type,), # noqa: E501
+ 'mcc': (str, none_type,), # noqa: E501
+ 'ownership_type': (str, none_type,), # noqa: E501
+ 'personal_address': (IdentityEntityPersonalAddress,), # noqa: E501
+ 'phone': (str, none_type,), # noqa: E501
+ 'principal_percentage_ownership': (int, none_type,), # noqa: E501
+ 'short_business_name': (str, none_type,), # noqa: E501
+ 'tax_authority': (str, none_type,), # noqa: E501
+ 'tax_id_provided': (bool,), # noqa: E501
+ 'title': (str, none_type,), # noqa: E501
+ 'url': (str, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'amex_mid': 'amex_mid', # noqa: E501
+ 'annual_card_volume': 'annual_card_volume', # noqa: E501
+ 'business_address': 'business_address', # noqa: E501
+ 'business_name': 'business_name', # noqa: E501
+ 'business_phone': 'business_phone', # noqa: E501
+ 'business_tax_id_provided': 'business_tax_id_provided', # noqa: E501
+ 'business_type': 'business_type', # noqa: E501
+ 'default_statement_descriptor': 'default_statement_descriptor', # noqa: E501
+ 'discover_mid': 'discover_mid', # noqa: E501
+ 'dob': 'dob', # noqa: E501
+ 'doing_business_as': 'doing_business_as', # noqa: E501
+ 'email': 'email', # noqa: E501
+ 'first_name': 'first_name', # noqa: E501
+ 'has_accepted_credit_cards_previously': 'has_accepted_credit_cards_previously', # noqa: E501
+ 'incorporation_date': 'incorporation_date', # noqa: E501
+ 'last_name': 'last_name', # noqa: E501
+ 'max_transaction_amount': 'max_transaction_amount', # noqa: E501
+ 'mcc': 'mcc', # noqa: E501
+ 'ownership_type': 'ownership_type', # noqa: E501
+ 'personal_address': 'personal_address', # noqa: E501
+ 'phone': 'phone', # noqa: E501
+ 'principal_percentage_ownership': 'principal_percentage_ownership', # noqa: E501
+ 'short_business_name': 'short_business_name', # noqa: E501
+ 'tax_authority': 'tax_authority', # noqa: E501
+ 'tax_id_provided': 'tax_id_provided', # noqa: E501
+ 'title': 'title', # noqa: E501
+ 'url': 'url', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataEntity - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
+ annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this seller (max 19 characters).. [optional] # noqa: E501
+ business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
+ business_name (str, none_type): The merchant's legal business name (max 120 characters).- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
+ business_phone (str, none_type): Customer service phone number where the seller can be reached (max 10 characters).. [optional] # noqa: E501
+ business_tax_id_provided (bool): Details if the `business_tax_id` was provided.. [optional] # noqa: E501
+ business_type (str, none_type): Include the value that best applies to the seller.. [optional] # noqa: E501
+ default_statement_descriptor (str, none_type): The description of the seller that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ discover_mid (int, none_type): Assigned discoverMid value.. [optional] # noqa: E501
+ dob (IdentityEntityDob): [optional] # noqa: E501
+ doing_business_as (str, none_type): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).. [optional] # noqa: E501
+ email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
+ first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
+ incorporation_date (OnboardingFormOnboardingDataEntityIncorporationDate): [optional] # noqa: E501
+ last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
+ max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
+ phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
+ principal_percentage_ownership (int, none_type): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
+ short_business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
+ tax_authority (str, none_type):
- Only required when onboarding a seller with a MCC of 9311.
- The tax_authority is the tax gathering entity (e.g San Francisco Water Authority).. [optional] # noqa: E501
+ tax_id_provided (bool): Details if the `tax_id` was provided.. [optional] # noqa: E501
+ title (str, none_type): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
+ url (str, none_type): The URL of the merchant's public website.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataEntity - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ amex_mid (int, none_type): Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.. [optional] # noqa: E501
+ annual_card_volume (int, none_type): The annual credit card sales (in cents) expected to be processed by this seller (max 19 characters).. [optional] # noqa: E501
+ business_address (IdentityEntityBusinessAddress): [optional] # noqa: E501
+ business_name (str, none_type): The merchant's legal business name (max 120 characters).
- If INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's legal first name, last name and middle initial.. [optional] # noqa: E501
+ business_phone (str, none_type): Customer service phone number where the seller can be reached (max 10 characters).. [optional] # noqa: E501
+ business_tax_id_provided (bool): Details if the `business_tax_id` was provided.. [optional] # noqa: E501
+ business_type (str, none_type): Include the value that best applies to the seller.. [optional] # noqa: E501
+ default_statement_descriptor (str, none_type): The description of the seller that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ discover_mid (int, none_type): Assigned discoverMid value.. [optional] # noqa: E501
+ dob (IdentityEntityDob): [optional] # noqa: E501
+ doing_business_as (str, none_type): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).. [optional] # noqa: E501
+ email (str, none_type): The email address of the principal control owner where they can be reached (max 100 characters).. [optional] # noqa: E501
+ first_name (str, none_type): The legal first name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
+ incorporation_date (OnboardingFormOnboardingDataEntityIncorporationDate): [optional] # noqa: E501
+ last_name (str, none_type): The legal last name of the merchant's control owner (max 20 characters).. [optional] # noqa: E501
+ max_transaction_amount (int, none_type): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
+ mcc (str, none_type): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
+ personal_address (IdentityEntityPersonalAddress): [optional] # noqa: E501
+ phone (str, none_type): The principal control owner's phone number (max 10 characters).. [optional] # noqa: E501
+ principal_percentage_ownership (int, none_type): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
+ short_business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
+ tax_authority (str, none_type):
- Only required when onboarding a seller with a MCC of 9311.
- The tax_authority is the tax gathering entity (e.g San Francisco Water Authority).. [optional] # noqa: E501
+ tax_id_provided (bool): Details if the `tax_id` was provided.. [optional] # noqa: E501
+ title (str, none_type): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
+ url (str, none_type): The URL of the merchant's public website.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/onboarding_form_onboarding_data_entity_incorporation_date.py b/finix/model/onboarding_form_onboarding_data_entity_incorporation_date.py
new file mode 100644
index 0000000..f76c288
--- /dev/null
+++ b/finix/model/onboarding_form_onboarding_data_entity_incorporation_date.py
@@ -0,0 +1,258 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class OnboardingFormOnboardingDataEntityIncorporationDate(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day': (int,), # noqa: E501
+ 'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day': 'day', # noqa: E501
+ 'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataEntityIncorporationDate - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day (int): Day business was incorporated (between 1 and 31).. [optional] # noqa: E501
+ month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataEntityIncorporationDate - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day (int): Day business was incorporated (between 1 and 31).. [optional] # noqa: E501
+ month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year business was incorporated (4-digit).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/onboarding_form_onboarding_data_payment_instruments.py b/finix/model/onboarding_form_onboarding_data_payment_instruments.py
new file mode 100644
index 0000000..4492ce2
--- /dev/null
+++ b/finix/model/onboarding_form_onboarding_data_payment_instruments.py
@@ -0,0 +1,283 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class OnboardingFormOnboardingDataPaymentInstruments(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('attempt_bank_account_validation_check',): {
+ 'CHECKING': "CHECKING",
+ 'SAVINGS': "SAVINGS",
+ 'PERSONAL_CHECKING': "PERSONAL_CHECKING",
+ 'PERSONAL_SAVINGS': "PERSONAL_SAVINGS",
+ 'BUSINESS_CHECKING': "BUSINESS_CHECKING",
+ 'BUSINESS_SAVINGS': "BUSINESS_SAVINGS",
+ 'CORPORATE': "CORPORATE",
+ 'CORP_SAVINGS': "CORP_SAVINGS",
+ },
+ ('type',): {
+ 'BANK_ACCOUNT': "BANK_ACCOUNT",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'account_number': (str,), # noqa: E501
+ 'acount_type': (str,), # noqa: E501
+ 'attempt_bank_account_validation_check': (str,), # noqa: E501
+ 'bank_code': (str,), # noqa: E501
+ 'name': (str,), # noqa: E501
+ 'type': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'account_number': 'account_number', # noqa: E501
+ 'acount_type': 'acount_type', # noqa: E501
+ 'attempt_bank_account_validation_check': 'attempt_bank_account_validation_check', # noqa: E501
+ 'bank_code': 'bank_code', # noqa: E501
+ 'name': 'name', # noqa: E501
+ 'type': 'type', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataPaymentInstruments - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ account_number (str): The bank account number (no dashes in between numbers).. [optional] # noqa: E501
+ acount_type (str): The type of bank account. Use the following respective enum when creating a `Payment Instrument` for:
- CHECKING: The checking account of your buyer.
- SAVINGS: The savings account of your buyer.
- CORPORATE: A corporate checking account.
- CORP_SAVINGS: A corporate savings account.
- BUSINESS_CHECKING: A checking account primarily owned by a business.
- BUSINESS_SAVINGS: A savings account primarily owned by a business
- PERSONAL_CHECKING: Seller's using their personal checking account.
- PERSONAL_SAVINGS: Seller's using their personal savings account.
. [optional] # noqa: E501
+ attempt_bank_account_validation_check (str): [optional] # noqa: E501
+ bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
+ name (str): The name of the bank account owner.. [optional] # noqa: E501
+ type (str): Type of `Payment Instrument`.. [optional] if omitted the server will use the default value of "BANK_ACCOUNT" # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """OnboardingFormOnboardingDataPaymentInstruments - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ account_number (str): The bank account number (no dashes in between numbers).. [optional] # noqa: E501
+ acount_type (str): The type of bank account. Use the following respective enum when creating a `Payment Instrument` for:- CHECKING: The checking account of your buyer.
- SAVINGS: The savings account of your buyer.
- CORPORATE: A corporate checking account.
- CORP_SAVINGS: A corporate savings account.
- BUSINESS_CHECKING: A checking account primarily owned by a business.
- BUSINESS_SAVINGS: A savings account primarily owned by a business
- PERSONAL_CHECKING: Seller's using their personal checking account.
- PERSONAL_SAVINGS: Seller's using their personal savings account.
. [optional] # noqa: E501
+ attempt_bank_account_validation_check (str): [optional] # noqa: E501
+ bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
+ name (str): The name of the bank account owner.. [optional] # noqa: E501
+ type (str): Type of `Payment Instrument`.. [optional] if omitted the server will use the default value of "BANK_ACCOUNT" # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/operation_key.py b/finix/model/operation_key.py
index 7aefe68..7b199f8 100644
--- a/finix/model/operation_key.py
+++ b/finix/model/operation_key.py
@@ -108,10 +108,10 @@ def __init__(self, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] (str): Details the operation that'll be performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
+ args[0] (str): Details the operation that's performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
Keyword Args:
- value (str): Details the operation that'll be performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
+ value (str): Details the operation that's performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
@@ -198,10 +198,10 @@ def _from_openapi_data(cls, *args, **kwargs):
Note that value can be passed either in args or in kwargs, but not in both.
Args:
- args[0] (str): Details the operation that'll be performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
+ args[0] (str): Details the operation that's performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
Keyword Args:
- value (str): Details the operation that'll be performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
+ value (str): Details the operation that's performed in the transaction (Card present transactions only) .., must be one of ["PUSH_TO_CARD", "PULL_FROM_CARD", "CARD_PRESENT_DEBIT", "CARD_PRESENT_UNREFERENCED_REFUND", "SALE", "UNREFERENCED_REFUND", "MERCHANT_CREDIT_ADJUSTMENT", "MERCHANT_DEBIT_ADJUSTMENT", "CARD_PRESENT_AUTHORIZATION", ] # noqa: E501
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
diff --git a/finix/model/payment_instrument.py b/finix/model/payment_instrument.py
index 4dab407..07e35b0 100644
--- a/finix/model/payment_instrument.py
+++ b/finix/model/payment_instrument.py
@@ -32,12 +32,10 @@ def lazy_import():
from finix.model.country import Country
from finix.model.currency import Currency
from finix.model.payment_instrument_links import PaymentInstrumentLinks
- from finix.model.tags import Tags
globals()['Address'] = Address
globals()['Country'] = Country
globals()['Currency'] = Currency
globals()['PaymentInstrumentLinks'] = PaymentInstrumentLinks
- globals()['Tags'] = Tags
class PaymentInstrument(ModelNormal):
@@ -63,28 +61,63 @@ class PaymentInstrument(ModelNormal):
allowed_values = {
('address_verification',): {
- 'POSTAL_CODE_AND_STREET_MATCH': "POSTAL_CODE_AND_STREET_MATCH",
- 'STREET_MATCH': "STREET_MATCH",
- 'POSTAL_CODE_MATCH': "POSTAL_CODE_MATCH",
+ 'NOT_SUPPORTED': "NOT_SUPPORTED",
'NO_ADDRESS': "NO_ADDRESS",
'NO_MATCH': "NO_MATCH",
- 'NOT_SUPPORTED': "NOT_SUPPORTED",
+ 'POSTAL_CODE_AND_STREET_MATCH': "POSTAL_CODE_AND_STREET_MATCH",
+ 'POSTAL_CODE_MATCH': "POSTAL_CODE_MATCH",
+ 'STREET_MATCH': "STREET_MATCH",
+ 'UNKNOWN': "UNKNOWN",
+ },
+ ('brand',): {
+ 'AMERICAN_EXPRESS': "AMERICAN_EXPRESS",
+ 'CHINA_T_UNION': "CHINA_T_UNION",
+ 'CHINA_UNION_PAY': "CHINA_UNION_PAY",
+ 'DANKORT': "DANKORT",
+ 'DINERS_CLUB': "DINERS_CLUB",
+ 'DINERS_CLUB_INTERNATIONAL': "DINERS_CLUB_INTERNATIONAL",
+ 'DISCOVER': "DISCOVER",
+ 'INSTAPAYMENT': "INSTAPAYMENT",
+ 'INTERPAYMENT': "INTERPAYMENT",
+ 'JCB': "JCB",
+ 'LANKAPAY': "LANKAPAY",
+ 'MAESTRO': "MAESTRO",
+ 'MASTERCARD': "MASTERCARD",
+ 'MIR': "MIR",
+ 'RUPAY': "RUPAY",
+ 'TROY': "TROY",
+ 'UATP': "UATP",
+ 'UNKNOWN': "UNKNOWN",
+ 'VERVE': "VERVE",
+ 'VISA': "VISA",
+ },
+ ('card_type',): {
+ 'CREDIT': "CREDIT",
+ 'DEBIT': "DEBIT",
+ 'HSA_FSA': "HSA_FSA",
+ 'NON_RELOADABLE_PREPAID': "NON_RELOADABLE_PREPAID",
+ 'RELOADABLE_PREPAID': "RELOADABLE_PREPAID",
'UNKNOWN': "UNKNOWN",
},
('instrument_type',): {
- 'BANK_ACCOUNT': "BANK_ACCOUNT",
- 'TOKEN': "TOKEN",
'APPLE_PAY': "APPLE_PAY",
- 'VIRTUAL': "VIRTUAL",
- 'PAYMENT_CARD_PRESENT': "PAYMENT_CARD_PRESENT",
+ 'BANK_ACCOUNT': "BANK_ACCOUNT",
'GOOGLE_PAY': "GOOGLE_PAY",
- 'VANTIV_OMNI_TOKEN': "VANTIV_OMNI_TOKEN",
- 'SWIPED_PAYMENT_CARD': "SWIPED_PAYMENT_CARD",
'PAYMENT_CARD': "PAYMENT_CARD",
+ 'PAYMENT_CARD_PRESENT': "PAYMENT_CARD_PRESENT",
+ 'SWIPED_PAYMENT_CARD': "SWIPED_PAYMENT_CARD",
+ 'TOKEN': "TOKEN",
+ 'VANTIV_OMNI_TOKEN': "VANTIV_OMNI_TOKEN",
+ 'VIRTUAL': "VIRTUAL",
+ },
+ ('issuer_country',): {
+ 'NON_USA': "NON_USA",
+ 'UNKNOWN': "UNKNOWN",
+ 'USA': "USA",
},
('payload_type',): {
- 'SOURCE': "SOURCE",
'DESTINATION': "DESTINATION",
+ 'SOURCE': "SOURCE",
},
('security_code_verification',): {
'MATCHED': "MATCHED",
@@ -92,26 +125,24 @@ class PaymentInstrument(ModelNormal):
'UNMATCHED': "UNMATCHED",
},
('type',): {
- 'BANK_ACCOUNT': "BANK_ACCOUNT",
- 'TOKEN': "TOKEN",
'APPLE_PAY': "APPLE_PAY",
- 'VIRTUAL': "VIRTUAL",
- 'PAYMENT_CARD_PRESENT': "PAYMENT_CARD_PRESENT",
+ 'BANK_ACCOUNT': "BANK_ACCOUNT",
'GOOGLE_PAY': "GOOGLE_PAY",
- 'VANTIV_OMNI_TOKEN': "VANTIV_OMNI_TOKEN",
- 'SWIPED_PAYMENT_CARD': "SWIPED_PAYMENT_CARD",
'PAYMENT_CARD': "PAYMENT_CARD",
+ 'PAYMENT_CARD_PRESENT': "PAYMENT_CARD_PRESENT",
+ 'SWIPED_PAYMENT_CARD': "SWIPED_PAYMENT_CARD",
+ 'TOKEN': "TOKEN",
+ 'VANTIV_OMNI_TOKEN': "VANTIV_OMNI_TOKEN",
+ 'VIRTUAL': "VIRTUAL",
},
('account_type',): {
'CHECKING': "CHECKING",
'SAVINGS': "SAVINGS",
- 'CORPORATE': "CORPORATE",
- 'CORP_SAVINGS': "CORP_SAVINGS",
},
('bank_account_validation_check',): {
- 'NOT_ATTEMPTED': "NOT_ATTEMPTED",
'INCONCLUSIVE': "INCONCLUSIVE",
'INVALID': "INVALID",
+ 'NOT_ATTEMPTED': "NOT_ATTEMPTED",
'VALID': "VALID",
},
}
@@ -149,7 +180,7 @@ def openapi_types():
"""
lazy_import()
return {
- 'id': (str, none_type,), # noqa: E501
+ 'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'address': (Address,), # noqa: E501
@@ -160,19 +191,21 @@ def openapi_types():
'card_name': (str, none_type,), # noqa: E501
'card_type': (str,), # noqa: E501
'currency': (Currency,), # noqa: E501
+ 'enabled': (bool,), # noqa: E501
'expiration_month': (int,), # noqa: E501
'expiration_year': (int,), # noqa: E501
'fast_funds_indicator': (str,), # noqa: E501
'fingerprint': (str,), # noqa: E501
- 'identity': (str, none_type,), # noqa: E501
+ 'identity': (str,), # noqa: E501
'instrument_type': (str,), # noqa: E501
+ 'issuer_country': (str,), # noqa: E501
'last_four': (str,), # noqa: E501
'name': (str, none_type,), # noqa: E501
'online_gambing_block_indicator': (str,), # noqa: E501
'payload_type': (str,), # noqa: E501
'push_funds_block_indicator': (str,), # noqa: E501
'security_code_verification': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'type': (str,), # noqa: E501
'links': (PaymentInstrumentLinks,), # noqa: E501
'account_type': (str,), # noqa: E501
@@ -199,12 +232,14 @@ def discriminator():
'card_name': 'card_name', # noqa: E501
'card_type': 'card_type', # noqa: E501
'currency': 'currency', # noqa: E501
+ 'enabled': 'enabled', # noqa: E501
'expiration_month': 'expiration_month', # noqa: E501
'expiration_year': 'expiration_year', # noqa: E501
'fast_funds_indicator': 'fast_funds_indicator', # noqa: E501
'fingerprint': 'fingerprint', # noqa: E501
'identity': 'identity', # noqa: E501
'instrument_type': 'instrument_type', # noqa: E501
+ 'issuer_country': 'issuer_country', # noqa: E501
'last_four': 'last_four', # noqa: E501
'name': 'name', # noqa: E501
'online_gambing_block_indicator': 'online_gambing_block_indicator', # noqa: E501
@@ -262,34 +297,36 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Payment Instrument`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
address (Address): [optional] # noqa: E501
address_verification (str): Additional address information that’s required to verify the identity of the merchant.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource the `Payment Instrument` was created under.. [optional] # noqa: E501
bin (str): Bank Identification number for the `Payment Instrument`.. [optional] # noqa: E501
brand (str): The `brand` of the card saved in the `Payment Instrument`.. [optional] # noqa: E501
card_name (str, none_type): A custom name you can include to identify the card being used (e.g. **Business Card**).. [optional] # noqa: E501
card_type (str): The type of payment card saved in the `Payment Instrument`.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.. [optional] # noqa: E501
expiration_month (int): Expiration month (e.g. 12 for December).. [optional] # noqa: E501
expiration_year (int): 4-digit expiration year.. [optional] # noqa: E501
fast_funds_indicator (str): Details if Fast Funds is enabled for the card.. [optional] # noqa: E501
fingerprint (str): Unique ID that represents the tokenized card data.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
instrument_type (str): The type of `Payment Instrument`.. [optional] # noqa: E501
+ issuer_country (str): Details what country the card was issued in: - USA: The card was issued inside the United States.
- NON_USA: The card was issued outside of the United States.
- UNKNOWN: Processor did not return an issuer country for this particular BIN.. [optional] # noqa: E501
last_four (str): Last four digits of the card or bank account number.. [optional] # noqa: E501
name (str, none_type): The name of the bank account or card owner.. [optional] # noqa: E501
online_gambing_block_indicator (str): Detailes if the card is enabled to receive push-payments for online gambling payouts.. [optional] # noqa: E501
payload_type (str): [optional] # noqa: E501
push_funds_block_indicator (str): Details if the card is enabled to receive push-to-card disbursements.. [optional] # noqa: E501
security_code_verification (str): Details the results of the Card Verification Code check.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Type of `Payment Instrument`.. [optional] # noqa: E501
links (PaymentInstrumentLinks): [optional] # noqa: E501
account_type (str): Details what kind of **BANK_ACCOUNT** is being used.. [optional] # noqa: E501
- bank_account_validation_check (str): Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true**.. [optional] if omitted the server will use the default value of "NOT_ATTEMPTED" # noqa: E501
+ bank_account_validation_check (str): Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true** or the `Payment Instrument` gets used to create a `Transfer`. - **INCONCLUSIVE**: A verification check was performed, but the bank account couldn't be found or verified with the issuing bank. Reach out to the buyer to verify the details collected or request another method of payment, - **INVALID**: The `Payment Instrument` was used in transactions that returned one of the following ACH errors:
- **Account Does Not Allow ACH Transactions**
- **Account is Closed**
- **Account Funds are Frozen**
- **Deceased Account Holder**
- **Invalid Account Number**
- **Invalid Routing Number**
- **No Account on File**
. For more details on the different ACH failure codes, see [ACH Direct Debit.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits) - **NOT_ATTEMPTED**: A verification check wasn't performed and the `Payment Instrument` hasn't been used to create a `Transfer` or `Authorization`. - **VALID**: The bank account was verified. The `Payment Instrument` can be used to create [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits). [optional] if omitted the server will use the default value of "NOT_ATTEMPTED" # noqa: E501
bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
country (Country): [optional] # noqa: E501
masked_account_number (str, none_type): The last 4 digits of the account number used to create the `Payment Instrument`.. [optional] # noqa: E501
@@ -374,34 +411,36 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Payment Instrument`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
address (Address): [optional] # noqa: E501
address_verification (str): Additional address information that’s required to verify the identity of the merchant.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource the `Payment Instrument` was created under.. [optional] # noqa: E501
bin (str): Bank Identification number for the `Payment Instrument`.. [optional] # noqa: E501
brand (str): The `brand` of the card saved in the `Payment Instrument`.. [optional] # noqa: E501
card_name (str, none_type): A custom name you can include to identify the card being used (e.g. **Business Card**).. [optional] # noqa: E501
card_type (str): The type of payment card saved in the `Payment Instrument`.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.. [optional] # noqa: E501
expiration_month (int): Expiration month (e.g. 12 for December).. [optional] # noqa: E501
expiration_year (int): 4-digit expiration year.. [optional] # noqa: E501
fast_funds_indicator (str): Details if Fast Funds is enabled for the card.. [optional] # noqa: E501
fingerprint (str): Unique ID that represents the tokenized card data.. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
instrument_type (str): The type of `Payment Instrument`.. [optional] # noqa: E501
+ issuer_country (str): Details what country the card was issued in: - USA: The card was issued inside the United States.
- NON_USA: The card was issued outside of the United States.
- UNKNOWN: Processor did not return an issuer country for this particular BIN.. [optional] # noqa: E501
last_four (str): Last four digits of the card or bank account number.. [optional] # noqa: E501
name (str, none_type): The name of the bank account or card owner.. [optional] # noqa: E501
online_gambing_block_indicator (str): Detailes if the card is enabled to receive push-payments for online gambling payouts.. [optional] # noqa: E501
payload_type (str): [optional] # noqa: E501
push_funds_block_indicator (str): Details if the card is enabled to receive push-to-card disbursements.. [optional] # noqa: E501
security_code_verification (str): Details the results of the Card Verification Code check.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
type (str): Type of `Payment Instrument`.. [optional] # noqa: E501
links (PaymentInstrumentLinks): [optional] # noqa: E501
account_type (str): Details what kind of **BANK_ACCOUNT** is being used.. [optional] # noqa: E501
- bank_account_validation_check (str): Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true**.. [optional] if omitted the server will use the default value of "NOT_ATTEMPTED" # noqa: E501
+ bank_account_validation_check (str): Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true** or the `Payment Instrument` gets used to create a `Transfer`. - **INCONCLUSIVE**: A verification check was performed, but the bank account couldn't be found or verified with the issuing bank. Reach out to the buyer to verify the details collected or request another method of payment, - **INVALID**: The `Payment Instrument` was used in transactions that returned one of the following ACH errors:
- **Account Does Not Allow ACH Transactions**
- **Account is Closed**
- **Account Funds are Frozen**
- **Deceased Account Holder**
- **Invalid Account Number**
- **Invalid Routing Number**
- **No Account on File**
. For more details on the different ACH failure codes, see [ACH Direct Debit.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits) - **NOT_ATTEMPTED**: A verification check wasn't performed and the `Payment Instrument` hasn't been used to create a `Transfer` or `Authorization`. - **VALID**: The bank account was verified. The `Payment Instrument` can be used to create [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits). [optional] if omitted the server will use the default value of "NOT_ATTEMPTED" # noqa: E501
bank_code (str): The routing number of the bank account.. [optional] # noqa: E501
country (Country): [optional] # noqa: E501
masked_account_number (str, none_type): The last 4 digits of the account number used to create the `Payment Instrument`.. [optional] # noqa: E501
diff --git a/finix/model/payment_instrument_links.py b/finix/model/payment_instrument_links.py
index 2d45df8..112ba66 100644
--- a/finix/model/payment_instrument_links.py
+++ b/finix/model/payment_instrument_links.py
@@ -34,12 +34,14 @@ def lazy_import():
from finix.model.merchant_links_verifications import MerchantLinksVerifications
from finix.model.payment_instrument_links_authorizations import PaymentInstrumentLinksAuthorizations
from finix.model.payment_instrument_links_transfers import PaymentInstrumentLinksTransfers
+ from finix.model.payment_instrument_links_updates import PaymentInstrumentLinksUpdates
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['MerchantLinksApplication'] = MerchantLinksApplication
globals()['MerchantLinksIdentity'] = MerchantLinksIdentity
globals()['MerchantLinksVerifications'] = MerchantLinksVerifications
globals()['PaymentInstrumentLinksAuthorizations'] = PaymentInstrumentLinksAuthorizations
globals()['PaymentInstrumentLinksTransfers'] = PaymentInstrumentLinksTransfers
+ globals()['PaymentInstrumentLinksUpdates'] = PaymentInstrumentLinksUpdates
class PaymentInstrumentLinks(ModelNormal):
@@ -92,12 +94,13 @@ def openapi_types():
"""
lazy_import()
return {
- 'self': (ApplicationLinksSelf,), # noqa: E501
+ 'application': (MerchantLinksApplication,), # noqa: E501
'authorizations': (PaymentInstrumentLinksAuthorizations,), # noqa: E501
+ 'identity': (MerchantLinksIdentity,), # noqa: E501
+ 'self': (ApplicationLinksSelf,), # noqa: E501
'transfers': (PaymentInstrumentLinksTransfers,), # noqa: E501
+ 'updates': (PaymentInstrumentLinksUpdates,), # noqa: E501
'verifications': (MerchantLinksVerifications,), # noqa: E501
- 'application': (MerchantLinksApplication,), # noqa: E501
- 'identity': (MerchantLinksIdentity,), # noqa: E501
}
@cached_property
@@ -106,12 +109,13 @@ def discriminator():
attribute_map = {
- 'self': 'self', # noqa: E501
+ 'application': 'application', # noqa: E501
'authorizations': 'authorizations', # noqa: E501
+ 'identity': 'identity', # noqa: E501
+ 'self': 'self', # noqa: E501
'transfers': 'transfers', # noqa: E501
+ 'updates': 'updates', # noqa: E501
'verifications': 'verifications', # noqa: E501
- 'application': 'application', # noqa: E501
- 'identity': 'identity', # noqa: E501
}
read_only_vars = {
@@ -155,12 +159,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- self (ApplicationLinksSelf): [optional] # noqa: E501
+ application (MerchantLinksApplication): [optional] # noqa: E501
authorizations (PaymentInstrumentLinksAuthorizations): [optional] # noqa: E501
+ identity (MerchantLinksIdentity): [optional] # noqa: E501
+ self (ApplicationLinksSelf): [optional] # noqa: E501
transfers (PaymentInstrumentLinksTransfers): [optional] # noqa: E501
+ updates (PaymentInstrumentLinksUpdates): [optional] # noqa: E501
verifications (MerchantLinksVerifications): [optional] # noqa: E501
- application (MerchantLinksApplication): [optional] # noqa: E501
- identity (MerchantLinksIdentity): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -242,12 +247,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- self (ApplicationLinksSelf): [optional] # noqa: E501
+ application (MerchantLinksApplication): [optional] # noqa: E501
authorizations (PaymentInstrumentLinksAuthorizations): [optional] # noqa: E501
+ identity (MerchantLinksIdentity): [optional] # noqa: E501
+ self (ApplicationLinksSelf): [optional] # noqa: E501
transfers (PaymentInstrumentLinksTransfers): [optional] # noqa: E501
+ updates (PaymentInstrumentLinksUpdates): [optional] # noqa: E501
verifications (MerchantLinksVerifications): [optional] # noqa: E501
- application (MerchantLinksApplication): [optional] # noqa: E501
- identity (MerchantLinksIdentity): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/payment_instrument_links_updates.py b/finix/model/payment_instrument_links_updates.py
new file mode 100644
index 0000000..5c6e8d9
--- /dev/null
+++ b/finix/model/payment_instrument_links_updates.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class PaymentInstrumentLinksUpdates(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'href': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'href': 'href', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PaymentInstrumentLinksUpdates - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ href (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PaymentInstrumentLinksUpdates - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ href (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payment_instrument_token.py b/finix/model/payment_instrument_token.py
index 79acfa6..87124c7 100644
--- a/finix/model/payment_instrument_token.py
+++ b/finix/model/payment_instrument_token.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.currency import Currency
from finix.model.payment_instrument_token_links import PaymentInstrumentTokenLinks
- from finix.model.tags import Tags
globals()['Currency'] = Currency
globals()['PaymentInstrumentTokenLinks'] = PaymentInstrumentTokenLinks
- globals()['Tags'] = Tags
class PaymentInstrumentToken(ModelNormal):
@@ -96,15 +94,16 @@ def openapi_types():
"""
lazy_import()
return {
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'enabled': (bool,), # noqa: E501
'type': (str,), # noqa: E501
- 'id': (str, none_type,), # noqa: E501
+ 'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'application': (str,), # noqa: E501
'currency': (Currency,), # noqa: E501
'fingerprint': (str,), # noqa: E501
- 'identity': (str, none_type,), # noqa: E501
+ 'identity': (str,), # noqa: E501
'instrument_type': (str,), # noqa: E501
'payload_type': (str,), # noqa: E501
'links': (PaymentInstrumentTokenLinks,), # noqa: E501
@@ -117,6 +116,7 @@ def discriminator():
attribute_map = {
'tags': 'tags', # noqa: E501
+ 'enabled': 'enabled', # noqa: E501
'type': 'type', # noqa: E501
'id': 'id', # noqa: E501
'created_at': 'created_at', # noqa: E501
@@ -171,15 +171,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Set to `false` to disable the `Payment Instrument`.. [optional] # noqa: E501
type (str): [optional] if omitted the server will use the default value of "TOKEN" # noqa: E501
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Payment Instrument`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource the `Payment Instrument` was created under.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
fingerprint (str): [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
instrument_type (str): [optional] if omitted the server will use the default value of "TOKEN" # noqa: E501
payload_type (str): [optional] # noqa: E501
links (PaymentInstrumentTokenLinks): [optional] # noqa: E501
@@ -264,15 +265,16 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Set to `false` to disable the `Payment Instrument`.. [optional] # noqa: E501
type (str): [optional] if omitted the server will use the default value of "TOKEN" # noqa: E501
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Payment Instrument`.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
- application (str): The ID of the resource.. [optional] # noqa: E501
+ application (str): The ID of the `Application` resource the `Payment Instrument` was created under.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
fingerprint (str): [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Payment Instrument` resource.. [optional] # noqa: E501
instrument_type (str): [optional] if omitted the server will use the default value of "TOKEN" # noqa: E501
payload_type (str): [optional] # noqa: E501
links (PaymentInstrumentTokenLinks): [optional] # noqa: E501
diff --git a/finix/model/payment_instrument_token_links.py b/finix/model/payment_instrument_token_links.py
index c0b91eb..5962772 100644
--- a/finix/model/payment_instrument_token_links.py
+++ b/finix/model/payment_instrument_token_links.py
@@ -28,11 +28,11 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
from finix.model.payment_instrument_token_links_verifications import PaymentInstrumentTokenLinksVerifications
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
globals()['PaymentInstrumentTokenLinksVerifications'] = PaymentInstrumentTokenLinksVerifications
@@ -89,10 +89,10 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'authorizations': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'identity': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'authorizations': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'identity': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'transfers': (ApplicationLinksAuthorizations,), # noqa: E501
'verifications': (PaymentInstrumentTokenLinksVerifications,), # noqa: E501
}
@@ -152,10 +152,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
verifications (PaymentInstrumentTokenLinksVerifications): [optional] # noqa: E501
"""
@@ -239,10 +239,10 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- authorizations (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ authorizations (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
verifications (PaymentInstrumentTokenLinksVerifications): [optional] # noqa: E501
"""
diff --git a/finix/model/payout_profile.py b/finix/model/payout_profile.py
new file mode 100644
index 0000000..fd0ccdc
--- /dev/null
+++ b/finix/model/payout_profile.py
@@ -0,0 +1,305 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.list_links import ListLinks
+ from finix.model.payout_profile_gross import PayoutProfileGross
+ from finix.model.payout_profile_net import PayoutProfileNet
+ globals()['ListLinks'] = ListLinks
+ globals()['PayoutProfileGross'] = PayoutProfileGross
+ globals()['PayoutProfileNet'] = PayoutProfileNet
+
+
+class PayoutProfile(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('type',): {
+ 'CUSTOM': "CUSTOM",
+ 'GROSS': "GROSS",
+ 'NET': "NET",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'id': (str,), # noqa: E501
+ 'created_at': (datetime,), # noqa: E501
+ 'updated_at': (datetime,), # noqa: E501
+ 'gross': (PayoutProfileGross,), # noqa: E501
+ 'linked_id': (str,), # noqa: E501
+ 'linked_type': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'type': (str,), # noqa: E501
+ 'links': (ListLinks,), # noqa: E501
+ 'net': (PayoutProfileNet,), # noqa: E501
+ 'custom': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'id': 'id', # noqa: E501
+ 'created_at': 'created_at', # noqa: E501
+ 'updated_at': 'updated_at', # noqa: E501
+ 'gross': 'gross', # noqa: E501
+ 'linked_id': 'linked_id', # noqa: E501
+ 'linked_type': 'linked_type', # noqa: E501
+ 'tags': 'tags', # noqa: E501
+ 'type': 'type', # noqa: E501
+ 'links': '_links', # noqa: E501
+ 'net': 'net', # noqa: E501
+ 'custom': 'custom', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfile - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): The ID of the `Payout Profile` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ gross (PayoutProfileGross): [optional] # noqa: E501
+ linked_id (str): ID of the resource linked to the `Payout Profile`.. [optional] # noqa: E501
+ linked_type (str): The type of resource the `Payout Profile` is linked to.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Configures how fees are calculated and billed from payouts. For more infromation, see [Payout Types](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ net (PayoutProfileNet): [optional] # noqa: E501
+ custom ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Details how `Payout Profiles` with type **CUSTOM** are configured. `Payout Profiles` with type **CUSTOM** can be setup with more specific configurations. To configure a **CUSTOM** `Payout Profile` [contact Finix Support](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfile - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): The ID of the `Payout Profile` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ gross (PayoutProfileGross): [optional] # noqa: E501
+ linked_id (str): ID of the resource linked to the `Payout Profile`.. [optional] # noqa: E501
+ linked_type (str): The type of resource the `Payout Profile` is linked to.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Configures how fees are calculated and billed from payouts. For more infromation, see [Payout Types](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ net (PayoutProfileNet): [optional] # noqa: E501
+ custom ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Details how `Payout Profiles` with type **CUSTOM** are configured. `Payout Profiles` with type **CUSTOM** can be setup with more specific configurations. To configure a **CUSTOM** `Payout Profile` [contact Finix Support](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profile_gross.py b/finix/model/payout_profile_gross.py
new file mode 100644
index 0000000..21660a7
--- /dev/null
+++ b/finix/model/payout_profile_gross.py
@@ -0,0 +1,262 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.payout_profile_gross_fees import PayoutProfileGrossFees
+ from finix.model.payout_profile_gross_payouts import PayoutProfileGrossPayouts
+ globals()['PayoutProfileGrossFees'] = PayoutProfileGrossFees
+ globals()['PayoutProfileGrossPayouts'] = PayoutProfileGrossPayouts
+
+
+class PayoutProfileGross(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'fees': (PayoutProfileGrossFees,), # noqa: E501
+ 'payouts': (PayoutProfileGrossPayouts,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'fees': 'fees', # noqa: E501
+ 'payouts': 'payouts', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfileGross - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ fees (PayoutProfileGrossFees): [optional] # noqa: E501
+ payouts (PayoutProfileGrossPayouts): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfileGross - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ fees (PayoutProfileGrossFees): [optional] # noqa: E501
+ payouts (PayoutProfileGrossPayouts): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profile_gross_fees.py b/finix/model/payout_profile_gross_fees.py
new file mode 100644
index 0000000..5aaabca
--- /dev/null
+++ b/finix/model/payout_profile_gross_fees.py
@@ -0,0 +1,276 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class PayoutProfileGrossFees(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ ('rail',): {
+ 'NEXT_DAY_ACH': "NEXT_DAY_ACH",
+ 'SAME_DAY_ACH': "SAME_DAY_ACH",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day_of_month': (int,), # noqa: E501
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day_of_month': 'day_of_month', # noqa: E501
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfileGrossFees - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day_of_month (int): Day of the month fees get debited. Required when `frequency` is set to **MONTHLY**.. [optional] # noqa: E501
+ frequency (str): Configures how frequentyly *fees* get debited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that *fees* get debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit *fees*.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for *fees* will get submitted to debit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfileGrossFees - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day_of_month (int): Day of the month fees get debited. Required when `frequency` is set to **MONTHLY**.. [optional] # noqa: E501
+ frequency (str): Configures how frequentyly *fees* get debited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that *fees* get debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit *fees*.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for *fees* will get submitted to debit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profile_gross_payouts.py b/finix/model/payout_profile_gross_payouts.py
new file mode 100644
index 0000000..d77f6e6
--- /dev/null
+++ b/finix/model/payout_profile_gross_payouts.py
@@ -0,0 +1,272 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class PayoutProfileGrossPayouts(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ ('rail',): {
+ 'NEXT_DAY_ACH': "NEXT_DAY_ACH",
+ 'SAME_DAY_ACH': "SAME_DAY_ACH",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfileGrossPayouts - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly *payouts* get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that *payouts* will get credited to.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to credit *payouts*.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for *payouts* will get submitted to credit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfileGrossPayouts - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly *payouts* get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that *payouts* will get credited to.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to credit *payouts*.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for *payouts* will get submitted to credit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profile_net.py b/finix/model/payout_profile_net.py
new file mode 100644
index 0000000..90b3c0c
--- /dev/null
+++ b/finix/model/payout_profile_net.py
@@ -0,0 +1,272 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class PayoutProfileNet(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ ('rail',): {
+ 'NEXT_DAY_ACH': "NEXT_DAY_ACH",
+ 'SAME_DAY_ACH': "SAME_DAY_ACH",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfileNet - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly fees and payouts get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that payouts and fees get credited to and debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit fees and credit payouts.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for both payouts and fees will get submitted (in days) to debit/credit the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfileNet - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly fees and payouts get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that payouts and fees get credited to and debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit fees and credit payouts.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for both payouts and fees will get submitted (in days) to debit/credit the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profiles_list.py b/finix/model/payout_profiles_list.py
new file mode 100644
index 0000000..60b1c0f
--- /dev/null
+++ b/finix/model/payout_profiles_list.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.list_links import ListLinks
+ from finix.model.page_cursor import PageCursor
+ from finix.model.payout_profiles_list_embedded import PayoutProfilesListEmbedded
+ globals()['ListLinks'] = ListLinks
+ globals()['PageCursor'] = PageCursor
+ globals()['PayoutProfilesListEmbedded'] = PayoutProfilesListEmbedded
+
+
+class PayoutProfilesList(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'embedded': (PayoutProfilesListEmbedded,), # noqa: E501
+ 'links': (ListLinks,), # noqa: E501
+ 'page': (PageCursor,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'embedded': '_embedded', # noqa: E501
+ 'links': '_links', # noqa: E501
+ 'page': 'page', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfilesList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (PayoutProfilesListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfilesList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (PayoutProfilesListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/payout_profiles_list_embedded.py b/finix/model/payout_profiles_list_embedded.py
new file mode 100644
index 0000000..e80e46b
--- /dev/null
+++ b/finix/model/payout_profiles_list_embedded.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.payout_profile import PayoutProfile
+ globals()['PayoutProfile'] = PayoutProfile
+
+
+class PayoutProfilesListEmbedded(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'payout_profiles': ([PayoutProfile],), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'payout_profiles': 'payout_profiles', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """PayoutProfilesListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ payout_profiles ([PayoutProfile]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """PayoutProfilesListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ payout_profiles ([PayoutProfile]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/processor.py b/finix/model/processor.py
index 7cdac96..74d9453 100644
--- a/finix/model/processor.py
+++ b/finix/model/processor.py
@@ -29,9 +29,11 @@
def lazy_import():
from finix.model.processor_application_config import ProcessorApplicationConfig
+ from finix.model.processor_config import ProcessorConfig
from finix.model.processor_links import ProcessorLinks
from finix.model.processor_system_config import ProcessorSystemConfig
globals()['ProcessorApplicationConfig'] = ProcessorApplicationConfig
+ globals()['ProcessorConfig'] = ProcessorConfig
globals()['ProcessorLinks'] = ProcessorLinks
globals()['ProcessorSystemConfig'] = ProcessorSystemConfig
@@ -91,7 +93,8 @@ def openapi_types():
'updated_at': (datetime,), # noqa: E501
'application': (str,), # noqa: E501
'application_config': (ProcessorApplicationConfig,), # noqa: E501
- 'default_merchant_profile': (str, none_type,), # noqa: E501
+ 'config': (ProcessorConfig,), # noqa: E501
+ 'default_merchant_profile': (str,), # noqa: E501
'enabled': (bool,), # noqa: E501
'processor': (str,), # noqa: E501
'system_config': (ProcessorSystemConfig,), # noqa: E501
@@ -109,6 +112,7 @@ def discriminator():
'updated_at': 'updated_at', # noqa: E501
'application': 'application', # noqa: E501
'application_config': 'application_config', # noqa: E501
+ 'config': 'config', # noqa: E501
'default_merchant_profile': 'default_merchant_profile', # noqa: E501
'enabled': 'enabled', # noqa: E501
'processor': 'processor', # noqa: E501
@@ -162,7 +166,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): The ID of the `Application` resource.. [optional] # noqa: E501
application_config (ProcessorApplicationConfig): [optional] # noqa: E501
- default_merchant_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ config (ProcessorConfig): [optional] # noqa: E501
+ default_merchant_profile (str): The ID of the `Merchant Profile` resource used to create the `Processor`.. [optional] # noqa: E501
enabled (bool): Details if the `Processor` resource is enabled. Set to **false** to disable the `Processor`.. [optional] # noqa: E501
processor (str): The name of the processor.. [optional] # noqa: E501
system_config (ProcessorSystemConfig): [optional] # noqa: E501
@@ -253,7 +258,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): The ID of the `Application` resource.. [optional] # noqa: E501
application_config (ProcessorApplicationConfig): [optional] # noqa: E501
- default_merchant_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ config (ProcessorConfig): [optional] # noqa: E501
+ default_merchant_profile (str): The ID of the `Merchant Profile` resource used to create the `Processor`.. [optional] # noqa: E501
enabled (bool): Details if the `Processor` resource is enabled. Set to **false** to disable the `Processor`.. [optional] # noqa: E501
processor (str): The name of the processor.. [optional] # noqa: E501
system_config (ProcessorSystemConfig): [optional] # noqa: E501
diff --git a/finix/model/processor_config.py b/finix/model/processor_config.py
new file mode 100644
index 0000000..01dcb23
--- /dev/null
+++ b/finix/model/processor_config.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class ProcessorConfig(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'can_debit_bank_account': (bool,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'can_debit_bank_account': 'canDebitBankAccount', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """ProcessorConfig - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ can_debit_bank_account (bool): Details if the `Application` can debit bank accounts using the `Processor`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """ProcessorConfig - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ can_debit_bank_account (bool): Details if the `Application` can debit bank accounts using the `Processor`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/processor_system_config.py b/finix/model/processor_system_config.py
index 3cb4b18..93a10b1 100644
--- a/finix/model/processor_system_config.py
+++ b/finix/model/processor_system_config.py
@@ -352,7 +352,7 @@ def openapi_types():
'acquiring_bin': (str,), # noqa: E501
'allow_credit_for_partner': (bool,), # noqa: E501
'available_countries': ([Country],), # noqa: E501
- 'business_application_id': (str, none_type,), # noqa: E501
+ 'business_application_id': (str,), # noqa: E501
'class_key_identifier': (str,), # noqa: E501
'config': (ProcessorSystemConfigConfig,), # noqa: E501
'default_currencies': ([Currency],), # noqa: E501
@@ -465,7 +465,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
acquiring_bin (str): The Bank Identification Number (BIN) the `Processor` is registered under with Visa Direct.. [optional] # noqa: E501
allow_credit_for_partner (bool): Field used by Finix and processor to handle transactions.. [optional] # noqa: E501
available_countries ([Country]): Details the countries the `Processor` is avalible in.. [optional] # noqa: E501
- business_application_id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ business_application_id (str): The ID of the `Application` linked to the `Processor`.. [optional] # noqa: E501
class_key_identifier (str): Field used by processor to communicate with Finix.. [optional] if omitted the server will use the default value of "io.finix.visa.direct.client.VisaSystemConfig" # noqa: E501
config (ProcessorSystemConfigConfig): [optional] # noqa: E501
default_currencies ([Currency]): ISO 4217 3 letter currency code.. [optional] # noqa: E501
@@ -577,7 +577,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
acquiring_bin (str): The Bank Identification Number (BIN) the `Processor` is registered under with Visa Direct.. [optional] # noqa: E501
allow_credit_for_partner (bool): Field used by Finix and processor to handle transactions.. [optional] # noqa: E501
available_countries ([Country]): Details the countries the `Processor` is avalible in.. [optional] # noqa: E501
- business_application_id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ business_application_id (str): The ID of the `Application` linked to the `Processor`.. [optional] # noqa: E501
class_key_identifier (str): Field used by processor to communicate with Finix.. [optional] if omitted the server will use the default value of "io.finix.visa.direct.client.VisaSystemConfig" # noqa: E501
config (ProcessorSystemConfigConfig): [optional] # noqa: E501
default_currencies ([Currency]): ISO 4217 3 letter currency code.. [optional] # noqa: E501
diff --git a/finix/model/settlement.py b/finix/model/settlement.py
index decfc90..f63ab28 100644
--- a/finix/model/settlement.py
+++ b/finix/model/settlement.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.currency import Currency
from finix.model.settlement_links import SettlementLinks
- from finix.model.tags import Tags
globals()['Currency'] = Currency
globals()['SettlementLinks'] = SettlementLinks
- globals()['Tags'] = Tags
class Settlement(ModelNormal):
@@ -61,7 +59,6 @@ class Settlement(ModelNormal):
('status',): {
'APPROVED': "APPROVED",
'AWAITING_APPROVAL': "AWAITING_APPROVAL",
- 'CANCELLED': "CANCELLED",
'PENDING': "PENDING",
},
('type',): {
@@ -101,20 +98,20 @@ def openapi_types():
"""
lazy_import()
return {
- 'id': (str, none_type,), # noqa: E501
+ 'id': (str,), # noqa: E501
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'application': (str,), # noqa: E501
'currency': (Currency,), # noqa: E501
'destination': (str, none_type,), # noqa: E501
'funds_flow': (str, none_type,), # noqa: E501
- 'identity': (str, none_type,), # noqa: E501
- 'merchant_id': (str, none_type,), # noqa: E501
+ 'identity': (str,), # noqa: E501
+ 'merchant_id': (str,), # noqa: E501
'net_amount': (int,), # noqa: E501
'payment_type': (str, none_type,), # noqa: E501
'processor': (str,), # noqa: E501
'status': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'total_amount': (int,), # noqa: E501
'total_fee': (int,), # noqa: E501
'total_fees': (int,), # noqa: E501
@@ -190,20 +187,20 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Settlement` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): The ID of the `Application` resource the `Settlement` was created under.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
destination (str, none_type): ID of the `Payment Instrument` where funds will be sent.. [optional] # noqa: E501
funds_flow (str, none_type): Details how funds will be dispersed in the `Funding Transfer` (usually **null**).. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- merchant_id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Settlement` resource.. [optional] # noqa: E501
+ merchant_id (str): The ID of the `Merchant` used to create the `Settlement` resource.. [optional] # noqa: E501
net_amount (int): The amount in cents that will be deposited into the merchant's bank account.. [optional] # noqa: E501
payment_type (str, none_type): The type of `Payment Instrument` used in the `Funding Transfer` (or the original payment).. [optional] # noqa: E501
processor (str): Name of the `Settlement` processor.. [optional] # noqa: E501
- status (str): The status of the `Settlement`. Available values include:- **PENDING**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED** and receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/payouts/).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ status (str): The status of the `Settlement`. Available values include:- **PENDING**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED** and receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/).. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
total_amount (int): Total amount of the `Settlement` (in cents).. [optional] # noqa: E501
total_fee (int): Sum of the fees in the `Settlement`.. [optional] # noqa: E501
total_fees (int): Sum of the fees (including Subcription Billing) in the `Settlement`.. [optional] # noqa: E501
@@ -290,20 +287,20 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ id (str): The ID of the `Settlement` resource.. [optional] # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
application (str): The ID of the `Application` resource the `Settlement` was created under.. [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
destination (str, none_type): ID of the `Payment Instrument` where funds will be sent.. [optional] # noqa: E501
funds_flow (str, none_type): Details how funds will be dispersed in the `Funding Transfer` (usually **null**).. [optional] # noqa: E501
- identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
- merchant_id (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ identity (str): The ID of the `Identity` used to create the `Settlement` resource.. [optional] # noqa: E501
+ merchant_id (str): The ID of the `Merchant` used to create the `Settlement` resource.. [optional] # noqa: E501
net_amount (int): The amount in cents that will be deposited into the merchant's bank account.. [optional] # noqa: E501
payment_type (str, none_type): The type of `Payment Instrument` used in the `Funding Transfer` (or the original payment).. [optional] # noqa: E501
processor (str): Name of the `Settlement` processor.. [optional] # noqa: E501
- status (str): The status of the `Settlement`. Available values include:- **PENDING**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED** and receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/payouts/).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ status (str): The status of the `Settlement`. Available values include:- **PENDING**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED** and receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/).. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
total_amount (int): Total amount of the `Settlement` (in cents).. [optional] # noqa: E501
total_fee (int): Sum of the fees in the `Settlement`.. [optional] # noqa: E501
total_fees (int): Sum of the fees (including Subcription Billing) in the `Settlement`.. [optional] # noqa: E501
diff --git a/finix/model/settlement_links.py b/finix/model/settlement_links.py
index c19d4dd..34da608 100644
--- a/finix/model/settlement_links.py
+++ b/finix/model/settlement_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
@@ -87,15 +87,15 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'credits': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'debits': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'disputes': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'fees': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'funding_transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'identity': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'reversals': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'credits': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'debits': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'disputes': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'fees': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'funding_transfers': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'identity': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'reversals': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
- 'transfers': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'transfers': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -158,15 +158,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- credits (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- debits (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- disputes (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- fees (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- funding_transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reversals (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ credits (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ debits (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ disputes (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ fees (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ funding_transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reversals (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -249,15 +249,15 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- credits (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- debits (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- disputes (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- fees (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- funding_transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- identity (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- reversals (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ credits (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ debits (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ disputes (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ fees (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ funding_transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ identity (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ reversals (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
- transfers (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ transfers (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/split_transfer.py b/finix/model/split_transfer.py
new file mode 100644
index 0000000..392e811
--- /dev/null
+++ b/finix/model/split_transfer.py
@@ -0,0 +1,315 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.currency import Currency
+ from finix.model.split_transfer_tags import SplitTransferTags
+ globals()['Currency'] = Currency
+ globals()['SplitTransferTags'] = SplitTransferTags
+
+
+class SplitTransfer(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('parent_transfer_id',): {
+ 'regex': {
+ 'pattern': r'TRxxxxxxxxxxxxxxxxxxxxxx', # noqa: E501
+ },
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'id': (str,), # noqa: E501
+ 'created_at': (datetime,), # noqa: E501
+ 'updated_at': (datetime,), # noqa: E501
+ 'amount': (int,), # noqa: E501
+ 'fee': (int,), # noqa: E501
+ 'currency': (Currency,), # noqa: E501
+ 'parent_transfer_id': (str,), # noqa: E501
+ 'ready_to_settle_at': (datetime, none_type,), # noqa: E501
+ 'type': (str,), # noqa: E501
+ 'merchant_id': (str,), # noqa: E501
+ 'identity_id': (str,), # noqa: E501
+ 'fee_profile_id': (str,), # noqa: E501
+ 'application_id': (str,), # noqa: E501
+ 'tags': (SplitTransferTags,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'id': 'id', # noqa: E501
+ 'created_at': 'created_at', # noqa: E501
+ 'updated_at': 'updated_at', # noqa: E501
+ 'amount': 'amount', # noqa: E501
+ 'fee': 'fee', # noqa: E501
+ 'currency': 'currency', # noqa: E501
+ 'parent_transfer_id': 'parent_transfer_id', # noqa: E501
+ 'ready_to_settle_at': 'ready_to_settle_at', # noqa: E501
+ 'type': 'type', # noqa: E501
+ 'merchant_id': 'merchant_id', # noqa: E501
+ 'identity_id': 'identity_id', # noqa: E501
+ 'fee_profile_id': 'fee_profile_id', # noqa: E501
+ 'application_id': 'application_id', # noqa: E501
+ 'tags': 'tags', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """SplitTransfer - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): The ID of the `split_transfer` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`. fraud_session_id:. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
+ parent_transfer_id (str): **ID** of the original parent `Transfer` where the split was defined.. [optional] # noqa: E501
+ ready_to_settle_at (datetime, none_type): Timestamp of when the `Transfer` is ready to be settled at.. [optional] # noqa: E501
+ type (str): Type of `split_transfer`.. [optional] # noqa: E501
+ merchant_id (str): The ID of the `Merchant` resource the `split_transfer` was created for and will settle under.. [optional] # noqa: E501
+ identity_id (str): The ID of `Identity` resource used by the `Merchant` the `split_transfer` was created for.. [optional] # noqa: E501
+ fee_profile_id (str): The `fee_profile` associated to this `split_transfer`.. [optional] # noqa: E501
+ application_id (str): The `application_id` associated to this `split_transfer`.. [optional] # noqa: E501
+ tags (SplitTransferTags): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """SplitTransfer - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ id (str): The ID of the `split_transfer` resource.. [optional] # noqa: E501
+ created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
+ updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
+ amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`. fraud_session_id:. [optional] # noqa: E501
+ currency (Currency): [optional] # noqa: E501
+ parent_transfer_id (str): **ID** of the original parent `Transfer` where the split was defined.. [optional] # noqa: E501
+ ready_to_settle_at (datetime, none_type): Timestamp of when the `Transfer` is ready to be settled at.. [optional] # noqa: E501
+ type (str): Type of `split_transfer`.. [optional] # noqa: E501
+ merchant_id (str): The ID of the `Merchant` resource the `split_transfer` was created for and will settle under.. [optional] # noqa: E501
+ identity_id (str): The ID of `Identity` resource used by the `Merchant` the `split_transfer` was created for.. [optional] # noqa: E501
+ fee_profile_id (str): The `fee_profile` associated to this `split_transfer`.. [optional] # noqa: E501
+ application_id (str): The `application_id` associated to this `split_transfer`.. [optional] # noqa: E501
+ tags (SplitTransferTags): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/split_transfer_tags.py b/finix/model/split_transfer_tags.py
new file mode 100644
index 0000000..6eecec2
--- /dev/null
+++ b/finix/model/split_transfer_tags.py
@@ -0,0 +1,250 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class SplitTransferTags(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'key': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'key': 'key', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """SplitTransferTags - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ key (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """SplitTransferTags - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ key (str): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/split_transfers_list.py b/finix/model/split_transfers_list.py
new file mode 100644
index 0000000..7899385
--- /dev/null
+++ b/finix/model/split_transfers_list.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.list_links import ListLinks
+ from finix.model.page_cursor import PageCursor
+ from finix.model.split_transfers_list_embedded import SplitTransfersListEmbedded
+ globals()['ListLinks'] = ListLinks
+ globals()['PageCursor'] = PageCursor
+ globals()['SplitTransfersListEmbedded'] = SplitTransfersListEmbedded
+
+
+class SplitTransfersList(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'embedded': (SplitTransfersListEmbedded,), # noqa: E501
+ 'links': (ListLinks,), # noqa: E501
+ 'page': (PageCursor,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'embedded': '_embedded', # noqa: E501
+ 'links': '_links', # noqa: E501
+ 'page': 'page', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """SplitTransfersList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (SplitTransfersListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """SplitTransfersList - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ embedded (SplitTransfersListEmbedded): [optional] # noqa: E501
+ links (ListLinks): [optional] # noqa: E501
+ page (PageCursor): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/split_transfers_list_embedded.py b/finix/model/split_transfers_list_embedded.py
new file mode 100644
index 0000000..1c0213c
--- /dev/null
+++ b/finix/model/split_transfers_list_embedded.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.split_transfers_list import SplitTransfersList
+ globals()['SplitTransfersList'] = SplitTransfersList
+
+
+class SplitTransfersListEmbedded(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'split_transfers': ([SplitTransfersList],), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'split_transfers': 'split_transfers', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """SplitTransfersListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ split_transfers ([SplitTransfersList]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """SplitTransfersListEmbedded - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ split_transfers ([SplitTransfersList]): `Payout Profile` objects.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/submit_dispute_evidence.py b/finix/model/submit_dispute_evidence.py
new file mode 100644
index 0000000..91ccfde
--- /dev/null
+++ b/finix/model/submit_dispute_evidence.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class SubmitDisputeEvidence(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'note': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'note': 'note', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, note, *args, **kwargs): # noqa: E501
+ """SubmitDisputeEvidence - a model defined in OpenAPI
+
+ Args:
+ note (str): Include a note or custom metadata to reference the `Dispute`
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.note = note
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, note, *args, **kwargs): # noqa: E501
+ """SubmitDisputeEvidence - a model defined in OpenAPI
+
+ Args:
+ note (str): Include a note or custom metadata to reference the `Dispute`
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.note = note
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/subscription_amount.py b/finix/model/subscription_amount.py
index ac81cc9..d1644fa 100644
--- a/finix/model/subscription_amount.py
+++ b/finix/model/subscription_amount.py
@@ -30,10 +30,8 @@
def lazy_import():
from finix.model.subscription_amount_fee_amount_data import SubscriptionAmountFeeAmountData
from finix.model.subscription_amount_links import SubscriptionAmountLinks
- from finix.model.tags import Tags
globals()['SubscriptionAmountFeeAmountData'] = SubscriptionAmountFeeAmountData
globals()['SubscriptionAmountLinks'] = SubscriptionAmountLinks
- globals()['Tags'] = Tags
class SubscriptionAmount(ModelNormal):
@@ -106,7 +104,7 @@ def openapi_types():
'fee_amount_data': (SubscriptionAmountFeeAmountData,), # noqa: E501
'nickname': (str,), # noqa: E501
'subscription_schedule': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (SubscriptionAmountLinks,), # noqa: E501
}
@@ -177,7 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
fee_amount_data (SubscriptionAmountFeeAmountData): [optional] # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
subscription_schedule (str): ID of the `Subscription Schedule`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionAmountLinks): [optional] # noqa: E501
"""
@@ -268,7 +266,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
fee_amount_data (SubscriptionAmountFeeAmountData): [optional] # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
subscription_schedule (str): ID of the `Subscription Schedule`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionAmountLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/subscription_enrollment.py b/finix/model/subscription_enrollment.py
index c270b15..5f01acf 100644
--- a/finix/model/subscription_enrollment.py
+++ b/finix/model/subscription_enrollment.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.subscription_enrollment_links import SubscriptionEnrollmentLinks
- from finix.model.tags import Tags
globals()['SubscriptionEnrollmentLinks'] = SubscriptionEnrollmentLinks
- globals()['Tags'] = Tags
class SubscriptionEnrollment(ModelNormal):
@@ -108,7 +106,7 @@ def openapi_types():
'nickname': (str,), # noqa: E501
'started_at': (str,), # noqa: E501
'subscription_schedule': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (SubscriptionEnrollmentLinks,), # noqa: E501
}
@@ -181,7 +179,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
started_at (str): When the `subscription_enrollment` will begin in **DateTime** format.. [optional] # noqa: E501
subscription_schedule (str): ID of the `Subscription Schedule`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionEnrollmentLinks): [optional] # noqa: E501
"""
@@ -273,7 +271,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
started_at (str): When the `subscription_enrollment` will begin in **DateTime** format.. [optional] # noqa: E501
subscription_schedule (str): ID of the `Subscription Schedule`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionEnrollmentLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/subscription_schedule.py b/finix/model/subscription_schedule.py
index b2caa6f..fd88624 100644
--- a/finix/model/subscription_schedule.py
+++ b/finix/model/subscription_schedule.py
@@ -31,11 +31,9 @@ def lazy_import():
from finix.model.subscription_schedule_fixed_time_interval_offset import SubscriptionScheduleFixedTimeIntervalOffset
from finix.model.subscription_schedule_links import SubscriptionScheduleLinks
from finix.model.subscription_schedule_period_offset import SubscriptionSchedulePeriodOffset
- from finix.model.tags import Tags
globals()['SubscriptionScheduleFixedTimeIntervalOffset'] = SubscriptionScheduleFixedTimeIntervalOffset
globals()['SubscriptionScheduleLinks'] = SubscriptionScheduleLinks
globals()['SubscriptionSchedulePeriodOffset'] = SubscriptionSchedulePeriodOffset
- globals()['Tags'] = Tags
class SubscriptionSchedule(ModelNormal):
@@ -117,7 +115,7 @@ def openapi_types():
'nickname': (str,), # noqa: E501
'period_offset': (SubscriptionSchedulePeriodOffset,), # noqa: E501
'subscription_type': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (SubscriptionScheduleLinks,), # noqa: E501
}
@@ -190,7 +188,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
period_offset (SubscriptionSchedulePeriodOffset): [optional] # noqa: E501
subscription_type (str): `Subscription Schedule` type.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionScheduleLinks): [optional] # noqa: E501
"""
@@ -282,7 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
nickname (str): Human readable name.. [optional] # noqa: E501
period_offset (SubscriptionSchedulePeriodOffset): [optional] # noqa: E501
subscription_type (str): `Subscription Schedule` type.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (SubscriptionScheduleLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/subscription_schedules_list_links.py b/finix/model/subscription_schedules_list_links.py
index 0201d98..5968f77 100644
--- a/finix/model/subscription_schedules_list_links.py
+++ b/finix/model/subscription_schedules_list_links.py
@@ -28,8 +28,8 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
class SubscriptionSchedulesListLinks(ModelNormal):
@@ -82,9 +82,9 @@ def openapi_types():
"""
lazy_import()
return {
- 'self': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'next': (ApplicationLinksApplicationProfile,), # noqa: E501
- 'last': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'self': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'next': (ApplicationLinksAuthorizations,), # noqa: E501
+ 'last': (ApplicationLinksAuthorizations,), # noqa: E501
}
@cached_property
@@ -139,9 +139,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- self (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- next (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- last (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ self (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ next (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ last (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,9 +223,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- self (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- next (ApplicationLinksApplicationProfile): [optional] # noqa: E501
- last (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ self (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ next (ApplicationLinksAuthorizations): [optional] # noqa: E501
+ last (ApplicationLinksAuthorizations): [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/transfer.py b/finix/model/transfer.py
index 7e4c720..d992347 100644
--- a/finix/model/transfer.py
+++ b/finix/model/transfer.py
@@ -29,18 +29,20 @@
def lazy_import():
from finix.model.additional_buyer_charges import AdditionalBuyerCharges
+ from finix.model.additional_healthcare_data import AdditionalHealthcareData
+ from finix.model.additional_purchase_data import AdditionalPurchaseData
from finix.model.card_present_details import CardPresentDetails
from finix.model.currency import Currency
from finix.model.fee_type import FeeType
from finix.model.messages import Messages
- from finix.model.tags import Tags
from finix.model.transfer_links import TransferLinks
globals()['AdditionalBuyerCharges'] = AdditionalBuyerCharges
+ globals()['AdditionalHealthcareData'] = AdditionalHealthcareData
+ globals()['AdditionalPurchaseData'] = AdditionalPurchaseData
globals()['CardPresentDetails'] = CardPresentDetails
globals()['Currency'] = Currency
globals()['FeeType'] = FeeType
globals()['Messages'] = Messages
- globals()['Tags'] = Tags
globals()['TransferLinks'] = TransferLinks
@@ -137,27 +139,36 @@ def openapi_types():
'created_at': (datetime,), # noqa: E501
'updated_at': (datetime,), # noqa: E501
'additional_buyer_charges': (AdditionalBuyerCharges,), # noqa: E501
+ 'additional_healthcare_data': (AdditionalHealthcareData,), # noqa: E501
+ 'additional_purchase_data': (AdditionalPurchaseData,), # noqa: E501
+ 'address_verification': (str, none_type,), # noqa: E501
'amount': (int,), # noqa: E501
- 'application': (str, none_type,), # noqa: E501
+ 'amount_requested': (int,), # noqa: E501
+ 'application': (str,), # noqa: E501
'card_present_details': (CardPresentDetails,), # noqa: E501
'currency': (Currency,), # noqa: E501
'destination': (str, none_type,), # noqa: E501
- 'device': (str, none_type,), # noqa: E501
+ 'device': (str,), # noqa: E501
'externally_funded': (str,), # noqa: E501
'failure_code': (str, none_type,), # noqa: E501
'failure_message': (str, none_type,), # noqa: E501
'fee': (int,), # noqa: E501
'fee_type': (FeeType,), # noqa: E501
'idempotency_id': (str, none_type,), # noqa: E501
- 'merchant_identity': (str, none_type,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'merchant_identity': (str,), # noqa: E501
+ 'parent_transfer': (str, none_type,), # noqa: E501
+ 'parent_transfer_trace_id': (str, none_type,), # noqa: E501
'messages': (Messages,), # noqa: E501
'raw': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'ready_to_settle_at': (datetime, none_type,), # noqa: E501
+ 'security_code_verification': (str, none_type,), # noqa: E501
'source': (str, none_type,), # noqa: E501
+ 'split_transfers': (str, none_type,), # noqa: E501
'state': (str,), # noqa: E501
'statement_descriptor': (str, none_type,), # noqa: E501
'subtype': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'trace_id': (str, none_type,), # noqa: E501
'type': (str,), # noqa: E501
'links': (TransferLinks,), # noqa: E501
@@ -173,7 +184,11 @@ def discriminator():
'created_at': 'created_at', # noqa: E501
'updated_at': 'updated_at', # noqa: E501
'additional_buyer_charges': 'additional_buyer_charges', # noqa: E501
+ 'additional_healthcare_data': 'additional_healthcare_data', # noqa: E501
+ 'additional_purchase_data': 'additional_purchase_data', # noqa: E501
+ 'address_verification': 'address_verification', # noqa: E501
'amount': 'amount', # noqa: E501
+ 'amount_requested': 'amount_requested', # noqa: E501
'application': 'application', # noqa: E501
'card_present_details': 'card_present_details', # noqa: E501
'currency': 'currency', # noqa: E501
@@ -185,11 +200,16 @@ def discriminator():
'fee': 'fee', # noqa: E501
'fee_type': 'fee_type', # noqa: E501
'idempotency_id': 'idempotency_id', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
'merchant_identity': 'merchant_identity', # noqa: E501
+ 'parent_transfer': 'parent_transfer', # noqa: E501
+ 'parent_transfer_trace_id': 'parent_transfer_trace_id', # noqa: E501
'messages': 'messages', # noqa: E501
'raw': 'raw', # noqa: E501
'ready_to_settle_at': 'ready_to_settle_at', # noqa: E501
+ 'security_code_verification': 'security_code_verification', # noqa: E501
'source': 'source', # noqa: E501
+ 'split_transfers': 'split_transfers', # noqa: E501
'state': 'state', # noqa: E501
'statement_descriptor': 'statement_descriptor', # noqa: E501
'subtype': 'subtype', # noqa: E501
@@ -244,27 +264,36 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
+ additional_healthcare_data (AdditionalHealthcareData): [optional] # noqa: E501
+ additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
+ address_verification (str, none_type): Details the results of the Address Verification checks.. [optional] # noqa: E501
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
- application (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ amount_requested (int): Details the `amount` that was requested to get debited from the `source` when the transaction was created.. [optional] # noqa: E501
+ application (str): The ID of the `Application` the `Transfer` was created under.. [optional] # noqa: E501
card_present_details (CardPresentDetails): [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
destination (str, none_type): The ID of the destination.. [optional] # noqa: E501
- device (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ device (str): The ID of the `Device` resource the `Transfer` was created under.. [optional] # noqa: E501
externally_funded (str): Details if the `Transfer` will be settled externally by card processors.. [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- fee (int): The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`. fraud_session_id:. [optional] # noqa: E501
fee_type (FeeType): [optional] # noqa: E501
- idempotency_id (str, none_type): ID to [idempotently](#section/Idempotency-Requests) identifty the transfer.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ idempotency_id (str, none_type): Pass any randomly generated or internal ID to [idempotently](/api/overview/#section/Idempotency-Requests) identify `Transfers`, `Authorizations`, and refund requests.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Transfer` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of `Identity` resource used by the `Merchant` the `Transfer` was created under.. [optional] # noqa: E501
+ parent_transfer (str, none_type): - ID of the original parent `Transfer` where the transaction occurred. - Only appears for `Transfers:type` **REVERSAL** and **FEE**.. [optional] # noqa: E501
+ parent_transfer_trace_id (str, none_type): - `trace_id` of the original parent `Transfer` where the transaction occurred. - Only appears for `Transfers:type` **REVERSAL** and **FEE**.. [optional] # noqa: E501
messages (Messages): [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
ready_to_settle_at (datetime, none_type): Timestamp of when the `Transfer` is ready to be settled at.. [optional] # noqa: E501
- source (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ security_code_verification (str, none_type): Details the results of the Security Code Verification checks.. [optional] # noqa: E501
+ source (str, none_type): The ID of the `Payment Instrument` that will be debited and performing the `Transfer`.. [optional] # noqa: E501
+ split_transfers (str, none_type): - The ID of the `split_transfer` resources moving funds from the primary `Transfer` to the specified `Merchants.` - Only used for Split Transactions. For more information, see [Split Transactions](/docs/guides/payments/modify/split-transactions/).. [optional] # noqa: E501
state (str): The stauts of the `Transfer`.. [optional] # noqa: E501
- statement_descriptor (str, none_type): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ statement_descriptor (str, none_type): - The description of the seller that appears on the buyer's bank or card statement.
- statement_descriptors for `Transfers` in live enviroments will have a FI * prefix.. [optional] # noqa: E501
subtype (str): Additional information describing the `payment_type`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str, none_type): Trace ID of the `Transfer`. The processor sends back the `trace_id` so you can track the `Transfer` end-to-end.. [optional] # noqa: E501
type (str): Type of `Transfer`.. [optional] # noqa: E501
links (TransferLinks): [optional] # noqa: E501
@@ -353,27 +382,36 @@ def __init__(self, *args, **kwargs): # noqa: E501
created_at (datetime): Timestamp of when the object was created.. [optional] # noqa: E501
updated_at (datetime): Timestamp of when the object was last updated.. [optional] # noqa: E501
additional_buyer_charges (AdditionalBuyerCharges): [optional] # noqa: E501
+ additional_healthcare_data (AdditionalHealthcareData): [optional] # noqa: E501
+ additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
+ address_verification (str, none_type): Details the results of the Address Verification checks.. [optional] # noqa: E501
amount (int): The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).. [optional] # noqa: E501
- application (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ amount_requested (int): Details the `amount` that was requested to get debited from the `source` when the transaction was created.. [optional] # noqa: E501
+ application (str): The ID of the `Application` the `Transfer` was created under.. [optional] # noqa: E501
card_present_details (CardPresentDetails): [optional] # noqa: E501
currency (Currency): [optional] # noqa: E501
destination (str, none_type): The ID of the destination.. [optional] # noqa: E501
- device (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ device (str): The ID of the `Device` resource the `Transfer` was created under.. [optional] # noqa: E501
externally_funded (str): Details if the `Transfer` will be settled externally by card processors.. [optional] # noqa: E501
- failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
+ failure_code (str, none_type): The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).. [optional] # noqa: E501
failure_message (str, none_type): A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.. [optional] # noqa: E501
- fee (int): The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
+ fee (int): The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`. fraud_session_id:. [optional] # noqa: E501
fee_type (FeeType): [optional] # noqa: E501
- idempotency_id (str, none_type): ID to [idempotently](#section/Idempotency-Requests) identifty the transfer.. [optional] # noqa: E501
- merchant_identity (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ idempotency_id (str, none_type): Pass any randomly generated or internal ID to [idempotently](/api/overview/#section/Idempotency-Requests) identify `Transfers`, `Authorizations`, and refund requests.. [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` resource the `Transfer` was created under.. [optional] # noqa: E501
+ merchant_identity (str): The ID of `Identity` resource used by the `Merchant` the `Transfer` was created under.. [optional] # noqa: E501
+ parent_transfer (str, none_type): - ID of the original parent `Transfer` where the transaction occurred. - Only appears for `Transfers:type` **REVERSAL** and **FEE**.. [optional] # noqa: E501
+ parent_transfer_trace_id (str, none_type): - `trace_id` of the original parent `Transfer` where the transaction occurred. - Only appears for `Transfers:type` **REVERSAL** and **FEE**.. [optional] # noqa: E501
messages (Messages): [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
ready_to_settle_at (datetime, none_type): Timestamp of when the `Transfer` is ready to be settled at.. [optional] # noqa: E501
- source (str, none_type): The ID of the resource.. [optional] # noqa: E501
+ security_code_verification (str, none_type): Details the results of the Security Code Verification checks.. [optional] # noqa: E501
+ source (str, none_type): The ID of the `Payment Instrument` that will be debited and performing the `Transfer`.. [optional] # noqa: E501
+ split_transfers (str, none_type): - The ID of the `split_transfer` resources moving funds from the primary `Transfer` to the specified `Merchants.` - Only used for Split Transactions. For more information, see [Split Transactions](/docs/guides/payments/modify/split-transactions/).. [optional] # noqa: E501
state (str): The stauts of the `Transfer`.. [optional] # noqa: E501
- statement_descriptor (str, none_type): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ statement_descriptor (str, none_type):
- The description of the seller that appears on the buyer's bank or card statement.
- statement_descriptors for `Transfers` in live enviroments will have a FI * prefix.. [optional] # noqa: E501
subtype (str): Additional information describing the `payment_type`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str, none_type): Trace ID of the `Transfer`. The processor sends back the `trace_id` so you can track the `Transfer` end-to-end.. [optional] # noqa: E501
type (str): Type of `Transfer`.. [optional] # noqa: E501
links (TransferLinks): [optional] # noqa: E501
diff --git a/finix/model/update_application_profile_request.py b/finix/model/update_application_profile_request.py
index 1741290..07f0319 100644
--- a/finix/model/update_application_profile_request.py
+++ b/finix/model/update_application_profile_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateApplicationProfileRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,11 +75,10 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'fee_profile': (str, none_type,), # noqa: E501
- 'risk_profile': (str, none_type,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'fee_profile': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
+ 'risk_profile': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -139,9 +133,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- fee_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- risk_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ fee_profile ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The ID of the `Fee Profile` associated with the `Application`.. [optional] # noqa: E501
+ risk_profile ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The ID of the `Risk Profile` associated with the `Application`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,9 +217,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- fee_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- risk_profile (str, none_type): The ID of the resource.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ fee_profile ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The ID of the `Fee Profile` associated with the `Application`.. [optional] # noqa: E501
+ risk_profile ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The ID of the `Risk Profile` associated with the `Application`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_authorization_request.py b/finix/model/update_authorization_request.py
index a69e78c..21729a2 100644
--- a/finix/model/update_authorization_request.py
+++ b/finix/model/update_authorization_request.py
@@ -29,9 +29,7 @@
def lazy_import():
from finix.model.additional_purchase_data import AdditionalPurchaseData
- from finix.model.tags import Tags
globals()['AdditionalPurchaseData'] = AdditionalPurchaseData
- globals()['Tags'] = Tags
class UpdateAuthorizationRequest(ModelNormal):
@@ -87,7 +85,7 @@ def openapi_types():
'additional_purchase_data': (AdditionalPurchaseData,), # noqa: E501
'capture_amount': (int,), # noqa: E501
'fee': (int,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'void_me': (bool,), # noqa: E501
}
@@ -147,8 +145,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
capture_amount (int): The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`.. [optional] # noqa: E501
- fee (int): The amount of the `Authorization` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ fee (int): The minimum amount of the `Authorization` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
"""
@@ -233,8 +231,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_purchase_data (AdditionalPurchaseData): [optional] # noqa: E501
capture_amount (int): The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`.. [optional] # noqa: E501
- fee (int): The amount of the `Authorization` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ fee (int): The minimum amount of the `Authorization` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). - If the fees applied by the 'Fee Profile' are ***higher*** than the value passed in 'fee', 'fee' will not be applied and have no effect. - If the fees applied by the 'Fee Profile' are ***lower*** than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the `Fee Profile`. - The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the `Fee Profile`.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
"""
diff --git a/finix/model/update_compliance_form_request_pci_saq_a.py b/finix/model/update_compliance_form_request_pci_saq_a.py
index f40bda0..9cc8693 100644
--- a/finix/model/update_compliance_form_request_pci_saq_a.py
+++ b/finix/model/update_compliance_form_request_pci_saq_a.py
@@ -76,11 +76,11 @@ def openapi_types():
and the value is attribute type.
"""
return {
+ 'ip_address': (str,), # noqa: E501
'name': (str,), # noqa: E501
'signed_at': (str,), # noqa: E501
- 'user_agent': (str,), # noqa: E501
- 'ip_address': (str,), # noqa: E501
'title': (str,), # noqa: E501
+ 'user_agent': (str,), # noqa: E501
}
@cached_property
@@ -89,11 +89,11 @@ def discriminator():
attribute_map = {
+ 'ip_address': 'ip_address', # noqa: E501
'name': 'name', # noqa: E501
'signed_at': 'signed_at', # noqa: E501
- 'user_agent': 'user_agent', # noqa: E501
- 'ip_address': 'ip_address', # noqa: E501
'title': 'title', # noqa: E501
+ 'user_agent': 'user_agent', # noqa: E501
}
read_only_vars = {
@@ -137,11 +137,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ ip_address (str): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
name (str): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
signed_at (str): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- user_agent (str): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- ip_address (str): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
title (str): Title or role of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ user_agent (str): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -223,11 +223,11 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ ip_address (str): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
name (str): Name of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
signed_at (str): Timestamp of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- user_agent (str): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
- ip_address (str): IP address of the person attesting to this `compliance_form`.. [optional] # noqa: E501
title (str): Title or role of the person completing (aka attesting to) the `compliance_form`.. [optional] # noqa: E501
+ user_agent (str): User agent of the person attesting to this `compliance_form`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_device_request.py b/finix/model/update_device_request.py
index dfb91d5..2005c48 100644
--- a/finix/model/update_device_request.py
+++ b/finix/model/update_device_request.py
@@ -28,8 +28,8 @@
def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
+ from finix.model.configuration_details import ConfigurationDetails
+ globals()['ConfigurationDetails'] = ConfigurationDetails
class UpdateDeviceRequest(ModelNormal):
@@ -55,7 +55,10 @@ class UpdateDeviceRequest(ModelNormal):
allowed_values = {
('action',): {
+ 'ACTIVATE': "ACTIVATE",
+ 'CREATE_IDLE_MESSAGE': "CREATE_IDLE_MESSAGE",
'DEACTIVATE': "DEACTIVATE",
+ 'REBOOT': "REBOOT",
},
}
@@ -86,9 +89,13 @@ def openapi_types():
lazy_import()
return {
'action': (str,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'activation_code': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
'idle_message': (str,), # noqa: E501
+ 'configuration_details': (ConfigurationDetails,), # noqa: E501
+ 'description': (str,), # noqa: E501
+ 'name': (str,), # noqa: E501
+ 'serial_number': (str,), # noqa: E501
}
@cached_property
@@ -98,9 +105,13 @@ def discriminator():
attribute_map = {
'action': 'action', # noqa: E501
- 'activation_code': 'activation_code', # noqa: E501
'tags': 'tags', # noqa: E501
+ 'activation_code': 'activation_code', # noqa: E501
'idle_message': 'idle_message', # noqa: E501
+ 'configuration_details': 'configuration_details', # noqa: E501
+ 'description': 'description', # noqa: E501
+ 'name': 'name', # noqa: E501
+ 'serial_number': 'serial_number', # noqa: E501
}
read_only_vars = {
@@ -144,10 +155,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- action (str): The action you want to perform on the device. Use **DEACTIVATE** to deactivate the device.. [optional] if omitted the server will use the default value of "DEACTIVATE" # noqa: E501
+ action (str): The action you want to perform on the device. Use **DEACTIVATE** to deactivate the device.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
activation_code (str): Used when `action` is **ACTIVATE**. Provide the input code that shows up on the device screen.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
idle_message (str): Message to display on the idle screen.. [optional] # noqa: E501
+ configuration_details (ConfigurationDetails): [optional] # noqa: E501
+ description (str): Additional information about device (e.g. self serving terminal).. [optional] # noqa: E501
+ name (str): Name of the `Device`.. [optional] # noqa: E501
+ serial_number (str): Serial number of the `device`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,10 +244,14 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- action (str): The action you want to perform on the device. Use **DEACTIVATE** to deactivate the device.. [optional] if omitted the server will use the default value of "DEACTIVATE" # noqa: E501
+ action (str): The action you want to perform on the device. Use **DEACTIVATE** to deactivate the device.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
activation_code (str): Used when `action` is **ACTIVATE**. Provide the input code that shows up on the device screen.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
idle_message (str): Message to display on the idle screen.. [optional] # noqa: E501
+ configuration_details (ConfigurationDetails): [optional] # noqa: E501
+ description (str): Additional information about device (e.g. self serving terminal).. [optional] # noqa: E501
+ name (str): Name of the `Device`.. [optional] # noqa: E501
+ serial_number (str): Serial number of the `device`.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_dispute_evidence.py b/finix/model/update_dispute_evidence.py
new file mode 100644
index 0000000..b1553a1
--- /dev/null
+++ b/finix/model/update_dispute_evidence.py
@@ -0,0 +1,256 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdateDisputeEvidence(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'tags': 'tags', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, tags, *args, **kwargs): # noqa: E501
+ """UpdateDisputeEvidence - a model defined in OpenAPI
+
+ Args:
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.)
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.tags = tags
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, tags, *args, **kwargs): # noqa: E501
+ """UpdateDisputeEvidence - a model defined in OpenAPI
+
+ Args:
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.)
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ self.tags = tags
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_identity_request.py b/finix/model/update_identity_request.py
index 65ac765..abaf3fb 100644
--- a/finix/model/update_identity_request.py
+++ b/finix/model/update_identity_request.py
@@ -28,10 +28,8 @@
def lazy_import():
- from finix.model.tags import Tags
from finix.model.update_identity_request_additional_underwriting_data import UpdateIdentityRequestAdditionalUnderwritingData
from finix.model.update_identity_request_entity import UpdateIdentityRequestEntity
- globals()['Tags'] = Tags
globals()['UpdateIdentityRequestAdditionalUnderwritingData'] = UpdateIdentityRequestAdditionalUnderwritingData
globals()['UpdateIdentityRequestEntity'] = UpdateIdentityRequestEntity
@@ -88,7 +86,7 @@ def openapi_types():
return {
'additional_underwriting_data': (UpdateIdentityRequestAdditionalUnderwritingData,), # noqa: E501
'entity': (UpdateIdentityRequestEntity,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -145,7 +143,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_underwriting_data (UpdateIdentityRequestAdditionalUnderwritingData): [optional] # noqa: E501
entity (UpdateIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,7 +227,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
additional_underwriting_data (UpdateIdentityRequestAdditionalUnderwritingData): [optional] # noqa: E501
entity (UpdateIdentityRequestEntity): [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_identity_request_entity.py b/finix/model/update_identity_request_entity.py
index 0c35b07..4aa2774 100644
--- a/finix/model/update_identity_request_entity.py
+++ b/finix/model/update_identity_request_entity.py
@@ -28,7 +28,13 @@
def lazy_import():
+ from finix.model.identity_entity_form_incorporation_date import IdentityEntityFormIncorporationDate
+ from finix.model.update_identity_request_entity_business_address import UpdateIdentityRequestEntityBusinessAddress
+ from finix.model.update_identity_request_entity_dob import UpdateIdentityRequestEntityDob
from finix.model.update_identity_request_entity_personal_address import UpdateIdentityRequestEntityPersonalAddress
+ globals()['IdentityEntityFormIncorporationDate'] = IdentityEntityFormIncorporationDate
+ globals()['UpdateIdentityRequestEntityBusinessAddress'] = UpdateIdentityRequestEntityBusinessAddress
+ globals()['UpdateIdentityRequestEntityDob'] = UpdateIdentityRequestEntityDob
globals()['UpdateIdentityRequestEntityPersonalAddress'] = UpdateIdentityRequestEntityPersonalAddress
@@ -54,9 +60,64 @@ class UpdateIdentityRequestEntity(ModelNormal):
"""
allowed_values = {
+ ('business_type',): {
+ 'INDIVIDUAL_SOLE_PROPRIETORSHIP': "INDIVIDUAL_SOLE_PROPRIETORSHIP",
+ 'CORPORATION': "CORPORATION",
+ 'LIMITED_LIABILITY_COMPANY': "LIMITED_LIABILITY_COMPANY",
+ 'PARTNERSHIP': "PARTNERSHIP",
+ 'ASSOCIATION_ESTATE_TRUST': "ASSOCIATION_ESTATE_TRUST",
+ 'TAX_EXEMPT_ORGANIZATION': "TAX_EXEMPT_ORGANIZATION",
+ 'INTERNATIONAL_ORGANIZATION': "INTERNATIONAL_ORGANIZATION",
+ 'GOVERNMENT_AGENCY': "GOVERNMENT_AGENCY",
+ },
}
validations = {
+ ('business_name',): {
+ 'min_length': 1,
+ },
+ ('business_phone',): {
+ 'min_length': 1,
+ },
+ ('business_tax_id',): {
+ 'min_length': 1,
+ },
+ ('business_type',): {
+ 'min_length': 1,
+ },
+ ('default_statement_descriptor',): {
+ 'min_length': 1,
+ },
+ ('doing_business_as',): {
+ 'min_length': 1,
+ },
+ ('email',): {
+ 'min_length': 1,
+ },
+ ('first_name',): {
+ 'min_length': 1,
+ },
+ ('last_name',): {
+ 'min_length': 1,
+ },
+ ('mcc',): {
+ 'min_length': 1,
+ },
+ ('ownership_type',): {
+ 'min_length': 1,
+ },
+ ('phone',): {
+ 'min_length': 1,
+ },
+ ('tax_id',): {
+ 'min_length': 1,
+ },
+ ('title',): {
+ 'min_length': 1,
+ },
+ ('url',): {
+ 'min_length': 1,
+ },
}
@cached_property
@@ -82,11 +143,29 @@ def openapi_types():
"""
lazy_import()
return {
+ 'annual_card_volume': (int,), # noqa: E501
+ 'business_address': (UpdateIdentityRequestEntityBusinessAddress,), # noqa: E501
+ 'business_name': (str, none_type,), # noqa: E501
+ 'business_phone': (str,), # noqa: E501
+ 'business_tax_id': (str,), # noqa: E501
+ 'business_type': (str,), # noqa: E501
+ 'default_statement_descriptor': (str,), # noqa: E501
+ 'dob': (UpdateIdentityRequestEntityDob,), # noqa: E501
+ 'doing_business_as': (str,), # noqa: E501
'email': (str,), # noqa: E501
'first_name': (str,), # noqa: E501
+ 'has_accepted_credit_cards_previously': (bool,), # noqa: E501
+ 'incorporation_date': (IdentityEntityFormIncorporationDate,), # noqa: E501
'last_name': (str,), # noqa: E501
+ 'max_transaction_amount': (int,), # noqa: E501
+ 'mcc': (str,), # noqa: E501
+ 'ownership_type': (str, none_type,), # noqa: E501
'personal_address': (UpdateIdentityRequestEntityPersonalAddress,), # noqa: E501
'phone': (str,), # noqa: E501
+ 'principal_percentage_ownership': (int,), # noqa: E501
+ 'tax_id': (str,), # noqa: E501
+ 'title': (str,), # noqa: E501
+ 'url': (str,), # noqa: E501
}
@cached_property
@@ -95,11 +174,29 @@ def discriminator():
attribute_map = {
+ 'annual_card_volume': 'annual_card_volume', # noqa: E501
+ 'business_address': 'business_address', # noqa: E501
+ 'business_name': 'business_name', # noqa: E501
+ 'business_phone': 'business_phone', # noqa: E501
+ 'business_tax_id': 'business_tax_id', # noqa: E501
+ 'business_type': 'business_type', # noqa: E501
+ 'default_statement_descriptor': 'default_statement_descriptor', # noqa: E501
+ 'dob': 'dob', # noqa: E501
+ 'doing_business_as': 'doing_business_as', # noqa: E501
'email': 'email', # noqa: E501
'first_name': 'first_name', # noqa: E501
+ 'has_accepted_credit_cards_previously': 'has_accepted_credit_cards_previously', # noqa: E501
+ 'incorporation_date': 'incorporation_date', # noqa: E501
'last_name': 'last_name', # noqa: E501
+ 'max_transaction_amount': 'max_transaction_amount', # noqa: E501
+ 'mcc': 'mcc', # noqa: E501
+ 'ownership_type': 'ownership_type', # noqa: E501
'personal_address': 'personal_address', # noqa: E501
'phone': 'phone', # noqa: E501
+ 'principal_percentage_ownership': 'principal_percentage_ownership', # noqa: E501
+ 'tax_id': 'tax_id', # noqa: E501
+ 'title': 'title', # noqa: E501
+ 'url': 'url', # noqa: E501
}
read_only_vars = {
@@ -143,11 +240,29 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ annual_card_volume (int): The annual credit card sales (in cents) expected to be processed (max 19 characters).. [optional] # noqa: E501
+ business_address (UpdateIdentityRequestEntityBusinessAddress): [optional] # noqa: E501
+ business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
+ business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).. [optional] # noqa: E501
+ business_type (str): Include the value that best applies to the merchant.. [optional] # noqa: E501
+ default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ dob (UpdateIdentityRequestEntityDob): [optional] # noqa: E501
+ doing_business_as (str): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).. [optional] # noqa: E501
email (str): The email address of the buyer (max 100 characters).. [optional] # noqa: E501
first_name (str): The legal first name of the buyer (max 20 characters).. [optional] # noqa: E501
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str): The legal last name of the buyer (max 20 characters).. [optional] # noqa: E501
+ max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (UpdateIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
phone (str): Phone number where the buyer can be reached.. [optional] # noqa: E501
+ principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
+ tax_id (str): Details if the `tax_id` was provided.. [optional] # noqa: E501
+ title (str): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
+ url (str): The URL of the `Identity` owner's public website.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -229,11 +344,29 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
+ annual_card_volume (int): The annual credit card sales (in cents) expected to be processed (max 19 characters).. [optional] # noqa: E501
+ business_address (UpdateIdentityRequestEntityBusinessAddress): [optional] # noqa: E501
+ business_name (str, none_type): Abbreviated names of the business. If there are no abbreviated name, leave this field blank.. [optional] # noqa: E501
+ business_phone (str): Customer service phone number where the merchant can be reached (max 10 characters).. [optional] # noqa: E501
+ business_tax_id (str): Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).. [optional] # noqa: E501
+ business_type (str): Include the value that best applies to the merchant.. [optional] # noqa: E501
+ default_statement_descriptor (str): The description of the merchant that appears on the buyer's bank or card statement.. [optional] # noqa: E501
+ dob (UpdateIdentityRequestEntityDob): [optional] # noqa: E501
+ doing_business_as (str): Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).. [optional] # noqa: E501
email (str): The email address of the buyer (max 100 characters).. [optional] # noqa: E501
first_name (str): The legal first name of the buyer (max 20 characters).. [optional] # noqa: E501
+ has_accepted_credit_cards_previously (bool): Defaults to **false** if not passed.. [optional] # noqa: E501
+ incorporation_date (IdentityEntityFormIncorporationDate): [optional] # noqa: E501
last_name (str): The legal last name of the buyer (max 20 characters).. [optional] # noqa: E501
+ max_transaction_amount (int): The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).. [optional] # noqa: E501
+ mcc (str): The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/). [optional] # noqa: E501
+ ownership_type (str, none_type): Values can be either:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.. [optional] # noqa: E501
personal_address (UpdateIdentityRequestEntityPersonalAddress): [optional] # noqa: E501
phone (str): Phone number where the buyer can be reached.. [optional] # noqa: E501
+ principal_percentage_ownership (int): Percentage of the company owned by the principal control owner (min 0; max 100).. [optional] # noqa: E501
+ tax_id (str): Details if the `tax_id` was provided.. [optional] # noqa: E501
+ title (str): The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).. [optional] # noqa: E501
+ url (str): The URL of the `Identity` owner's public website.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_identity_request_entity_business_address.py b/finix/model/update_identity_request_entity_business_address.py
new file mode 100644
index 0000000..ea22a75
--- /dev/null
+++ b/finix/model/update_identity_request_entity_business_address.py
@@ -0,0 +1,288 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdateIdentityRequestEntityBusinessAddress(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ ('city',): {
+ 'min_length': 1,
+ },
+ ('country',): {
+ 'min_length': 1,
+ },
+ ('region',): {
+ 'min_length': 1,
+ },
+ ('line2',): {
+ 'min_length': 1,
+ },
+ ('line1',): {
+ 'min_length': 1,
+ },
+ ('postal_code',): {
+ 'min_length': 1,
+ },
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'city': (str,), # noqa: E501
+ 'country': (str,), # noqa: E501
+ 'region': (str,), # noqa: E501
+ 'line2': (str,), # noqa: E501
+ 'line1': (str,), # noqa: E501
+ 'postal_code': (str,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'city': 'city', # noqa: E501
+ 'country': 'country', # noqa: E501
+ 'region': 'region', # noqa: E501
+ 'line2': 'line2', # noqa: E501
+ 'line1': 'line1', # noqa: E501
+ 'postal_code': 'postal_code', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdateIdentityRequestEntityBusinessAddress - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ city (str): City (max 20 characters).. [optional] # noqa: E501
+ country (str): [optional] # noqa: E501
+ region (str): 2-letter state code.. [optional] # noqa: E501
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdateIdentityRequestEntityBusinessAddress - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ city (str): City (max 20 characters).. [optional] # noqa: E501
+ country (str): [optional] # noqa: E501
+ region (str): 2-letter state code.. [optional] # noqa: E501
+ line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_identity_request_entity_dob.py b/finix/model/update_identity_request_entity_dob.py
new file mode 100644
index 0000000..c6256cc
--- /dev/null
+++ b/finix/model/update_identity_request_entity_dob.py
@@ -0,0 +1,258 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdateIdentityRequestEntityDob(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day': (int,), # noqa: E501
+ 'month': (int,), # noqa: E501
+ 'year': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day': 'day', # noqa: E501
+ 'month': 'month', # noqa: E501
+ 'year': 'year', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdateIdentityRequestEntityDob - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day (int): Day of birth (between 1 and 31).. [optional] # noqa: E501
+ month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year of birth (4-digits).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdateIdentityRequestEntityDob - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day (int): Day of birth (between 1 and 31).. [optional] # noqa: E501
+ month (int): Month of birth (between 1 and 12).. [optional] # noqa: E501
+ year (int): Year of birth (4-digits).. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_identity_request_entity_personal_address.py b/finix/model/update_identity_request_entity_personal_address.py
index 3f4d6b9..b8ddad0 100644
--- a/finix/model/update_identity_request_entity_personal_address.py
+++ b/finix/model/update_identity_request_entity_personal_address.py
@@ -53,6 +53,24 @@ class UpdateIdentityRequestEntityPersonalAddress(ModelNormal):
}
validations = {
+ ('city',): {
+ 'min_length': 1,
+ },
+ ('country',): {
+ 'min_length': 1,
+ },
+ ('region',): {
+ 'min_length': 1,
+ },
+ ('line2',): {
+ 'min_length': 1,
+ },
+ ('line1',): {
+ 'min_length': 1,
+ },
+ ('postal_code',): {
+ 'min_length': 1,
+ },
}
@cached_property
@@ -78,8 +96,9 @@ def openapi_types():
return {
'city': (str,), # noqa: E501
'country': (str,), # noqa: E501
- 'line1': (str,), # noqa: E501
+ 'region': (str,), # noqa: E501
'line2': (str,), # noqa: E501
+ 'line1': (str,), # noqa: E501
'postal_code': (str,), # noqa: E501
}
@@ -91,8 +110,9 @@ def discriminator():
attribute_map = {
'city': 'city', # noqa: E501
'country': 'country', # noqa: E501
- 'line1': 'line1', # noqa: E501
+ 'region': 'region', # noqa: E501
'line2': 'line2', # noqa: E501
+ 'line1': 'line1', # noqa: E501
'postal_code': 'postal_code', # noqa: E501
}
@@ -139,8 +159,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ region (str): 2-letter State code.. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
"""
@@ -225,8 +246,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
city (str): City (max 20 characters).. [optional] # noqa: E501
country (str): 3-Letter country code (e.g. USA).. [optional] # noqa: E501
- line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
+ region (str): 2-letter State code.. [optional] # noqa: E501
line2 (str): Second line of the address (max 35 characters).. [optional] # noqa: E501
+ line1 (str): First line of the address (max 35 characters).. [optional] # noqa: E501
postal_code (str): Zip or Postal code (max 7 characters).. [optional] # noqa: E501
"""
diff --git a/finix/model/update_merchant_profile_request.py b/finix/model/update_merchant_profile_request.py
index 88465fd..6da47b7 100644
--- a/finix/model/update_merchant_profile_request.py
+++ b/finix/model/update_merchant_profile_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateMerchantProfileRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,11 +75,11 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'fee_profile': (str,), # noqa: E501
+ 'payout_profile': (str,), # noqa: E501
'risk_profile': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -94,6 +89,7 @@ def discriminator():
attribute_map = {
'fee_profile': 'fee_profile', # noqa: E501
+ 'payout_profile': 'payout_profile', # noqa: E501
'risk_profile': 'risk_profile', # noqa: E501
'tags': 'tags', # noqa: E501
}
@@ -140,8 +136,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
fee_profile (str): ID of the `fee_profile`.. [optional] # noqa: E501
+ payout_profile (str): ID of the `payout_profile`.. [optional] # noqa: E501
risk_profile (str): ID of the `risk_profile`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -224,8 +221,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
fee_profile (str): ID of the `fee_profile`.. [optional] # noqa: E501
+ payout_profile (str): ID of the `payout_profile`.. [optional] # noqa: E501
risk_profile (str): ID of the `risk_profile`.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_merchant_request.py b/finix/model/update_merchant_request.py
index 4c389f5..b4cfb2a 100644
--- a/finix/model/update_merchant_request.py
+++ b/finix/model/update_merchant_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateMerchantRequest(ModelNormal):
"""
@@ -54,6 +50,11 @@ class UpdateMerchantRequest(ModelNormal):
"""
allowed_values = {
+ ('settlement_funding_identifier',): {
+ 'MID_AND_DATE': "MID_AND_DATE",
+ 'MID_AND_MERCHANT_NAME': "MID_AND_MERCHANT_NAME",
+ 'UNSET': "UNSET",
+ },
}
validations = {
@@ -65,7 +66,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,7 +80,6 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'card_cvv_required': (bool,), # noqa: E501
'card_expiration_date_required': (bool,), # noqa: E501
@@ -95,7 +94,8 @@ def openapi_types():
'rent_surcharges_enabled': (bool,), # noqa: E501
'settlement_enabled': (bool,), # noqa: E501
'settlement_funding_identifier': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'surcharge_fees_enabled': (bool,), # noqa: E501
}
@cached_property
@@ -118,6 +118,7 @@ def discriminator():
'settlement_enabled': 'settlement_enabled', # noqa: E501
'settlement_funding_identifier': 'settlement_funding_identifier', # noqa: E501
'tags': 'tags', # noqa: E501
+ 'surcharge_fees_enabled': 'surcharge_fees_enabled', # noqa: E501
}
read_only_vars = {
@@ -170,11 +171,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
level_two_level_three_data_enabled (bool): Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.. [optional] # noqa: E501
merchant_name (str): The legal name saved in the `Merchant` resource.. [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Merchant`.. [optional] # noqa: E501
- ready_to_settle_upon (str): Details how `Authorizations` captured by the `Merchant` are settled.. [optional] # noqa: E501
+ ready_to_settle_upon (str): Details how transactions captured by the `Merchant` are settled.. [optional] # noqa: E501
rent_surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept rent charges.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Merchant`.. [optional] # noqa: E501
- settlement_funding_identifier (str): Include addtional information (like the MID) when submitting funding `Tranfers` to processors.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ surcharge_fees_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept surcharge fees.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -265,11 +267,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
level_two_level_three_data_enabled (bool): Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.. [optional] # noqa: E501
merchant_name (str): The legal name saved in the `Merchant` resource.. [optional] # noqa: E501
processing_enabled (bool): Details if transaction processing is enabled for the `Merchant`.. [optional] # noqa: E501
- ready_to_settle_upon (str): Details how `Authorizations` captured by the `Merchant` are settled.. [optional] # noqa: E501
+ ready_to_settle_upon (str): Details how transactions captured by the `Merchant` are settled.. [optional] # noqa: E501
rent_surcharges_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept rent charges.. [optional] # noqa: E501
settlement_enabled (bool): Details if settlement processing is enabled for the `Merchant`.. [optional] # noqa: E501
- settlement_funding_identifier (str): Include addtional information (like the MID) when submitting funding `Tranfers` to processors.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ settlement_funding_identifier (str): Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - **UNSET**: No additional details get provided to the processor. - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225** - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant** These details appear alongside the seller's payout in their bank account as a description of the deposit.. [optional] if omitted the server will use the default value of "UNSET" # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ surcharge_fees_enabled (bool): Set to **true** if you want to enable a `Merchant` to accept surcharge fees.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_payment_instrument_request.py b/finix/model/update_payment_instrument_request.py
index ccceebc..dc4dd88 100644
--- a/finix/model/update_payment_instrument_request.py
+++ b/finix/model/update_payment_instrument_request.py
@@ -28,8 +28,8 @@
def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
+ from finix.model.address import Address
+ globals()['Address'] = Address
class UpdatePaymentInstrumentRequest(ModelNormal):
@@ -82,7 +82,13 @@ def openapi_types():
"""
lazy_import()
return {
- 'tags': (Tags,), # noqa: E501
+ 'address': (Address,), # noqa: E501
+ 'merchant': (str,), # noqa: E501
+ 'verify_payment_card': (bool,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'enabled': (bool,), # noqa: E501
+ 'name': (str,), # noqa: E501
+ 'attempt_bank_account_validation_check': (bool,), # noqa: E501
}
@cached_property
@@ -91,7 +97,13 @@ def discriminator():
attribute_map = {
+ 'address': 'address', # noqa: E501
+ 'merchant': 'merchant', # noqa: E501
+ 'verify_payment_card': 'verify_payment_card', # noqa: E501
'tags': 'tags', # noqa: E501
+ 'enabled': 'enabled', # noqa: E501
+ 'name': 'name', # noqa: E501
+ 'attempt_bank_account_validation_check': 'attempt_bank_account_validation_check', # noqa: E501
}
read_only_vars = {
@@ -135,7 +147,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ address (Address): [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` that the `Payment Instrument` will be created under.. [optional] if omitted the server will use the default value of "false" # noqa: E501
+ verify_payment_card (bool): - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. - When set to **true**, `merchant` must also be included with your request.. [optional] if omitted the server will use the default value of False # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.. [optional] # noqa: E501
+ name (str): The name of the bank account or card owner. This value can get truncated to comply with processor requirements.. [optional] if omitted the server will use the default value of "false" # noqa: E501
+ attempt_bank_account_validation_check (bool): Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/) - Set to **True** to verify the `Payment Instrument` can be used for ACH payments. - Only `Payment Instruments` created from bank accounts can be used for ACH payments.. [optional] if omitted the server will use the default value of False # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +235,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ address (Address): [optional] # noqa: E501
+ merchant (str): The ID of the `Merchant` that the `Payment Instrument` will be created under.. [optional] if omitted the server will use the default value of "false" # noqa: E501
+ verify_payment_card (bool): - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. - When set to **true**, `merchant` must also be included with your request.. [optional] if omitted the server will use the default value of False # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ enabled (bool): Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.. [optional] # noqa: E501
+ name (str): The name of the bank account or card owner. This value can get truncated to comply with processor requirements.. [optional] if omitted the server will use the default value of "false" # noqa: E501
+ attempt_bank_account_validation_check (bool): Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/) - Set to **True** to verify the `Payment Instrument` can be used for ACH payments. - Only `Payment Instruments` created from bank accounts can be used for ACH payments.. [optional] if omitted the server will use the default value of False # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_payout_profile_request.py b/finix/model/update_payout_profile_request.py
new file mode 100644
index 0000000..d86226c
--- /dev/null
+++ b/finix/model/update_payout_profile_request.py
@@ -0,0 +1,275 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.update_payout_profile_request_gross import UpdatePayoutProfileRequestGross
+ from finix.model.update_payout_profile_request_net import UpdatePayoutProfileRequestNet
+ globals()['UpdatePayoutProfileRequestGross'] = UpdatePayoutProfileRequestGross
+ globals()['UpdatePayoutProfileRequestNet'] = UpdatePayoutProfileRequestNet
+
+
+class UpdatePayoutProfileRequest(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('type',): {
+ 'CUSTOM': "CUSTOM",
+ 'GROSS': "GROSS",
+ 'NET': "NET",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'gross': (UpdatePayoutProfileRequestGross,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'type': (str,), # noqa: E501
+ 'net': (UpdatePayoutProfileRequestNet,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'gross': 'gross', # noqa: E501
+ 'tags': 'tags', # noqa: E501
+ 'type': 'type', # noqa: E501
+ 'net': 'net', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ gross (UpdatePayoutProfileRequestGross): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Configures how fees are calculated and billed from payouts. For more infromation, see [Payout Types](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ net (UpdatePayoutProfileRequestNet): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ gross (UpdatePayoutProfileRequestGross): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ type (str): Configures how fees are calculated and billed from payouts. For more infromation, see [Payout Types](/guides/payouts/#payout-types).. [optional] # noqa: E501
+ net (UpdatePayoutProfileRequestNet): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_payout_profile_request_gross.py b/finix/model/update_payout_profile_request_gross.py
new file mode 100644
index 0000000..290369c
--- /dev/null
+++ b/finix/model/update_payout_profile_request_gross.py
@@ -0,0 +1,262 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.update_payout_profile_request_gross_fees import UpdatePayoutProfileRequestGrossFees
+ from finix.model.update_payout_profile_request_gross_payouts import UpdatePayoutProfileRequestGrossPayouts
+ globals()['UpdatePayoutProfileRequestGrossFees'] = UpdatePayoutProfileRequestGrossFees
+ globals()['UpdatePayoutProfileRequestGrossPayouts'] = UpdatePayoutProfileRequestGrossPayouts
+
+
+class UpdatePayoutProfileRequestGross(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'fees': (UpdatePayoutProfileRequestGrossFees,), # noqa: E501
+ 'payouts': (UpdatePayoutProfileRequestGrossPayouts,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'fees': 'fees', # noqa: E501
+ 'payouts': 'payouts', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGross - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ fees (UpdatePayoutProfileRequestGrossFees): [optional] # noqa: E501
+ payouts (UpdatePayoutProfileRequestGrossPayouts): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGross - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ fees (UpdatePayoutProfileRequestGrossFees): [optional] # noqa: E501
+ payouts (UpdatePayoutProfileRequestGrossPayouts): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_payout_profile_request_gross_fees.py b/finix/model/update_payout_profile_request_gross_fees.py
new file mode 100644
index 0000000..b569ce4
--- /dev/null
+++ b/finix/model/update_payout_profile_request_gross_fees.py
@@ -0,0 +1,276 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdatePayoutProfileRequestGrossFees(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ ('rail',): {
+ 'NEXT_DAY_ACH': "NEXT_DAY_ACH",
+ 'SAME_DAY_ACH': "SAME_DAY_ACH",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'day_of_month': (int,), # noqa: E501
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'day_of_month': 'day_of_month', # noqa: E501
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGrossFees - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day_of_month (int): Day of the month fees get debited. Required when `frequency` is set to **MONTHLY**.. [optional] # noqa: E501
+ frequency (str): Configures how frequentyly **fees** get debited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that **fees** get debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit **fees**.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for `fees` will get submitted to debit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGrossFees - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ day_of_month (int): Day of the month fees get debited. Required when `frequency` is set to **MONTHLY**.. [optional] # noqa: E501
+ frequency (str): Configures how frequentyly **fees** get debited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that **fees** get debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit **fees**.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for `fees` will get submitted to debit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_payout_profile_request_gross_payouts.py b/finix/model/update_payout_profile_request_gross_payouts.py
new file mode 100644
index 0000000..ffda883
--- /dev/null
+++ b/finix/model/update_payout_profile_request_gross_payouts.py
@@ -0,0 +1,268 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdatePayoutProfileRequestGrossPayouts(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGrossPayouts - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly **payouts** get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that payouts will get credited to.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to credit **payouts**.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for `payouts` will get submitted to credit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestGrossPayouts - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly **payouts** get credited. To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument`that payouts will get credited to.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to credit **payouts**.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for `payouts` will get submitted to credit (in days) the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_payout_profile_request_net.py b/finix/model/update_payout_profile_request_net.py
new file mode 100644
index 0000000..74ee7eb
--- /dev/null
+++ b/finix/model/update_payout_profile_request_net.py
@@ -0,0 +1,272 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class UpdatePayoutProfileRequestNet(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('frequency',): {
+ 'DAILY': "DAILY",
+ 'MONTHLY': "MONTHLY",
+ 'CONTINUOUS': "CONTINUOUS",
+ 'CUSTOM': "CUSTOM",
+ },
+ ('rail',): {
+ 'NEXT_DAY_ACH': "NEXT_DAY_ACH",
+ 'SAME_DAY_ACH': "SAME_DAY_ACH",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = True
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'frequency': (str,), # noqa: E501
+ 'payment_instrument_id': (str,), # noqa: E501
+ 'rail': (str,), # noqa: E501
+ 'submission_delay_days': (int,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'frequency': 'frequency', # noqa: E501
+ 'payment_instrument_id': 'payment_instrument_id', # noqa: E501
+ 'rail': 'rail', # noqa: E501
+ 'submission_delay_days': 'submission_delay_days', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestNet - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly fees *and* payouts get credited.. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that payouts *and* fees get credited to and debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit fees *and* credit payouts.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for both payouts *and* fees get submitted (in days) to debit/credit the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """UpdatePayoutProfileRequestNet - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ frequency (str): Configures how frequentyly fees *and* payouts get credited.. [optional] # noqa: E501
+ payment_instrument_id (str): The `id` of the `Payment Instrument` that payouts *and* fees get credited to and debited from.. [optional] # noqa: E501
+ rail (str): Configures how quickly and which payment `rail` will be used to debit fees *and* credit payouts.. [optional] # noqa: E501
+ submission_delay_days (int): Include a number of `submission_delay_days` to delay when `funding_transfers` for both payouts *and* fees get submitted (in days) to debit/credit the `payment_instrument_id`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/update_settlement_request.py b/finix/model/update_settlement_request.py
index d0ee23f..2388c60 100644
--- a/finix/model/update_settlement_request.py
+++ b/finix/model/update_settlement_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateSettlementRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_subscription_schedule_request.py b/finix/model/update_subscription_schedule_request.py
index 088d48d..f05949a 100644
--- a/finix/model/update_subscription_schedule_request.py
+++ b/finix/model/update_subscription_schedule_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateSubscriptionScheduleRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_transfer_request.py b/finix/model/update_transfer_request.py
index 9a14630..fe04c23 100644
--- a/finix/model/update_transfer_request.py
+++ b/finix/model/update_transfer_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateTransferRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,9 +75,8 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -135,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -217,7 +211,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_user_request.py b/finix/model/update_user_request.py
index 944e245..e852c97 100644
--- a/finix/model/update_user_request.py
+++ b/finix/model/update_user_request.py
@@ -27,10 +27,6 @@
from finix.exceptions import ApiAttributeError
-def lazy_import():
- from finix.model.tags import Tags
- globals()['Tags'] = Tags
-
class UpdateUserRequest(ModelNormal):
"""
@@ -65,7 +61,6 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
- lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -80,10 +75,9 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
- lazy_import()
return {
'enabled': (bool,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
}
@cached_property
@@ -138,7 +132,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Details if the `user` is enabled and active. Set to **false** to disable the user.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -221,7 +215,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Details if the `user` is enabled and active. Set to **false** to disable the user.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/finix/model/update_webhook_request.py b/finix/model/update_webhook_request.py
index 55154ce..6a165f5 100644
--- a/finix/model/update_webhook_request.py
+++ b/finix/model/update_webhook_request.py
@@ -27,6 +27,10 @@
from finix.exceptions import ApiAttributeError
+def lazy_import():
+ from finix.model.webhook_enabled_events import WebhookEnabledEvents
+ globals()['WebhookEnabledEvents'] = WebhookEnabledEvents
+
class UpdateWebhookRequest(ModelNormal):
"""
@@ -61,6 +65,7 @@ def additional_properties_type():
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
"""
+ lazy_import()
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
_nullable = False
@@ -75,8 +80,10 @@ def openapi_types():
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
+ lazy_import()
return {
'enabled': (bool,), # noqa: E501
+ 'enabled_events': (WebhookEnabledEvents,), # noqa: E501
'url': (str,), # noqa: E501
}
@@ -87,6 +94,7 @@ def discriminator():
attribute_map = {
'enabled': 'enabled', # noqa: E501
+ 'enabled_events': 'enabled_events', # noqa: E501
'url': 'url', # noqa: E501
}
@@ -132,6 +140,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Set to false to disable `Webhooks`. Default value when created is true.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
url (str): The HTTP or HTTPS url where the callbacks will be sent via POST request (max 120 characters).. [optional] # noqa: E501
"""
@@ -215,6 +224,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
enabled (bool): Set to false to disable `Webhooks`. Default value when created is true.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
url (str): The HTTP or HTTPS url where the callbacks will be sent via POST request (max 120 characters).. [optional] # noqa: E501
"""
diff --git a/finix/model/user.py b/finix/model/user.py
index c72fc63..a75d79f 100644
--- a/finix/model/user.py
+++ b/finix/model/user.py
@@ -28,9 +28,7 @@
def lazy_import():
- from finix.model.tags import Tags
from finix.model.user_links import UserLinks
- globals()['Tags'] = Tags
globals()['UserLinks'] = UserLinks
@@ -97,7 +95,7 @@ def openapi_types():
'identity': (str, none_type,), # noqa: E501
'password': (str, none_type,), # noqa: E501
'role': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'links': (UserLinks,), # noqa: E501
}
@@ -165,8 +163,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
enabled (bool): Details if the `User` is enabled and active. Set to **false** to disable the `User`.. [optional] # noqa: E501
identity (str, none_type): ID of the `Identity` that the `User` object was created under.. [optional] # noqa: E501
password (str, none_type): The `password` you'll use to authetnicate requests.. [optional] # noqa: E501
- role (str): Details the level of access the [`User`](#tag/Users) has available.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ role (str): Details the level of access the [`User`](/api/tag/Users) has available.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (UserLinks): [optional] # noqa: E501
"""
@@ -255,8 +253,8 @@ def __init__(self, *args, **kwargs): # noqa: E501
enabled (bool): Details if the `User` is enabled and active. Set to **false** to disable the `User`.. [optional] # noqa: E501
identity (str, none_type): ID of the `Identity` that the `User` object was created under.. [optional] # noqa: E501
password (str, none_type): The `password` you'll use to authetnicate requests.. [optional] # noqa: E501
- role (str): Details the level of access the [`User`](#tag/Users) has available.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ role (str): Details the level of access the [`User`](/api/tag/Users) has available.. [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
links (UserLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/user_links.py b/finix/model/user_links.py
index 03130b9..173367e 100644
--- a/finix/model/user_links.py
+++ b/finix/model/user_links.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+ from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
- globals()['ApplicationLinksApplicationProfile'] = ApplicationLinksApplicationProfile
+ globals()['ApplicationLinksAuthorizations'] = ApplicationLinksAuthorizations
globals()['ApplicationLinksSelf'] = ApplicationLinksSelf
globals()['ApplicationProfileLinksApplication'] = ApplicationProfileLinksApplication
@@ -87,7 +87,7 @@ def openapi_types():
lazy_import()
return {
'application': (ApplicationProfileLinksApplication,), # noqa: E501
- 'applications': (ApplicationLinksApplicationProfile,), # noqa: E501
+ 'applications': (ApplicationLinksAuthorizations,), # noqa: E501
'self': (ApplicationLinksSelf,), # noqa: E501
}
@@ -144,7 +144,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- applications (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ applications (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
"""
@@ -228,7 +228,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
application (ApplicationProfileLinksApplication): [optional] # noqa: E501
- applications (ApplicationLinksApplicationProfile): [optional] # noqa: E501
+ applications (ApplicationLinksAuthorizations): [optional] # noqa: E501
self (ApplicationLinksSelf): [optional] # noqa: E501
"""
diff --git a/finix/model/verification.py b/finix/model/verification.py
index c315f3a..7bef26d 100644
--- a/finix/model/verification.py
+++ b/finix/model/verification.py
@@ -28,10 +28,10 @@
def lazy_import():
- from finix.model.tags import Tags
from finix.model.verification_links import VerificationLinks
- globals()['Tags'] = Tags
+ from finix.model.verification_payment_instrument_verification_details import VerificationPaymentInstrumentVerificationDetails
globals()['VerificationLinks'] = VerificationLinks
+ globals()['VerificationPaymentInstrumentVerificationDetails'] = VerificationPaymentInstrumentVerificationDetails
class Verification(ModelNormal):
@@ -98,10 +98,11 @@ def openapi_types():
'merchant_identity': (str, none_type,), # noqa: E501
'messages': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501
'payment_instrument': (str, none_type,), # noqa: E501
+ 'payment_instrument_verification_details': (VerificationPaymentInstrumentVerificationDetails,), # noqa: E501
'processor': (str,), # noqa: E501
'raw': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'state': (str,), # noqa: E501
- 'tags': (Tags,), # noqa: E501
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
'trace_id': (str,), # noqa: E501
'links': (VerificationLinks,), # noqa: E501
}
@@ -121,6 +122,7 @@ def discriminator():
'merchant_identity': 'merchant_identity', # noqa: E501
'messages': 'messages', # noqa: E501
'payment_instrument': 'payment_instrument', # noqa: E501
+ 'payment_instrument_verification_details': 'payment_instrument_verification_details', # noqa: E501
'processor': 'processor', # noqa: E501
'raw': 'raw', # noqa: E501
'state': 'state', # noqa: E501
@@ -178,11 +180,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
merchant (str, none_type): ID of the `Merchant` resource.. [optional] # noqa: E501
merchant_identity (str, none_type): ID of the `Identity` associated with the `Merchant`.. [optional] # noqa: E501
messages ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Provides additional details about the verification (e.g why it failed). This field is usually **null**.. [optional] # noqa: E501
- payment_instrument (str, none_type): The `Payment Instrument` that'll be used to settle the `Merchant's` processed funds.. [optional] # noqa: E501
+ payment_instrument (str, none_type): The `Payment Instrument` that's used to settle the `Merchant's` processed funds.. [optional] # noqa: E501
+ payment_instrument_verification_details (VerificationPaymentInstrumentVerificationDetails): [optional] # noqa: E501
processor (str): Name of the verification processor.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
state (str): The status of the `Verification` request.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Verification`. The processor sends back the `trace_id` so you can track the verification end-to-end.. [optional] # noqa: E501
links (VerificationLinks): [optional] # noqa: E501
"""
@@ -274,11 +277,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
merchant (str, none_type): ID of the `Merchant` resource.. [optional] # noqa: E501
merchant_identity (str, none_type): ID of the `Identity` associated with the `Merchant`.. [optional] # noqa: E501
messages ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Provides additional details about the verification (e.g why it failed). This field is usually **null**.. [optional] # noqa: E501
- payment_instrument (str, none_type): The `Payment Instrument` that'll be used to settle the `Merchant's` processed funds.. [optional] # noqa: E501
+ payment_instrument (str, none_type): The `Payment Instrument` that's used to settle the `Merchant's` processed funds.. [optional] # noqa: E501
+ payment_instrument_verification_details (VerificationPaymentInstrumentVerificationDetails): [optional] # noqa: E501
processor (str): Name of the verification processor.. [optional] # noqa: E501
raw ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Raw response from the processor.. [optional] # noqa: E501
state (str): The status of the `Verification` request.. [optional] # noqa: E501
- tags (Tags): [optional] # noqa: E501
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
trace_id (str): Trace ID of the `Verification`. The processor sends back the `trace_id` so you can track the verification end-to-end.. [optional] # noqa: E501
links (VerificationLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/verification_payment_instrument_verification_details.py b/finix/model/verification_payment_instrument_verification_details.py
new file mode 100644
index 0000000..d3e6518
--- /dev/null
+++ b/finix/model/verification_payment_instrument_verification_details.py
@@ -0,0 +1,294 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+def lazy_import():
+ from finix.model.country import Country
+ from finix.model.currency import Currency
+ globals()['Country'] = Country
+ globals()['Currency'] = Currency
+
+
+class VerificationPaymentInstrumentVerificationDetails(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ ('push_to_card_domestic',): {
+ 'FAST_FUNDS': "FAST_FUNDS",
+ 'NON_FAST_FUNDS': "NON_FAST_FUNDS",
+ 'NOT_SUPPORTED': "NOT_SUPPORTED",
+ 'UNKNOWN': "UNKNOWN",
+ },
+ ('push_to_card_cross_border',): {
+ 'FAST_FUNDS': "FAST_FUNDS",
+ 'NON_FAST_FUNDS': "NON_FAST_FUNDS",
+ 'NOT_SUPPORTED': "NOT_SUPPORTED",
+ 'UNKNOWN': "UNKNOWN",
+ },
+ ('card_type',): {
+ 'CREDIT': "CREDIT",
+ 'DEBIT': "DEBIT",
+ 'HSA_FSA': "HSA_FSA",
+ 'NON_RELOADABLE_PREPAID': "NON_RELOADABLE_PREPAID",
+ 'RELOADABLE_PREPAID': "RELOADABLE_PREPAID",
+ 'UNKNOWN': "UNKNOWN",
+ },
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ lazy_import()
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ lazy_import()
+ return {
+ 'push_to_card_domestic': (str,), # noqa: E501
+ 'push_to_card_cross_border': (str,), # noqa: E501
+ 'card_type': (str,), # noqa: E501
+ 'billing_currency': (Currency,), # noqa: E501
+ 'issuer_country': (Country,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'push_to_card_domestic': 'push_to_card_domestic', # noqa: E501
+ 'push_to_card_cross_border': 'push_to_card_cross_border', # noqa: E501
+ 'card_type': 'card_type', # noqa: E501
+ 'billing_currency': 'billing_currency', # noqa: E501
+ 'issuer_country': 'issuer_country', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """VerificationPaymentInstrumentVerificationDetails - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ push_to_card_domestic (str): Details if the `Payment Instrument` supports push and pull from card, domestically. For more details, see [Push to Card](/guides/push-pull/).. [optional] # noqa: E501
+ push_to_card_cross_border (str): Details if the `Payment Instrument` supports push and pull from card, cross-border. For more details, see [Push to Card](/guides/push-pull/).. [optional] # noqa: E501
+ card_type (str): The type of card. Same value as `Payment Instrument#type`.. [optional] # noqa: E501
+ billing_currency (Currency): [optional] # noqa: E501
+ issuer_country (Country): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """VerificationPaymentInstrumentVerificationDetails - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ push_to_card_domestic (str): Details if the `Payment Instrument` supports push and pull from card, domestically. For more details, see [Push to Card](/guides/push-pull/).. [optional] # noqa: E501
+ push_to_card_cross_border (str): Details if the `Payment Instrument` supports push and pull from card, cross-border. For more details, see [Push to Card](/guides/push-pull/).. [optional] # noqa: E501
+ card_type (str): The type of card. Same value as `Payment Instrument#type`.. [optional] # noqa: E501
+ billing_currency (Currency): [optional] # noqa: E501
+ issuer_country (Country): [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/void_authorization.py b/finix/model/void_authorization.py
new file mode 100644
index 0000000..9b3fcc2
--- /dev/null
+++ b/finix/model/void_authorization.py
@@ -0,0 +1,254 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class VoidAuthorization(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'void_me': (bool,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'tags': 'tags', # noqa: E501
+ 'void_me': 'void_me', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """VoidAuthorization - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """VoidAuthorization - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/void_authorization_request.py b/finix/model/void_authorization_request.py
new file mode 100644
index 0000000..e21cd87
--- /dev/null
+++ b/finix/model/void_authorization_request.py
@@ -0,0 +1,254 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class VoidAuthorizationRequest(ModelNormal):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ discriminator_value_class_map (dict): A dict to go from the discriminator
+ variable value to the discriminator class name.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ @cached_property
+ def additional_properties_type():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+ """
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'tags': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501
+ 'void_me': (bool,), # noqa: E501
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {
+ 'tags': 'tags', # noqa: E501
+ 'void_me': 'void_me', # noqa: E501
+ }
+
+ read_only_vars = {
+ }
+
+ _composed_schemas = {}
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
+ """VoidAuthorizationRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ return self
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs): # noqa: E501
+ """VoidAuthorizationRequest - a model defined in OpenAPI
+
+ Keyword Args:
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ tags ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Include up to 50 `key`: **value** pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual **values** is 500. (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**, etc.). [optional] # noqa: E501
+ void_me (bool): Set to **True** to void the `Authorization`.. [optional] # noqa: E501
+ """
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _path_to_item = kwargs.pop('_path_to_item', ())
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+ for var_name, var_value in kwargs.items():
+ if var_name not in self.attribute_map and \
+ self._configuration is not None and \
+ self._configuration.discard_unknown_keys and \
+ self.additional_properties_type is None:
+ # discard variable.
+ continue
+ setattr(self, var_name, var_value)
+ if var_name in self.read_only_vars:
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+ f"class with read only attributes.")
diff --git a/finix/model/webhook.py b/finix/model/webhook.py
index 76fb9c5..1e66aae 100644
--- a/finix/model/webhook.py
+++ b/finix/model/webhook.py
@@ -30,8 +30,10 @@
def lazy_import():
from finix.model.processor_links import ProcessorLinks
from finix.model.webhook_authentication import WebhookAuthentication
+ from finix.model.webhook_enabled_events import WebhookEnabledEvents
globals()['ProcessorLinks'] = ProcessorLinks
globals()['WebhookAuthentication'] = WebhookAuthentication
+ globals()['WebhookEnabledEvents'] = WebhookEnabledEvents
class Webhook(ModelNormal):
@@ -90,6 +92,9 @@ def openapi_types():
'application': (str,), # noqa: E501
'authentication': (WebhookAuthentication,), # noqa: E501
'enabled': (bool,), # noqa: E501
+ 'enabled_events': (WebhookEnabledEvents,), # noqa: E501
+ 'previous_secret_expires_at': (str, none_type,), # noqa: E501
+ 'secret_signing_key': (str, none_type,), # noqa: E501
'url': (str,), # noqa: E501
'links': (ProcessorLinks,), # noqa: E501
}
@@ -106,6 +111,9 @@ def discriminator():
'application': 'application', # noqa: E501
'authentication': 'authentication', # noqa: E501
'enabled': 'enabled', # noqa: E501
+ 'enabled_events': 'enabled_events', # noqa: E501
+ 'previous_secret_expires_at': 'previous_secret_expires_at', # noqa: E501
+ 'secret_signing_key': 'secret_signing_key', # noqa: E501
'url': 'url', # noqa: E501
'links': '_links', # noqa: E501
}
@@ -157,6 +165,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
application (str): The ID of the `Application` resource the `Webhook` was created under.. [optional] # noqa: E501
authentication (WebhookAuthentication): [optional] # noqa: E501
enabled (bool): Details if the `Webhook` is enabled:
- true: Events are being sent to the `url`.
- false: Events are not being sent.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
+ previous_secret_expires_at (str, none_type): The time when the previous `secret_signing_key` will expire. This is **null** when the webhook is initially created.. [optional] # noqa: E501
+ secret_signing_key (str, none_type): The secret signing key that gets used to verify webhook events.. [optional] # noqa: E501
url (str): The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).. [optional] # noqa: E501
links (ProcessorLinks): [optional] # noqa: E501
"""
@@ -246,6 +257,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
application (str): The ID of the `Application` resource the `Webhook` was created under.. [optional] # noqa: E501
authentication (WebhookAuthentication): [optional] # noqa: E501
enabled (bool): Details if the `Webhook` is enabled:
- true: Events are being sent to the `url`.
- false: Events are not being sent.. [optional] # noqa: E501
+ enabled_events (WebhookEnabledEvents): [optional] # noqa: E501
+ previous_secret_expires_at (str, none_type): The time when the previous `secret_signing_key` will expire. This is **null** when the webhook is initially created.. [optional] # noqa: E501
+ secret_signing_key (str, none_type): The secret signing key that gets used to verify webhook events.. [optional] # noqa: E501
url (str): The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).. [optional] # noqa: E501
links (ProcessorLinks): [optional] # noqa: E501
"""
diff --git a/finix/model/webhook_enabled_events.py b/finix/model/webhook_enabled_events.py
new file mode 100644
index 0000000..b9bbb0f
--- /dev/null
+++ b/finix/model/webhook_enabled_events.py
@@ -0,0 +1,273 @@
+"""
+ Finix API
+
+ The version of the OpenAPI document: 2022-02-01
+ Contact: support@finixpayments.com
+"""
+
+
+import re # noqa: F401
+import sys # noqa: F401
+
+from finix.model_utils import ( # noqa: F401
+ ApiTypeError,
+ ModelComposed,
+ ModelNormal,
+ ModelSimple,
+ cached_property,
+ change_keys_js_to_python,
+ convert_js_args_to_python_args,
+ date,
+ datetime,
+ file_type,
+ none_type,
+ validate_get_composed_info,
+ OpenApiModel
+)
+from finix.exceptions import ApiAttributeError
+
+
+
+class WebhookEnabledEvents(ModelSimple):
+ """
+
+ Attributes:
+ allowed_values (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ with a capitalized key describing the allowed value and an allowed
+ value. These dicts store the allowed enum values.
+ validations (dict): The key is the tuple path to the attribute
+ and the for var_name this is (var_name,). The value is a dict
+ that stores validations for max_length, min_length, max_items,
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+ inclusive_minimum, and regex.
+ additional_properties_type (tuple): A tuple of classes accepted
+ as additional properties values.
+ """
+
+ allowed_values = {
+ }
+
+ validations = {
+ }
+
+ additional_properties_type = None
+
+ _nullable = False
+
+ @cached_property
+ def openapi_types():
+ """
+ This must be a method because a model may have properties that are
+ of type self, this must run after the class is loaded
+
+ Returns
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ """
+ return {
+ 'value': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],),
+ }
+
+ @cached_property
+ def discriminator():
+ return None
+
+
+ attribute_map = {}
+
+ read_only_vars = set()
+
+ _composed_schemas = None
+
+ required_properties = set([
+ '_data_store',
+ '_check_type',
+ '_spec_property_naming',
+ '_path_to_item',
+ '_configuration',
+ '_visited_composed_classes',
+ ])
+
+ @convert_js_args_to_python_args
+ def __init__(self, *args, **kwargs):
+ """WebhookEnabledEvents - a model defined in OpenAPI
+
+ Note that value can be passed either in args or in kwargs, but not in both.
+
+ Args:
+ args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A list of events the [webhook is explicitly enabled for](/guides/developers/webhooks/#webhook-event-filtering).. # noqa: E501
+
+ Keyword Args:
+ value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A list of events the [webhook is explicitly enabled for](/guides/developers/webhooks/#webhook-event-filtering).. # noqa: E501
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+ # required up here when default value is not given
+ _path_to_item = kwargs.pop('_path_to_item', ())
+
+ if 'value' in kwargs:
+ value = kwargs.pop('value')
+ elif args:
+ args = list(args)
+ value = args.pop(0)
+ else:
+ raise ApiTypeError(
+ "value is required, but not passed in args or kwargs and doesn't have default",
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.value = value
+ if kwargs:
+ raise ApiTypeError(
+ "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % (
+ kwargs,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ @classmethod
+ @convert_js_args_to_python_args
+ def _from_openapi_data(cls, *args, **kwargs):
+ """WebhookEnabledEvents - a model defined in OpenAPI
+
+ Note that value can be passed either in args or in kwargs, but not in both.
+
+ Args:
+ args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A list of events the [webhook is explicitly enabled for](/guides/developers/webhooks/#webhook-event-filtering).. # noqa: E501
+
+ Keyword Args:
+ value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): A list of events the [webhook is explicitly enabled for](/guides/developers/webhooks/#webhook-event-filtering).. # noqa: E501
+ _check_type (bool): if True, values for parameters in openapi_types
+ will be type checked and a TypeError will be
+ raised if the wrong type is input.
+ Defaults to True
+ _path_to_item (tuple/list): This is a list of keys or values to
+ drill down to the model in received_data
+ when deserializing a response
+ _spec_property_naming (bool): True if the variable names in the input data
+ are serialized names, as specified in the OpenAPI document.
+ False if the variable names in the input data
+ are pythonic names, e.g. snake case (default)
+ _configuration (Configuration): the instance to use when
+ deserializing a file_type parameter.
+ If passed, type conversion is attempted
+ If omitted no type conversion is done.
+ _visited_composed_classes (tuple): This stores a tuple of
+ classes that we have traveled through so that
+ if we see that class again we will not use its
+ discriminator again.
+ When traveling through a discriminator, the
+ composed schema that is
+ is traveled through is added to this set.
+ For example if Animal has a discriminator
+ petType and we pass in "Dog", and the class Dog
+ allOf includes Animal, we move through Animal
+ once using the discriminator, and pick Dog.
+ Then in Dog, we will make an instance of the
+ Animal class but this time we won't travel
+ through its discriminator because we passed in
+ _visited_composed_classes = (Animal,)
+ """
+ # required up here when default value is not given
+ _path_to_item = kwargs.pop('_path_to_item', ())
+
+ self = super(OpenApiModel, cls).__new__(cls)
+
+ if 'value' in kwargs:
+ value = kwargs.pop('value')
+ elif args:
+ args = list(args)
+ value = args.pop(0)
+ else:
+ raise ApiTypeError(
+ "value is required, but not passed in args or kwargs and doesn't have default",
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ _check_type = kwargs.pop('_check_type', True)
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+ _configuration = kwargs.pop('_configuration', None)
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+ if args:
+ raise ApiTypeError(
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+ args,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ self._data_store = {}
+ self._check_type = _check_type
+ self._spec_property_naming = _spec_property_naming
+ self._path_to_item = _path_to_item
+ self._configuration = _configuration
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+ self.value = value
+ if kwargs:
+ raise ApiTypeError(
+ "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % (
+ kwargs,
+ self.__class__.__name__,
+ ),
+ path_to_item=_path_to_item,
+ valid_classes=(self.__class__,),
+ )
+
+ return self
diff --git a/finix/models/__init__.py b/finix/models/__init__.py
index e7cb521..6f0cc37 100644
--- a/finix/models/__init__.py
+++ b/finix/models/__init__.py
@@ -9,9 +9,11 @@
# import sys
# sys.setrecursionlimit(n)
+from finix.model.accept_dispute import AcceptDispute
from finix.model.additional_buyer_charges import AdditionalBuyerCharges
+from finix.model.additional_healthcare_data import AdditionalHealthcareData
from finix.model.additional_purchase_data import AdditionalPurchaseData
-from finix.model.additional_purchase_data_item_data_inner import AdditionalPurchaseDataItemDataInner
+from finix.model.additional_purchase_data_item_data import AdditionalPurchaseDataItemData
from finix.model.additional_purchase_data_order_date import AdditionalPurchaseDataOrderDate
from finix.model.address import Address
from finix.model.adjustment_transfers_list import AdjustmentTransfersList
@@ -20,21 +22,20 @@
from finix.model.apple_pay_session_request import ApplePaySessionRequest
from finix.model.application import Application
from finix.model.application_links import ApplicationLinks
-from finix.model.application_links_application_profile import ApplicationLinksApplicationProfile
+from finix.model.application_links_authorizations import ApplicationLinksAuthorizations
from finix.model.application_links_self import ApplicationLinksSelf
from finix.model.application_profile import ApplicationProfile
from finix.model.application_profile_links import ApplicationProfileLinks
from finix.model.application_profile_links_application import ApplicationProfileLinksApplication
from finix.model.application_profiles_list import ApplicationProfilesList
from finix.model.application_profiles_list_embedded import ApplicationProfilesListEmbedded
-from finix.model.application_profiles_list_links import ApplicationProfilesListLinks
from finix.model.applications_list import ApplicationsList
from finix.model.applications_list_embedded import ApplicationsListEmbedded
from finix.model.associated_identity import AssociatedIdentity
from finix.model.associated_identity_entity import AssociatedIdentityEntity
from finix.model.authorization import Authorization
from finix.model.authorization_captured import AuthorizationCaptured
-from finix.model.authorization_captured_external_responses_inner import AuthorizationCapturedExternalResponsesInner
+from finix.model.authorization_captured_external_responses import AuthorizationCapturedExternalResponses
from finix.model.authorization_links import AuthorizationLinks
from finix.model.authorization_links_device import AuthorizationLinksDevice
from finix.model.authorization_links_merchant_identity import AuthorizationLinksMerchantIdentity
@@ -46,21 +47,19 @@
from finix.model.balance_transfer_list_embedded import BalanceTransferListEmbedded
from finix.model.card_present_details import CardPresentDetails
from finix.model.card_present_details_emv_data import CardPresentDetailsEmvData
-from finix.model.card_present_instrument_form import CardPresentInstrumentForm
+from finix.model.close_settlement import CloseSettlement
from finix.model.compliance_form import ComplianceForm
from finix.model.compliance_form_files import ComplianceFormFiles
+from finix.model.compliance_form_list import ComplianceFormList
+from finix.model.compliance_form_list_embedded import ComplianceFormListEmbedded
from finix.model.compliance_form_pci_saq_a import ComplianceFormPciSaqA
from finix.model.configuration_details import ConfigurationDetails
-from finix.model.configuration_details_cashback_options import ConfigurationDetailsCashbackOptions
-from finix.model.configuration_details_cashback_options_manual_entry import ConfigurationDetailsCashbackOptionsManualEntry
-from finix.model.configuration_details_tip_options import ConfigurationDetailsTipOptions
from finix.model.country import Country
from finix.model.create_application_request import CreateApplicationRequest
from finix.model.create_associated_identity_request import CreateAssociatedIdentityRequest
from finix.model.create_associated_identity_request_entity import CreateAssociatedIdentityRequestEntity
from finix.model.create_associated_identity_request_entity_business_address import CreateAssociatedIdentityRequestEntityBusinessAddress
from finix.model.create_associated_identity_request_entity_dob import CreateAssociatedIdentityRequestEntityDob
-from finix.model.create_associated_identity_request_entity_incorporation_date import CreateAssociatedIdentityRequestEntityIncorporationDate
from finix.model.create_associated_identity_request_entity_personal_address import CreateAssociatedIdentityRequestEntityPersonalAddress
from finix.model.create_authorization_request import CreateAuthorizationRequest
from finix.model.create_authorization_request3d_secure_authentication import CreateAuthorizationRequest3dSecureAuthentication
@@ -76,20 +75,23 @@
from finix.model.create_identity_request_additional_underwriting_data_card_volume_distribution import CreateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution
from finix.model.create_identity_request_additional_underwriting_data_volume_distribution_by_business_type import CreateIdentityRequestAdditionalUnderwritingDataVolumeDistributionByBusinessType
from finix.model.create_identity_request_entity import CreateIdentityRequestEntity
+from finix.model.create_identity_request_entity_business_address import CreateIdentityRequestEntityBusinessAddress
+from finix.model.create_identity_request_entity_dob import CreateIdentityRequestEntityDob
+from finix.model.create_identity_request_entity_incorporation_date import CreateIdentityRequestEntityIncorporationDate
from finix.model.create_identity_request_entity_personal_address import CreateIdentityRequestEntityPersonalAddress
from finix.model.create_instrument_update_request import CreateInstrumentUpdateRequest
from finix.model.create_merchant_underwriting_request import CreateMerchantUnderwritingRequest
from finix.model.create_onboarding_form_link_request import CreateOnboardingFormLinkRequest
from finix.model.create_onboarding_form_request import CreateOnboardingFormRequest
-from finix.model.create_onboarding_form_request_merchant_processors_inner import CreateOnboardingFormRequestMerchantProcessorsInner
-from finix.model.create_onboarding_form_request_onboarding_data import CreateOnboardingFormRequestOnboardingData
+from finix.model.create_onboarding_form_request_merchant_processors import CreateOnboardingFormRequestMerchantProcessors
from finix.model.create_onboarding_form_request_onboarding_link_details import CreateOnboardingFormRequestOnboardingLinkDetails
from finix.model.create_payment_instrument_request import CreatePaymentInstrumentRequest
from finix.model.create_payment_instrument_request_address import CreatePaymentInstrumentRequestAddress
from finix.model.create_processor_request import CreateProcessorRequest
-from finix.model.create_processor_request_config import CreateProcessorRequestConfig
from finix.model.create_reversal_request import CreateReversalRequest
+from finix.model.create_reversal_request_split_transfers import CreateReversalRequestSplitTransfers
from finix.model.create_settlement_request import CreateSettlementRequest
+from finix.model.create_split_transfer_request import CreateSplitTransferRequest
from finix.model.create_subscription_amount_request import CreateSubscriptionAmountRequest
from finix.model.create_subscription_amount_request_fee_amount_data import CreateSubscriptionAmountRequestFeeAmountData
from finix.model.create_subscription_enrollment_request import CreateSubscriptionEnrollmentRequest
@@ -98,6 +100,7 @@
from finix.model.create_subscription_schedule_request_period_offset import CreateSubscriptionScheduleRequestPeriodOffset
from finix.model.create_transfer_request import CreateTransferRequest
from finix.model.create_transfer_request3d_secure_authentication import CreateTransferRequest3dSecureAuthentication
+from finix.model.create_transfer_request_split_transfers import CreateTransferRequestSplitTransfers
from finix.model.create_user_request import CreateUserRequest
from finix.model.create_verification_request import CreateVerificationRequest
from finix.model.create_webhook_request import CreateWebhookRequest
@@ -111,6 +114,7 @@
from finix.model.device_links_merchant import DeviceLinksMerchant
from finix.model.dispute import Dispute
from finix.model.dispute_adjustment_transfers_list import DisputeAdjustmentTransfersList
+from finix.model.dispute_dispute_details import DisputeDisputeDetails
from finix.model.dispute_evidence import DisputeEvidence
from finix.model.dispute_evidence_links import DisputeEvidenceLinks
from finix.model.dispute_evidence_list import DisputeEvidenceList
@@ -122,22 +126,17 @@
from finix.model.download_instrument_update_query_params import DownloadInstrumentUpdateQueryParams
from finix.model.error401_unauthorized import Error401Unauthorized
from finix.model.error401_unauthorized_embedded import Error401UnauthorizedEmbedded
-from finix.model.error401_unauthorized_embedded_errors_inner import Error401UnauthorizedEmbeddedErrorsInner
-from finix.model.error401_unauthorized_embedded_errors_inner_links import Error401UnauthorizedEmbeddedErrorsInnerLinks
from finix.model.error402_payment_required import Error402PaymentRequired
from finix.model.error402_payment_required_embedded import Error402PaymentRequiredEmbedded
-from finix.model.error402_payment_required_embedded_errors_inner import Error402PaymentRequiredEmbeddedErrorsInner
-from finix.model.error402_payment_required_embedded_errors_inner_links import Error402PaymentRequiredEmbeddedErrorsInnerLinks
from finix.model.error403_forbidden_list import Error403ForbiddenList
from finix.model.error403_forbidden_list_embedded import Error403ForbiddenListEmbedded
-from finix.model.error403_forbidden_list_embedded_errors_inner import Error403ForbiddenListEmbeddedErrorsInner
from finix.model.error404_not_found_list import Error404NotFoundList
from finix.model.error404_not_found_list_embedded import Error404NotFoundListEmbedded
-from finix.model.error404_not_found_list_embedded_errors_inner import Error404NotFoundListEmbeddedErrorsInner
from finix.model.error406_not_acceptable import Error406NotAcceptable
from finix.model.error422_invalid_field_list import Error422InvalidFieldList
from finix.model.error422_invalid_field_list_embedded import Error422InvalidFieldListEmbedded
-from finix.model.error422_invalid_field_list_embedded_errors_inner import Error422InvalidFieldListEmbeddedErrorsInner
+from finix.model.error422_invalid_field_list_embedded_errors import Error422InvalidFieldListEmbeddedErrors
+from finix.model.error422_invalid_field_list_embedded_links import Error422InvalidFieldListEmbeddedLinks
from finix.model.error_generic import ErrorGeneric
from finix.model.external_link import ExternalLink
from finix.model.external_links_list import ExternalLinksList
@@ -154,6 +153,7 @@
from finix.model.file import File
from finix.model.files_list import FilesList
from finix.model.files_list_embedded import FilesListEmbedded
+from finix.model.get_device_connection_query_params import GetDeviceConnectionQueryParams
from finix.model.get_device_query_params import GetDeviceQueryParams
from finix.model.identities_list import IdentitiesList
from finix.model.identities_list_embedded import IdentitiesListEmbedded
@@ -168,7 +168,6 @@
from finix.model.identity_entity_form_business_address import IdentityEntityFormBusinessAddress
from finix.model.identity_entity_form_dob import IdentityEntityFormDob
from finix.model.identity_entity_form_incorporation_date import IdentityEntityFormIncorporationDate
-from finix.model.identity_entity_incorporation_date import IdentityEntityIncorporationDate
from finix.model.identity_entity_personal_address import IdentityEntityPersonalAddress
from finix.model.identity_links import IdentityLinks
from finix.model.identity_links_application import IdentityLinksApplication
@@ -185,6 +184,8 @@
from finix.model.instrument_update_links import InstrumentUpdateLinks
from finix.model.instrument_update_links_application import InstrumentUpdateLinksApplication
from finix.model.instrument_update_links_payment_instrument import InstrumentUpdateLinksPaymentInstrument
+from finix.model.l3_additional_purchase_data import L3AdditionalPurchaseData
+from finix.model.l3_additional_purchase_data_item_data import L3AdditionalPurchaseDataItemData
from finix.model.list_authorizations_query_params import ListAuthorizationsQueryParams
from finix.model.list_balance_transfers_query_params import ListBalanceTransfersQueryParams
from finix.model.list_dispute_evidence_query_params import ListDisputeEvidenceQueryParams
@@ -200,9 +201,9 @@
from finix.model.list_merchant_profiles_query_params import ListMerchantProfilesQueryParams
from finix.model.list_merchant_verifications_query_params import ListMerchantVerificationsQueryParams
from finix.model.list_merchants_query_params import ListMerchantsQueryParams
-from finix.model.list_payment_instrument_updates_query_params import ListPaymentInstrumentUpdatesQueryParams
from finix.model.list_payment_instrument_verifications_query_params import ListPaymentInstrumentVerificationsQueryParams
from finix.model.list_payment_instruments_query_params import ListPaymentInstrumentsQueryParams
+from finix.model.list_payoutprofiles_query_params import ListPayoutprofilesQueryParams
from finix.model.list_settlement_funding_transfers_query_params import ListSettlementFundingTransfersQueryParams
from finix.model.list_settlement_transfers_query_params import ListSettlementTransfersQueryParams
from finix.model.list_settlements_query_params import ListSettlementsQueryParams
@@ -226,10 +227,13 @@
from finix.model.merchants_list import MerchantsList
from finix.model.merchants_list_embedded import MerchantsListEmbedded
from finix.model.messages import Messages
-from finix.model.name import Name
from finix.model.onboarding_form import OnboardingForm
from finix.model.onboarding_form_link import OnboardingFormLink
from finix.model.onboarding_form_onboarding_data import OnboardingFormOnboardingData
+from finix.model.onboarding_form_onboarding_data_additional_underwriting_data import OnboardingFormOnboardingDataAdditionalUnderwritingData
+from finix.model.onboarding_form_onboarding_data_entity import OnboardingFormOnboardingDataEntity
+from finix.model.onboarding_form_onboarding_data_entity_incorporation_date import OnboardingFormOnboardingDataEntityIncorporationDate
+from finix.model.onboarding_form_onboarding_data_payment_instruments import OnboardingFormOnboardingDataPaymentInstruments
from finix.model.onboarding_form_onboarding_link import OnboardingFormOnboardingLink
from finix.model.operation_key import OperationKey
from finix.model.page_cursor import PageCursor
@@ -238,6 +242,7 @@
from finix.model.payment_instrument_links import PaymentInstrumentLinks
from finix.model.payment_instrument_links_authorizations import PaymentInstrumentLinksAuthorizations
from finix.model.payment_instrument_links_transfers import PaymentInstrumentLinksTransfers
+from finix.model.payment_instrument_links_updates import PaymentInstrumentLinksUpdates
from finix.model.payment_instrument_token import PaymentInstrumentToken
from finix.model.payment_instrument_token_links import PaymentInstrumentTokenLinks
from finix.model.payment_instrument_token_links_verifications import PaymentInstrumentTokenLinksVerifications
@@ -245,9 +250,17 @@
from finix.model.payment_instrument_updates_list_embedded import PaymentInstrumentUpdatesListEmbedded
from finix.model.payment_instruments_list import PaymentInstrumentsList
from finix.model.payment_instruments_list_embedded import PaymentInstrumentsListEmbedded
+from finix.model.payout_profile import PayoutProfile
+from finix.model.payout_profile_gross import PayoutProfileGross
+from finix.model.payout_profile_gross_fees import PayoutProfileGrossFees
+from finix.model.payout_profile_gross_payouts import PayoutProfileGrossPayouts
+from finix.model.payout_profile_net import PayoutProfileNet
+from finix.model.payout_profiles_list import PayoutProfilesList
+from finix.model.payout_profiles_list_embedded import PayoutProfilesListEmbedded
from finix.model.processor import Processor
from finix.model.processor_application_config import ProcessorApplicationConfig
from finix.model.processor_application_config_configuration_templates import ProcessorApplicationConfigConfigurationTemplates
+from finix.model.processor_config import ProcessorConfig
from finix.model.processor_links import ProcessorLinks
from finix.model.processor_system_config import ProcessorSystemConfig
from finix.model.processor_system_config_config import ProcessorSystemConfigConfig
@@ -258,7 +271,12 @@
from finix.model.settlement_links import SettlementLinks
from finix.model.settlements_list import SettlementsList
from finix.model.settlements_list_embedded import SettlementsListEmbedded
+from finix.model.split_transfer import SplitTransfer
+from finix.model.split_transfer_tags import SplitTransferTags
+from finix.model.split_transfers_list import SplitTransfersList
+from finix.model.split_transfers_list_embedded import SplitTransfersListEmbedded
from finix.model.sub_type_transfer import SubTypeTransfer
+from finix.model.submit_dispute_evidence import SubmitDisputeEvidence
from finix.model.subscription_amount import SubscriptionAmount
from finix.model.subscription_amount_fee_amount_data import SubscriptionAmountFeeAmountData
from finix.model.subscription_amount_links import SubscriptionAmountLinks
@@ -280,7 +298,6 @@
from finix.model.subscription_schedules_list import SubscriptionSchedulesList
from finix.model.subscription_schedules_list_embedded import SubscriptionSchedulesListEmbedded
from finix.model.subscription_schedules_list_links import SubscriptionSchedulesListLinks
-from finix.model.tags import Tags
from finix.model.transfer import Transfer
from finix.model.transfer_links import TransferLinks
from finix.model.transfer_links_destination import TransferLinksDestination
@@ -299,16 +316,24 @@
from finix.model.update_compliance_form_request import UpdateComplianceFormRequest
from finix.model.update_compliance_form_request_pci_saq_a import UpdateComplianceFormRequestPciSaqA
from finix.model.update_device_request import UpdateDeviceRequest
+from finix.model.update_dispute_evidence import UpdateDisputeEvidence
from finix.model.update_fee_request import UpdateFeeRequest
from finix.model.update_identity_request import UpdateIdentityRequest
from finix.model.update_identity_request_additional_underwriting_data import UpdateIdentityRequestAdditionalUnderwritingData
from finix.model.update_identity_request_additional_underwriting_data_card_volume_distribution import UpdateIdentityRequestAdditionalUnderwritingDataCardVolumeDistribution
from finix.model.update_identity_request_additional_underwriting_data_volume_distribution_by_business_type import UpdateIdentityRequestAdditionalUnderwritingDataVolumeDistributionByBusinessType
from finix.model.update_identity_request_entity import UpdateIdentityRequestEntity
+from finix.model.update_identity_request_entity_business_address import UpdateIdentityRequestEntityBusinessAddress
+from finix.model.update_identity_request_entity_dob import UpdateIdentityRequestEntityDob
from finix.model.update_identity_request_entity_personal_address import UpdateIdentityRequestEntityPersonalAddress
from finix.model.update_merchant_profile_request import UpdateMerchantProfileRequest
from finix.model.update_merchant_request import UpdateMerchantRequest
from finix.model.update_payment_instrument_request import UpdatePaymentInstrumentRequest
+from finix.model.update_payout_profile_request import UpdatePayoutProfileRequest
+from finix.model.update_payout_profile_request_gross import UpdatePayoutProfileRequestGross
+from finix.model.update_payout_profile_request_gross_fees import UpdatePayoutProfileRequestGrossFees
+from finix.model.update_payout_profile_request_gross_payouts import UpdatePayoutProfileRequestGrossPayouts
+from finix.model.update_payout_profile_request_net import UpdatePayoutProfileRequestNet
from finix.model.update_settlement_request import UpdateSettlementRequest
from finix.model.update_subscription_amount_request import UpdateSubscriptionAmountRequest
from finix.model.update_subscription_enrollment_request import UpdateSubscriptionEnrollmentRequest
@@ -326,9 +351,13 @@
from finix.model.verification_links import VerificationLinks
from finix.model.verification_links_application import VerificationLinksApplication
from finix.model.verification_links_merchant import VerificationLinksMerchant
+from finix.model.verification_payment_instrument_verification_details import VerificationPaymentInstrumentVerificationDetails
from finix.model.verifications_list import VerificationsList
from finix.model.verifications_list_embedded import VerificationsListEmbedded
+from finix.model.void_authorization import VoidAuthorization
+from finix.model.void_authorization_request import VoidAuthorizationRequest
from finix.model.webhook import Webhook
from finix.model.webhook_authentication import WebhookAuthentication
+from finix.model.webhook_enabled_events import WebhookEnabledEvents
from finix.model.webhooks_list import WebhooksList
from finix.model.webhooks_list_embedded import WebhooksListEmbedded
diff --git a/openapitools.json b/openapitools.json
new file mode 100644
index 0000000..9cbc6d5
--- /dev/null
+++ b/openapitools.json
@@ -0,0 +1,7 @@
+{
+ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+ "spaces": 2,
+ "generator-cli": {
+ "version": "5.4.0"
+ }
+}
diff --git a/spec/finix_openapi.yaml b/spec/finix_openapi.yaml
index a12ea08..2bc82c1 100644
--- a/spec/finix_openapi.yaml
+++ b/spec/finix_openapi.yaml
@@ -46,6 +46,9 @@ tags:
- name: Transfers
description:
$ref: api-descriptions/tags/transfers.md
+- name: Split Transfers
+ description:
+ $ref: api-descriptions/tags/split-transfers.md
- name: Webhooks
description:
$ref: api-descriptions/tags/webhooks.md
@@ -55,6 +58,9 @@ tags:
- name: Merchant Profiles
description:
$ref: api-descriptions/tags/merchant-profiles.md
+- name: Payout Profiles
+ description:
+ $ref: api-descriptions/tags/payout-profiles.md
- name: Reversals
description:
$ref: api-descriptions/tags/reversals.md
@@ -79,49 +85,77 @@ tags:
x-tagGroups:
- name: MAIN RESOURCES
tags:
- - Identities
- - Merchants
- - Payment Instruments
- Authorizations
- - Transfers
- - Webhooks
- - Settlements
+ - Compliance Forms
+ - Devices
- Disputes
+ - Fee Profiles
- Files
- - Verifications
- - Fees
- - Users
+ - Identities
- Instrument Updates
- - Merchant Profiles
- - Fee Profiles
+ - Merchants
- Onboarding Forms
- - Compliance Forms
- - Devices
+ - Payment Instruments
+ - Settlements
+ - Split Transfers
+ - Transfers
+ - Users
+ - Webhooks
- name: CORE-PAYFAC RESOURCES
tags:
- - Applications
- Application Profiles
- - Processors
+ - Applications
- Balance Transfers
+ - Merchant Profiles
+ - Payout Profiles
+ - Verifications
- name: SUBSCRIPTION BILLING
tags:
- Subscription Schedules
- Subscription Amounts
- Subscription Enrollments
paths:
+ /applications:
+ post:
+ description: 'If created successfully, a 201 response gets returned and adds
+ a location header
+
+ to the response which refers to the new created `Application`.
+
+ '
+ summary: Create an Application
+ operationId: createApplication
+ requestBody:
+ $ref: '#/components/requestBodies/CreateApplicationRequest'
+ responses:
+ '201':
+ $ref: '#/components/responses/Application'
+ '400':
+ $ref: '#/components/responses/ErrorUnprocessableEntity'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/applications/create-application.md
+ x-python-method-name: create
/authorizations:
post:
tags:
- Authorizations
- description: "Create an `Authorization` to process a transaction.\n\n`Authorizations`\
- \ can have six possible `states`, two of which are expected:\n\n- **SUCCEEDED**\
- \ \n- **FAILED**\n\nIf the `Authorization` has **SUCCEEDED** , it must be\
- \ captured before `expires_at` passes or the funds will be released. If the\
- \ `transfer` field of an `Authorization` is **null**, it hasn't been captured\
- \ yet.\n\nLearn how to prevent duplicate authorizations by passing an [Idempotency\
- \ ID](#section/Idempotency-Requests) in the payload.\n- `Authorizations` on\
- \ debit cards place a hold on funds in the cardholder's bank account and can\
- \ lead to lower than expected balances or issues with insufficient funds."
+ description: 'Create an `Authorization` to process a transaction.
+
+
+ Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/),
+ [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/),
+ [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/),
+ [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
summary: Create an Authorization
operationId: createAuthorization
requestBody:
@@ -144,6 +178,20 @@ paths:
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
@@ -152,17 +200,25 @@ paths:
summary: List Authorizations
operationId: listAuthorizations
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryAmountFilter'
- $ref: '#/components/parameters/QueryAmountGtFilter'
- $ref: '#/components/parameters/QueryAmountGteFilter'
- $ref: '#/components/parameters/QueryAmountLtFilter'
- $ref: '#/components/parameters/QueryAmountLteFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
+ - $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryIdempotencyIdFilter'
- $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QuerySort'
+ - $ref: '#/components/parameters/TagsKey'
+ - $ref: '#/components/parameters/TagsValue'
- in: query
name: state
description: Filter by Transaction state.
@@ -241,7 +297,14 @@ paths:
in: query
name: type
description: Type of the `Authorization`.
- - $ref: '#/components/parameters/QueryAfterCursor'
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
responses:
'200':
$ref: '#/components/responses/AuthorizationsList'
@@ -258,8 +321,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/authorizations \\\n \
- \ -H \"Content-Type: application/vnd.json+api\" \\\n -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/authorizations\" \\\
+ \n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/authorizations/{authorization_id}:
@@ -284,21 +347,28 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/authorizations/AUsCN6f7qTLzxUD3Bp6iXQMQ\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
- $ref: '#/components/parameters/AuthorizationId'
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
put:
tags:
- Authorizations
- description: "If successfully captured, the `transfer` field of the `Authorization`\
- \ will contain the ID of the `Transfer` resource that'll move funds. \n\n\
- By default, `Transfers` are in a **PENDING** state. The **PENDING** state\
- \ means the request to capture funds hasn't been submitted yet. Capture requests\
- \ get submitted via a batch request. \n\nOnce the `Authorization` is updated\
- \ with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will\
- \ update to **SUCCEEDED**.\n\n> Voided `Authorizations` can't be captured."
+ description: 'Use a PUT request to capture an `Authorization`. If captured successfully,
+ the `transfer` field of the `Authorization` will contain the ID of the `Transfer`
+ resource that moves funds.
+
+
+ Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/),
+ [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/),
+ [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/),
+ [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
summary: Capture an Authorization
operationId: captureAuthorization
requestBody:
@@ -316,6 +386,76 @@ paths:
$ref: '#/components/responses/Error422InvalidField'
x-internal: false
x-java-method-name: update
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: update
+ /authorizations/{authorization_id_void_to}:
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ name: authorization_id_void_to
+ in: path
+ required: true
+ put:
+ tags:
+ - Authorizations
+ description: 'Use a PUT request to void an `Authorization`. If voided successfully,
+ funds get released and the transaction stops from completing. Additionally,
+ voided `Authorization` can no longer be captured.
+
+
+ Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/),
+ [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/),
+ [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/),
+ [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)'
+ summary: Void an Authorization
+ operationId: voidAuthorization
+ requestBody:
+ $ref: '#/components/requestBodies/VoidAuthorizationRequest'
+ responses:
+ '200':
+ $ref: '#/components/responses/AuthorizationUpdated'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
+ x-internal: false
+ x-java-method-name: update
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: update
/balance_transfers:
post:
@@ -339,8 +479,18 @@ paths:
$ref: '#/components/requestBodies/CreateBalanceTransferRequest'
x-internal: false
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/balance-transfer/create-balance-transfer.md
x-python-method-name: create
- parameters: []
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
get:
summary: List Balance Transfers
operationId: listBalanceTransfers
@@ -360,7 +510,6 @@ paths:
description: Retrieve a list of `balance_transfers`.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QueryOffset'
- schema:
type: integer
in: query
@@ -410,8 +559,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/balance_transfers/ \\\
- \n -H \"Content-Type: application/vnd.json+api\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/balance_transfers/\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
x-python-method-name: list
x-returns-list: true
/balance_transfers/{balance_transfers_id}:
@@ -422,6 +571,11 @@ paths:
in: path
required: true
description: ID of the `balance_transfer` resource.
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
get:
summary: Fetch a Balance Transfer
tags:
@@ -444,16 +598,59 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n"
x-python-method-name: get
/devices/{device_id}:
- get:
- description: 'Retrieve the details of an existing `Device`.
+ put:
+ description: 'Initiate an action on a `Device`. Actions that are available include:
+
+ - Activating the `Device`
+ - Rebooting the `Device`
- To check the connectivity of the device, include `?include_connection\=true\`
- at the end of the request endpoint.'
+ - Setting an idle message
+
+ - Deactivating the `Device`
+
+
+ You can also use a PUT request to update the `configuration_details`, `description`,
+ `name`, and `serial_number` of the `Device`.'
+ summary: Initiate Action on Device
+ operationId: updateDevice
+ requestBody:
+ $ref: '#/components/requestBodies/UpdateDeviceRequest'
+ responses:
+ '200':
+ $ref: '#/components/responses/Device'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ x-java-method-name: update
+ tags:
+ - Devices
+ parameters:
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ x-python-method-name: update
+ get:
+ description: Retrieve the details of an existing `Device`.
summary: Fetch a Device
operationId: getDevice
responses:
@@ -480,23 +677,27 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of the `Device`.
required: true
in: path
name: device_id
schema:
type: string
- put:
- description: Initiate an action on a `Device`. These actions include activation,
- rebooting, setting an idle message, or deactivate it.
- summary: Initiate Action on Device
- operationId: updateDevice
- requestBody:
- $ref: '#/components/requestBodies/UpdateDeviceRequest'
+ /devices/{device_id_connection}:
+ get:
+ description: To check the connection of the `Device`, include `?include_connection\=true\`
+ at the end of the request endpoint.
+ summary: Check Device Connection
+ operationId: getDeviceConnection
responses:
'200':
$ref: '#/components/responses/Device'
@@ -508,10 +709,34 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
- x-java-method-name: update
+ x-java-method-name: get
+ parameters:
+ - schema:
+ type: boolean
+ in: query
+ name: include_connection
+ description: Specifies whether the connection information should be included.
+ required: true
+ x-group-parameters: true
tags:
- Devices
- x-python-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: "curl \"https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f?include_connection=true\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3\n"
+ x-python-method-name: get
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ name: device_id_connection
+ in: path
+ required: true
/disputes:
get:
tags:
@@ -520,13 +745,116 @@ paths:
summary: List Disputes
operationId: listDisputes
parameters:
- - $ref: '#/components/parameters/QuerySort'
- - $ref: '#/components/parameters/QueryOffset'
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
+ - schema:
+ type: string
+ in: query
+ name: transfer_id
+ description: 'Filter by the ID of the `Transfer` that''s being disputed.
**Note**:
+ If included, all other filter parameters are ignored.'
+ - schema:
+ type: string
+ in: query
+ name: adjustment_transfer_id
+ description: 'Filter by the ID of the adjustment `Transfer`.
**Note**:
+ If included, all other filter parameters are ignored.'
+ - $ref: '#/components/parameters/QueryAmountFilter'
+ - $ref: '#/components/parameters/QueryAmountGteFilter'
+ - $ref: '#/components/parameters/QueryAmountGtFilter'
+ - $ref: '#/components/parameters/QueryAmountLtFilter'
+ - schema:
+ type: string
+ in: query
+ name: state
+ description: Filter by the state of the `Dispute`.
+ - schema:
+ type: string
+ in: query
+ name: response_state
+ description: Filter by the `response_state` of the `Dispute`.
+ - schema:
+ type: string
+ in: query
+ name: respond_by.lte
+ description: Filter where `respond_by` is before the given date.
+ - schema:
+ type: string
+ in: query
+ name: respond_by.gte
+ description: Filter where `respond_by` is after the given date.
+ - schema:
+ type: string
+ in: query
+ name: instrument_bin
+ description: Filter by the Bank Identification Number (BIN). The BIN is the
+ first 6 digits of the masked account number.
+ - schema:
+ type: string
+ in: query
+ name: instrument_brand_type
+ description: Filter by the card brand used.
+ - in: query
+ name: merchant_identity_id
+ description: Filter by the ID of the `Identity` used by the `Merchant`.
+ schema:
+ type: string
+ - schema:
+ type: string
+ in: query
+ name: merchant_identity_name
+ description: Filter by the name used by the `Merchant`.
+ - schema:
+ type: string
+ in: query
+ name: instrument_name
+ description: Filter by the name of the `Payment Instrument`.
+ - schema:
+ type: string
+ in: query
+ name: instrument_type
+ description: Filter by `Payment Instrument` type.
+ - schema:
+ type: string
+ in: query
+ name: merchant_id
+ description: Filter by the ID of the `Merchant`.
+ - schema:
+ type: string
+ in: query
+ name: merchant_mid
+ description: Filter by the MID of the `Merchant`.
+ - schema:
+ type: string
+ in: query
+ name: instrument_card_last4
+ description: Filter by the last 4 digits of the card used.
+ - schema:
+ type: string
+ in: query
+ name: instrument_card_type
+ description: Filter by the card type.
+ - schema:
+ type: string
+ in: query
+ name: instrument_fingerprint
+ description: Filter by the fingerprint of the `Payment Instrument`.
+ - schema:
+ type: string
+ in: query
+ name: before_cursor
+ description: Returns every `Dispute` created before the cursor value.
+ - $ref: '#/components/parameters/TagsKey'
+ - $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/DisputesList'
@@ -541,8 +869,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/disputes/ \\\n -H \"\
- Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/\" \\\n -H\
+ \ \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/disputes/{dispute_id}:
@@ -567,31 +895,71 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
- - description: ID of `Dispute` to fetch.
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - description: ID of `Dispute`.
required: true
in: path
name: dispute_id
schema:
type: string
- /disputes/{dispute_id}/evidence:
- post:
- tags:
- - Disputes
- description: 'Upload dispute evidence for a `Dispute`.
-
-
- - You can upload up to 8 files; the total size of the uploaded files combined
- cannot exceed 10 MB.
-
- - The allowed file formats include JPG, PNG, PDF, or TIFF.
-
+ put:
+ summary: Update a Dispute
+ operationId: updateDispute
+ responses:
+ '200':
+ $ref: '#/components/responses/Dispute'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ description: Update `tags` on `Disputes`.
+ requestBody:
+ $ref: '#/components/requestBodies/UpdateDisputeEvidence'
+ x-java-method: put
+ tags:
+ - Disputes
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: update_dispute
+ /disputes/{dispute_id}/evidence:
+ post:
+ tags:
+ - Disputes
+ description: 'Upload a file as evidence for a `Dispute`.
+
+
+ - You can upload up to 8 files; the total size of the uploaded files combined
+ cannot exceed 10 MB.
+
+ - The allowed file formats include JPG, PNG, PDF, or TIFF.
+
- Individual PNG and JPEG files can''t exceed 50 KB; PDF and TIFF files can''t
exceed 1 MB.'
- summary: Upload Dispute Evidence
+ summary: Upload Files as Dispute Evidence
operationId: createDisputeEvidence
responses:
'201':
@@ -604,7 +972,17 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
- parameters: []
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/disputes/uploadevidence.md
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
requestBody:
$ref: '#/components/requestBodies/CreateDisputeEvidenceRequest'
x-python-method-name: create_dispute_evidence
@@ -634,11 +1012,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_dispute_evidence_by_dispute_id
x-returns-list: true
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Dispute` to mange evidence for.
required: true
in: path
@@ -668,10 +1051,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get_dispute_evidence
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Dispute` to fetch evidence for.
required: true
in: path
@@ -684,6 +1072,41 @@ paths:
name: evidence_id
schema:
type: string
+ put:
+ summary: Update Dispute Evidence
+ operationId: updateDisputeEvidence
+ responses:
+ '200':
+ $ref: '#/components/responses/DisputeEvidence'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ description: Update tags on `Dispute` evidence.
+ requestBody:
+ $ref: '#/components/requestBodies/UpdateDisputeEvidence'
+ x-java-method: put
+ tags:
+ - Disputes
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: update_dispute_evidence
/fee_profiles:
get:
description: List all `Fee Profiles`.
@@ -701,6 +1124,12 @@ paths:
x-java-method-name: list
x-group-parameters: true
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryLimit'
@@ -709,8 +1138,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/fee_profiles \\\n -H\
- \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/fee_profiles\" \\\n\
+ \ -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
post:
@@ -731,6 +1160,11 @@ paths:
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/fee-profiles/create-fee-profile.md
tags:
- Fee Profiles
x-python-method-name: create
@@ -756,10 +1190,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- required: true
in: path
name: fee_profile_id
@@ -770,15 +1209,10 @@ paths:
post:
tags:
- Identities
- description: "Create an `Identity` for your merchant or buyer.\n\nAll fields\
- \ for a buyer's `Identity` are optional. \n\nProviding `business_type` indicates\
- \ that the `Identity` is being created for a Merchant.\n\nCreating `Identities`\
- \ for merchants requires they provide [KYC details](/docs/guides/getting-started/).\n\
- - When creating an `Identity` for a buyer , don't pass the `business_type`\
- \ field. Including a value for `business_type` configures the created `Identity`\
- \ to get processed as a merchant.\n- When creating an `Identity` for a buyer,\
- \ all fields are optional .\nRelated Guides: [Getting Started](/docs/guides/getting-started/),\
- \ [Onboarding](/docs/guides/onboarding/)"
+ description: "Create an `Identity` for your seller or buyer.\n\nAll fields for\
+ \ a buyer's `Identity` are optional. \n\nProviding `business_type` indicates\
+ \ that the `Identity` is being created for a Merchant.\n\nRelated Guides:\
+ \ [Getting Started](/guides/getting-started/), [Onboarding](/guides/onboarding/)"
summary: Create an Identity
operationId: createIdentity
requestBody:
@@ -795,15 +1229,34 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
- Identities
- description: Retrieves a list of `Identities`.
+ description: Retrieve a list of `Identities`.
summary: List Identities
operationId: listIdentities
parameters:
- - $ref: '#/components/parameters/QuerySort'
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
@@ -817,6 +1270,8 @@ paths:
- $ref: '#/components/parameters/QueryLastName'
- $ref: '#/components/parameters/QueryTitle'
- $ref: '#/components/parameters/QueryBeforeCursor'
+ - $ref: '#/components/parameters/TagsKey'
+ - $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/IdentitiesList'
@@ -833,8 +1288,9 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/identities \\\n -H \"\
- Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/identities\" \\\n \
+ \ -H \"Content-Type: application/json\" \\\n -H \"Finix-Version: 2022-02-01\"\
+ \ \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/identities/{identity_id}:
@@ -859,10 +1315,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of the `Identity` to fetch.
required: true
in: path
@@ -874,7 +1335,7 @@ paths:
- Identities
description: "Update an existing `Identity`.\n\nIf you are updating the `Identity`\
\ of a `Merchant` that\u2019s already been onboarded, you need to [verify\
- \ the merchant again](#operation/createMerchantVerification)."
+ \ the merchant again](/api/tag/Merchants/#tag/Merchants/operation/createMerchantVerification)."
summary: Update an Identity
operationId: updateIdentity
requestBody:
@@ -893,14 +1354,19 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/identities/updateidentity.md
x-python-method-name: update
/identities/{identity_id}/associated_identities:
post:
tags:
- Identities
description: Create an associated `Identity` for [every owner with 25% or more
- ownership](/guides/onboarding/#step-3-add-associated-identities) over the
- merchant.
+ ownership](/guides/onboarding/onboarding-with-api#step-3-add-associated-identities)
+ over the merchant.
summary: Create an Associated Identity
operationId: createAssociatedIdentity
requestBody:
@@ -922,13 +1388,14 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/identities/IDgXNAaoy5d4TLkp5ze6gScA/associated_identities\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n\
+ source: "curl \"https://finix.sandbox-payments-api.com/identities/IDgXNAaoy5d4TLkp5ze6gScA/associated_identities\"\
+ \ \\\n -H \"Content-Type: application/json\" \\\n -H \"Finix-Version:\
+ \ 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n\
\ -d '\n{\n \"entity\": {\n \"first_name\": \"John\", \n \
\ \"last_name\": \"Smith\", \n \"title\": \"Founder\", \n \
\ \"dob\": {\n \"month\": 1, \n \"day\": 1, \n\
\ \"year\": 2013\n }, \n \"principal_percentage_ownership\"\
- : 25, \n \"phone\": \"1234567890\", \n \"personal_address\"\
+ : 25, \n \"phone\": \"14158885080\", \n \"personal_address\"\
: {\n \"city\": \"San Francisco\", \n \"region\":\
\ \"CA\", \n \"postal_code\": \"90650\", \n \"line1\"\
: \"123 Main Street\", \n \"country\": \"USA\"\n }, \n\
@@ -967,11 +1434,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_associated_identities
x-returns-list: true
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Identity` to associate object with.
required: true
in: path
@@ -980,6 +1452,11 @@ paths:
type: string
/identities/{identity_id}/merchants:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Identity` to fetch.
required: true
in: path
@@ -987,22 +1464,12 @@ paths:
schema:
type: string
post:
- description: "Create a `Merchant` to start the underwriting (also called provisioning)\
- \ process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities).\n\
- \n> A bank account must be associated with the previously created `Identity`\
- \ before a `Merchant` can be succefully onboarded and verified.\n\n`Merchant`\
- \ resources can have three possible `onboarding_states`:\n\n1. **PROVISIONING**:\
- \ The request is pending (the state can change after two minutes).\n *\
- \ `processing_enabled`: **False**\n * `settlement_enabled`: **False**\n\
- \n1. **APPROVED**: The `Merchant` has been approved and can begin processing\
- \ payments.\n * `processing_enabled`: **True**\n * `settlement_enabled`:\
- \ **True**\n\n1. **REJECTED**: The `Merchant` was rejected by the processor\
- \ because of invalid information or it failed a regulatory and/or compliance\
- \ check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and\
- \ [try verifying the `Merchant` again](#operation/createMerchantVerification).\n\
- \ * `processing_enabled`: **False**\n * `settlement_enabled`: **False**\n\
- \n\n> Provisioning a `Merchant` account is an asynchronous request. We recommend\
- \ creating a [`Webhook`](#tag/Webhooks) to listen for the state change."
+ description: 'Create a `Merchant` to start the underwriting (also called provisioning)
+ process for your seller. `Merchants` must be created under an [`Identity`](/api/tag/Identities).
+
+
+ A bank account must be associated with the previously created `Identity` before
+ a `Merchant` can be successfully onboarded and verified.'
summary: Create a Merchant
operationId: createMerchant
requestBody:
@@ -1025,9 +1492,23 @@ paths:
tags:
- Merchants
x-java-method-name: create
+ parameters:
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
/identities/{identity_id}/settlements:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: 'ID of the `Identity` for the merchant you want to settle. '
required: true
in: path
@@ -1039,11 +1520,13 @@ paths:
\ creates accruing `settlements` then closes them based on your payout configurations.\
\ Use this endpoint to manually close the currently accruing settlement.\n\
\nThe closed `Settlement` will not accrue any further transactions and gets\
- \ immediately submitted for approval.\n- Any refunded `Transfers` get included\
- \ in `Settlements` as a deduction.\n- **PENDING** `Transfers` don't get included\
- \ in `Settlements`. \n- The `total_amount` minus the `total_fee` equals the\
- \ `net_amount`. The `net_amount` is the amount in cents that gets deposited\
- \ into the merchant's bank account.\n\nRelated Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement)"
+ \ immediately submitted for approval.\n- This endpoint is only available to\
+ \ Finix Core customers. If you have any questions, please contact the [Finix\
+ \ Support Team.](mailto:support@finixpayments.com)\n- Any refunded `Transfers`\
+ \ get included in `Settlements` as a deduction.\n- **PENDING** `Transfers`\
+ \ don't get included in `Settlements`. \n- The `total_amount` minus the `total_fee`\
+ \ equals the `net_amount`. The `net_amount` is the amount in cents that gets\
+ \ deposited into the seller's bank account.\n\nRelated Guides: [Accruing Settlements](/guides/payouts/accruing-settlements/#closing-an-accruing-settlement)"
summary: Close Current Active Settlement
operationId: createIdentitySettlement
requestBody:
@@ -1065,39 +1548,12 @@ paths:
$ref: '#/components/responses/ErrorMerchantIdentityDisabled'
x-internal: false
x-java-method-name: create
- tags:
- - Settlements
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/settlements/closesettlement.md
x-python-method-name: create
- /identities/{identity_id}/verifications:
- parameters:
- - description: ID of `Identity` to verify.
- required: true
- in: path
- name: identity_id
- schema:
- type: string
- post:
- summary: Verify an Identity
- operationId: createIdentityVerification
- responses:
- '201':
- $ref: '#/components/responses/Verification'
- '400':
- $ref: '#/components/responses/ErrorUnprocessableEntity'
- '401':
- $ref: '#/components/responses/ErrorUnauthorized'
- '403':
- $ref: '#/components/responses/ErrorForbidden403'
- '404':
- $ref: '#/components/responses/ErrorNotFound'
- '406':
- $ref: '#/components/responses/Error406NotAcceptable'
- description: Verify an `Identity`.
- requestBody:
- $ref: '#/components/requestBodies/CreateVerificationRequest'
- tags:
- - Identities
- x-python-method-name: create_identity_verification
/merchant_profiles:
get:
tags:
@@ -1106,6 +1562,12 @@ paths:
summary: List Merchant Profiles
operationId: listMerchantProfiles
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryLimit'
@@ -1124,8 +1586,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/merchant_profiles \\\n\
- \ -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/merchant_profiles\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/merchants:
@@ -1136,13 +1598,20 @@ paths:
summary: List Merchants
operationId: listMerchants
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryIdFilter'
- - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
+ - $ref: '#/components/parameters/QueryCreatedAtGteFilter'
+ - $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QuerySort'
+ - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
+ - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
responses:
'200':
$ref: '#/components/responses/MerchantsList'
@@ -1161,12 +1630,17 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/merchants \\\n -H \"\
- Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/merchants\" \\\n -H\
+ \ \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/merchants/{merchant_id}/devices:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of the `Merchant` object.
required: true
in: path
@@ -1196,6 +1670,11 @@ paths:
requestBody:
$ref: '#/components/requestBodies/CreateDeviceRequest'
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/devices/create-device.md
x-python-method-name: create
/merchants/{merchant_id}:
get:
@@ -1219,10 +1698,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N\"\
+ \ \\\n -H \"Content-Type: application/json\" \\\n -H \"Finix-Version:\
+ \ 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Merchant`.
required: true
in: path
@@ -1233,8 +1718,9 @@ paths:
tags:
- Merchants
description: "Update a `Merchant` to: \n- Change the `Identity` information\
- \ saved with the underlying processor\n- Enable Level 2/3 processing\n- Enable\
- \ [Buyer Chages](/guides/payments/buyer-charges/)"
+ \ saved with the underlying processor\n- [Enable Level 2/3 processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/)\n\
+ - Enable [buyer charges](/guides/payments/making-a-payment/buyer-charges/)\n\
+ - Disable a `Merchant` so the seller can't create new `Transfers` and `Authorizations`."
summary: Update a Merchant
operationId: updateMerchant
requestBody:
@@ -1251,6 +1737,20 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: update
/merchant_profiles/{merchant_profile_id}:
get:
@@ -1274,10 +1774,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `merchant_profile`.
required: true
in: path
@@ -1302,6 +1807,11 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/merchant-profiles/update-merchant-profile.md
x-internal: false
x-python-method-name: update
/merchants/{merchant_id}/verifications:
@@ -1338,11 +1848,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_by_merchant_id
x-returns-list: true
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Merchant` object.
required: true
in: path
@@ -1352,10 +1867,12 @@ paths:
post:
tags:
- Merchants
- description: If the `onboarding_state` for a `Merchant` returns **FAILED**,
- correct the `Identity` information saved for the `Merchant`. Once corrected,
- try verifying (also called provisioning) the `Merchant` again with another
- request.
+ description: 'Verify a `Merchant` if the `onboarding_state` for a `Merchant`
+ returns **FAILED**, or if the correct the seller needs to update the saved
+ in their information `Identity`.
+
+
+ Related Guides: [Onboarding Process](/guides/onboarding/onboarding-process/#reverify-a-merchant)'
summary: Verify a Merchant
operationId: createMerchantVerification
requestBody:
@@ -1373,7 +1890,22 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
- x-python-method-name: create_merchant_verification
+ x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: create
/payment_instruments:
post:
tags:
@@ -1381,12 +1913,8 @@ paths:
description: 'Create a `Payment Instrument` resource using a card or bank account.
- To accept payment details, review our guide on how to [tokenize cards using
- hosted fields](/guides/payments/tokenization-with-hosted-fields).
-
-
- The creation of `Payment Instruments` directly via Finix''s API should only
- be done for testing purposes. You must use the Hosted Tokenization fields
+ be done for testing purposes. You must use [our hosted fields](/guides/payments/making-a-payment/using-hosted-fields/)
or the javascript client to remain out of PCI scope.'
summary: Create a Payment Instrument
operationId: createPaymentInstrument
@@ -1404,6 +1932,20 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
@@ -1412,6 +1954,12 @@ paths:
summary: List Payment Instruments
operationId: listPaymentInstruments
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryAccountLastFour'
- $ref: '#/components/parameters/QueryAccountRoutingNumber'
- $ref: '#/components/parameters/QueryAfterCursor'
@@ -1427,6 +1975,8 @@ paths:
- $ref: '#/components/parameters/QueryName'
- $ref: '#/components/parameters/QueryOwnerIdentity'
- $ref: '#/components/parameters/QueryPaymentInstrumentType'
+ - $ref: '#/components/parameters/TagsKey'
+ - $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/PaymentInstrumentsList'
@@ -1441,8 +1991,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/payment_instruments \\\
- \n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/payment_instruments\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/payment_instruments/{payment_instrument_id}:
@@ -1469,10 +2019,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of object
required: true
in: path
@@ -1482,7 +2037,16 @@ paths:
put:
tags:
- Payment Instruments
- description: Update a `Payment Instrument`.
+ description: 'Update a `Payment Instrument` to:
+
+ - Change the **billing address** in case the account holder moved (`instrument_type`:**PAYMENT_CARD**
+ only).
+
+ - Disable the `Payment Instrument` resource so it can''t be used in requests.
+
+ - Update the `name` on the `Payment Instrument`.
+
+ - Change the `tags`.'
summary: Update a Payment Instrument
operationId: updatePaymentInstrument
requestBody:
@@ -1499,70 +2063,17 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
- x-python-method-name: update
- /payment_instruments/{payment_instrument_id}/updates:
- get:
- tags:
- - Payment Instruments
- description: 'List the updates on a `Payment Instrument`.
-
-
- When using the [account updater](/guides/payments/account-updater), `Payment
- Instrument` details that are updated are represented by an `Update`.'
- summary: List Payment Instrument Updates
- operationId: listPaymentInstrumentUpdates
parameters:
- - required: false
- in: query
- name: limit
- schema:
- type: integer
- format: int64
- description: The number of entries to return.
- - required: false
- in: query
- name: offset
- schema:
- type: integer
- format: int64
- description: The number of items to skip before starting to collect the result
- set.
- - required: false
- in: query
- name: pageSize
- schema:
- type: integer
- format: int64
- description: The size of the page.
- responses:
- '200':
- $ref: '#/components/responses/PaymentInstrumentUpdatesList'
- '401':
- $ref: '#/components/responses/ErrorUnauthorized'
- '403':
- $ref: '#/components/responses/ErrorForbidden403'
- '404':
- $ref: '#/components/responses/ErrorNotFound'
- '406':
- $ref: '#/components/responses/Error406NotAcceptable'
- x-java-method-name: listUpdatesByPaymentInstrumentId
- x-group-parameters: true
- x-internal: false
- x-codeSamples:
- - lang: cURL
- label: curl
- source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
- x-python-method-name: list_updates_by_payment_instrument_id
- x-returns-list: true
- parameters:
- - description: ID of `Payment Instrument` object.
- required: true
- in: path
- name: payment_instrument_id
- schema:
- type: string
- /payment_instruments/{payment_instrument_id}/verifications:
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: update
+ /payment_instruments/{payment_instrument_id_verify}:
get:
tags:
- Verifications
@@ -1616,17 +2127,21 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055\n"
x-python-method-name: list_by_payment_instrument_id
x-returns-list: true
parameters:
- - description: ID of `Payment Instrument `object.
- required: true
- in: path
- name: payment_instrument_id
+ - name: Accept
+ in: header
schema:
type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ name: payment_instrument_id_verify
+ in: path
+ required: true
/settlements:
get:
tags:
@@ -1639,28 +2154,47 @@ paths:
parameters:
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- - $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- - $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- - $ref: '#/components/parameters/QueryIdFilter'
- - $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QueryAfterCursor'
- - $ref: '#/components/parameters/QueryBeforeCursor'
- responses:
- '200':
- $ref: '#/components/responses/SettlementsList'
- '401':
- $ref: '#/components/responses/ErrorUnauthorized'
- '403':
- $ref: '#/components/responses/ErrorForbidden403'
- '406':
- $ref: '#/components/responses/Error406NotAcceptable'
- x-java-method-name: list
+ - $ref: '#/components/parameters/QueryAmountFilter'
+ - $ref: '#/components/parameters/QueryAmountGtFilter'
+ - $ref: '#/components/parameters/QueryAmountGteFilter'
+ - $ref: '#/components/parameters/QueryAmountLtFilter'
+ - $ref: '#/components/parameters/QueryAmountLteFilter'
+ - $ref: '#/components/parameters/QueryStatus'
+ - schema:
+ type: string
+ in: query
+ name: transfer_id
+ description: 'Filter by a `transfer_id` a `Settlement` has accrued. Please
+ note this filter is only available for non-versioned requests, or requests
+ using `-H ''Finix-Version: 2018-01-01''`. We''re actively working on making
+ this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).'
+ - schema:
+ type: string
+ in: query
+ name: funding_transfer_id
+ description: Filter by a `funding_transfer` a `Settlement` has created.
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
+ responses:
+ '200':
+ $ref: '#/components/responses/SettlementsList'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/settlements/ \\\n -H\
- \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/settlements/\" \\\n\
+ \ -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/settlements/{settlement_id}:
@@ -1685,16 +2219,66 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
+ put:
+ summary: Close a Settlement
+ operationId: closesettlements
+ responses:
+ '201':
+ $ref: '#/components/responses/Settlement'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ description: "Close an accruing `settlement`.\n\nFinix, by default, creates\
+ \ accruing `settlements` then closes them based on your payout configurations.\
+ \ Use this endpoint to manually close a specific `settlement`.\n\nThe closed\
+ \ `Settlement` will not accrue any further transactions and gets immediately\
+ \ submitted for approval.\n- This endpoint is only available to Finix Core\
+ \ customers. If you have any questions, please contact the [Finix Support\
+ \ Team](mailto:support@finixpayments.com).\n- Any refunded `Transfers` get\
+ \ included in `Settlements` as a deduction. \n- **PENDING** `Transfers` don't\
+ \ get included in `Settlements`.\n- The `total_amount` minus the `total_fee`\
+ \ equals the `net_amount`. The `net_amount` is the amount in cents that gets\
+ \ deposited into the seller's bank account."
+ requestBody:
+ $ref: '#/components/requestBodies/CloseSettlement'
+ x-java-method-name: put
+ tags:
+ - Settlements
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: put
/settlements/{settlement_id}/funding_transfers:
get:
tags:
@@ -1717,17 +2301,26 @@ paths:
x-java-method-name: listFundingTransfers
x-group-parameters: true
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QueryAfterCursor'
- - $ref: '#/components/parameters/QueryBeforeCursor'
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_funding_transfers
x-returns-list: true
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
@@ -1768,13 +2361,18 @@ paths:
$ref: '#/components/responses/Error422InvalidField'
x-internal: false
x-java-method-name: removeTransfersFromSettlement
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/settlements/deletesettlement.md
requestBody:
$ref: '#/components/requestBodies/RemoveSettlementTransfer'
x-python-method-name: remove_transfers_from_settlement
get:
description: Retrieve a list of every `Transfer` in a `Settlement` that has
`type` **DEBIT** or **REFUND**.
- summary: List Settlement Transfers
+ summary: List all Transfers in a Settlement
operationId: listSettlementTransfers
responses:
'200':
@@ -1794,16 +2392,19 @@ paths:
- Settlements
parameters:
- $ref: '#/components/parameters/QueryLimit'
- - $ref: '#/components/parameters/QueryAfterCursor'
- - $ref: '#/components/parameters/QueryBeforeCursor'
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_transfers_by_settlement_id
x-returns-list: true
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
@@ -1814,8 +2415,7 @@ paths:
post:
tags:
- Transfers
- description: "Create a `Transfer`. \n\n> By default, Finix implements a 3 (business)\
- \ day delay when debiting bank accounts (i.e. eChecks)."
+ description: Create a `Transfer`.
summary: Create a Transfer
operationId: createTransfer
requestBody:
@@ -1838,6 +2438,20 @@ paths:
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
@@ -1846,7 +2460,12 @@ paths:
summary: List Transfers
operationId: listTransfers
parameters:
- - $ref: '#/components/parameters/QuerySort'
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAmountFilter'
@@ -1858,6 +2477,8 @@ paths:
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryIdempotencyIdFilter'
- $ref: '#/components/parameters/QueryIdFilter'
+ - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtGteFilter'
+ - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtLteFilter'
- in: query
name: state
description: Filter by Transaction state.
@@ -1868,8 +2489,6 @@ paths:
- FAILED
- PENDING
- CANCELED
- - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtGteFilter'
- - $ref: '#/components/parameters/QuerySettlementReadyToSettleAtLteFilter'
- $ref: '#/components/parameters/QueryStatementDescriptorFilter'
- $ref: '#/components/parameters/QueryTraceIdFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
@@ -1948,6 +2567,8 @@ paths:
description: 'Filter by `Transfer` type. Available type filters include: All,
Debits, Refunds, or Credits.'
- $ref: '#/components/parameters/QueryBeforeCursor'
+ - $ref: '#/components/parameters/TagsKey'
+ - $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/TransfersList'
@@ -1964,8 +2585,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/transfers \\\n -H \"\
- Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/transfers\" \\\n -H\
+ \ \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/transfers/{transfer_id}:
@@ -1990,10 +2611,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh\"\
+ \ \\\n -H \"Content-Type: application/json\" \\\n -H \"Finix-Version:\
+ \ 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Transfer` resource.
required: true
in: path
@@ -2020,18 +2647,19 @@ paths:
requestBody:
$ref: '#/components/requestBodies/UpdateTransferRequest'
x-java-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/transfers/updatetransfer.md
x-python-method-name: update
/transfers/{transfer_id}/reversals:
post:
tags:
- Transfers
description: "Reverse a transfer with a `type` of **DEBIT**. This reversal creates\
- \ a new `Transfer` resource with a `type` of **REVERSAL**. \n\nThe refund\
- \ can get delivered in most cases without the physical card. The card only\
- \ needs to be swiped (to receive the refund) when:\n\n- The payment type is\
- \ **DEBIT**, and the transaction is no longer in the Settlement batch.\n-\
- \ The payment type is **CREDIT**, and the transaction is no longer in the\
- \ batch and is older than 45 days."
+ \ a new `Transfer` resource with a `type` of **REVERSAL**. \n\nRelated Guides:\
+ \ [Refunding Payments](/guides/after-the-payment/refunding-and-cancelling-payments/)"
summary: Refund or Reverse a Transfer
operationId: createTransferReversal
requestBody:
@@ -2051,6 +2679,15 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/ErrorUnprocessableEntity'
+ parameters:
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create_transfer_reversal
get:
tags:
@@ -2059,6 +2696,12 @@ paths:
summary: List Reversals on a Transfer
operationId: listTransferReversals
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- required: false
in: query
name: limit
@@ -2084,8 +2727,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_transfers_reversals
x-returns-list: true
parameters:
@@ -2097,19 +2740,14 @@ paths:
type: string
/verifications:
post:
- tags:
- - Verifications
- description: 'Create a `Verification` to verify a merchant''s `Identity`.
+ description: 'Create a `Verification` to verify a seller''s `Identity`.
- Verifications can also be created directly on the resources you want to verify:
+ Verifications can also be created directly on the resources you want to verify.
+ For example:
- `POST /merchants/{merchant_id}/verifications`
-
- Verify `Payment Instruments` directly on the resource:
-
-
- `POST /payment_instruments/{payment_instrument_id}/verifications`'
summary: Create a Merchant Verification
operationId: createVerification
@@ -2129,6 +2767,11 @@ paths:
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/verifications/merchant-verification.md
x-python-method-name: create
get:
tags:
@@ -2137,6 +2780,12 @@ paths:
summary: List Verifications
operationId: listVerifications
parameters:
+ - name: Accept
+ in: header
+ description: Body Header
+ schema:
+ type: string
+ default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
@@ -2154,8 +2803,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/verifications \\\n -H\
- \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/verifications\" \\\n\
+ \ -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/verifications/{verification_id}:
@@ -2180,10 +2829,15 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Verification` object.
required: true
in: path
@@ -2214,6 +2868,20 @@ paths:
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
@@ -2239,8 +2907,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/webhooks \\\n -H \"\
- Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/webhooks\" \\\n -H\
+ \ \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/webhooks/{webhook_id}:
@@ -2265,10 +2933,16 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP\"\
+ \ \\\n -H \"Content-Type: application/json\" \\\n -H \"Finix-Version:\
+ \ 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- description: ID of `Webhook` object.
required: true
in: path
@@ -2278,7 +2952,13 @@ paths:
put:
tags:
- Webhooks
- description: Update an existing `Webhook`.
+ description: 'Update an existing `Webhook`to:
+
+ - Disable or enable an endpoint URL to recieve webhook events.
+
+ - Add [authentication to a `Webhook`](/guides/developers/webhooks/#authenticating-webhooks).
+
+ - Filter the [webhook events sent to an endpoint URL](/guides/developers/webhooks/#webhook-event-filtering).'
summary: Update a Webhook
operationId: updateWebhook
requestBody:
@@ -2295,6 +2975,20 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
x-python-method-name: update
/instrument_updates:
post:
@@ -2315,13 +3009,28 @@ paths:
resource. Include the `Payment Instrument` IDs you want to update in a CSV.
requestBody:
$ref: '#/components/requestBodies/CreateInstrumentUpdateRequest'
- parameters: []
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
tags:
- Instrument Updates
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/instrument-updates/create-instrument-updates.md
x-python-method-name: create
/instrument_updates/{instrument_updates_id}/download:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: instrument_updates_id
@@ -2349,6 +3058,12 @@ paths:
schema:
type: string
format: binary
+ examples:
+ Instrument Update:
+ value: payment_instrument_original,payment_instrument_new,result
+ PIlkNdfZibF8a7Prd2teGB1,PI3aQGaCM5nDMjqyTXcbUJzR,CARD_EXPIRATION_UPDATED
+ PIJPXW0HZ9lpO1nb6sog5DiX,PIdBHpy7BBSxd2z81VdKpVbT,CARD_NOT_FOUND
+ PIiRLbbG4i5daypWNzIrq2xD,,NO_CHANGE_FOUND PIy5llZGt6VxlDqbcTgATqeH,,UNKNOWN
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
@@ -2368,8 +3083,8 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/download\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/instrument_updates/IUd2Wzs6jxPJjteva3n19Amu/download\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: download
/files:
post:
@@ -2386,9 +3101,14 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/files/createfile.md
description: "Before uploading a file, you need to create a `File` resource.\
- \ \n\nOnce created, you can [upload](/#operation/uploadFile) your file to\
- \ the new `File` resource."
+ \ \n\nOnce created, you can [upload](/guides/onboarding/uploading-files-to-finix/#how-to-upload-a-file-to-finix)\
+ \ your file to the new `File` resource."
requestBody:
$ref: '#/components/requestBodies/CreateFileRequest'
tags:
@@ -2411,10 +3131,8 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listFiles
- description: List all the `File` resources you've created. For more info, see
- [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-1-create-a-file).
+ description: List all the `File` resources you've created.
parameters:
- - $ref: '#/components/parameters/QuerySort'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
@@ -2428,12 +3146,22 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/files \\\n -H \"Content-Type:\
- \ application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: 'curl "https://finix.sandbox-payments-api.com/files" \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
x-python-method-name: list
x-returns-list: true
/files/{file_id}:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: file_id
@@ -2456,17 +3184,27 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getFile
- description: Retrieve the details of a `File` resource. For more info see [Uploading
- files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
+ description: Retrieve the details of a `File` resource.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: 'curl "https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik"
+ \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
x-python-method-name: get
/files/{file_id}/external_links:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: file_id
@@ -2489,10 +3227,8 @@ paths:
'406':
description: Not Acceptable
operationId: listExternalLinks
- description: List the previously created `external_links` for a `File`. For
- more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
+ description: List the previously created `external_links` for a `File`.
parameters:
- - $ref: '#/components/parameters/QuerySort'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
@@ -2505,8 +3241,14 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: 'curl "https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik/external_links"
+ \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
x-python-method-name: list_external_links
x-returns-list: true
post:
@@ -2523,11 +3265,14 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
- description: "Create an `external_link` resource to share with users so they\
- \ can upload files directly from their browser. For more info, see [Uploading\
- \ files to Finix](/docs/guides/onboarding/uploading-files-to-finix/). \n\n\
- Once created, you can request the user to upload a file to the `external_link`\
- \ resource: [Upload files to External Link](#operation/uploadExternalLink)"
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/files/external-link.md
+ description: Create an `external_link` resource to share with users so they
+ can upload files directly from their browser. For more info, see [Uploading
+ files to Finix](/guides/onboarding/uploading-files-to-finix/).
requestBody:
$ref: '#/components/requestBodies/CreateExternalLinkRequest'
tags:
@@ -2535,6 +3280,11 @@ paths:
x-python-method-name: create_external_link
/files/{file_id}/upload:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: file_id
@@ -2555,10 +3305,19 @@ paths:
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
- description: Upload files directly with a `multipart/form-data` request. For
- more info see, [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#step-2-upload-the-file).
- parameters: []
+ description: Upload files directly with a `multipart/form-data` request.
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
x-java-method-name: upload
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/files/uploadfile.md
tags:
- Files
requestBody:
@@ -2566,6 +3325,11 @@ paths:
x-python-method-name: upload
/files/{file_id}/download:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: file_id
@@ -2573,7 +3337,7 @@ paths:
required: true
description: The ID of the `File` that was created to upload the file.
get:
- summary: Download a file
+ summary: Download a File
tags:
- Files
responses:
@@ -2589,16 +3353,35 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
operationId: downloadFile
x-java-method-name: download
- description: Download a file that was uploaded to a `File` resource. For more
- info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix).
+ description: Download a file that was uploaded to a `File` resource.
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStGPVpvKHtgA/download\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStGPVpvKHtgA/download\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ enum:
+ - 'true'
+ - 'false'
+ in: query
+ name: stream
+ description: Stream the contents of the `File` so it's displayed inline in
+ the user's web browser.
x-python-method-name: download
/files/{file_id}/external_links/{external_link_id}:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: file_id
@@ -2627,13 +3410,12 @@ paths:
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getExternalLink
- description: Fetch a previously created `external_link` resource. For more info
- see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link).
+ description: Fetch a previously created `external_link` resource.
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/EL_dh5YS66GePpkeSVyL4VdBL\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/EL_dh5YS66GePpkeSVyL4VdBL\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get_external_link
/apple_pay_sessions:
post:
@@ -2662,10 +3444,20 @@ paths:
To create an Apple Pay Session, pass the unique `validation_url` (provided
by Apple) while creating an `apple_pay_sessions` resource. Finix returns a
`merchantSession` object that you can use to create a payment. For more information,
- see [Apple Pay](/docs/guides/payments/alternative-payment-methods/apple-pay/).'
+ see [Apple Pay](/guides/payments/alternative-payment-methods/apple-pay/).'
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/payment-instruments/createapplepay.md
x-python-method-name: create_apple_pay_session
/disputes/{dispute_id}/adjustment_transfers:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: dispute_id
@@ -2703,12 +3495,17 @@ paths:
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_disputes_adjustments
x-returns-list: true
/instrument_updates/{instrument_updates_id}:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
description: The ID of the `instrument_update`.
@@ -2732,16 +3529,21 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getInstrumentUpdate
description: Fetch a specific `instrument_update` from an `instrument_updates`
- resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater).
+ resource.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
- source: "curl https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/\
- \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
+ source: "curl \"https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
/compliance_forms/{compliance_forms_id}:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: compliance_forms_id
@@ -2749,7 +3551,7 @@ paths:
required: true
description: ID of the `compliance_form`.
get:
- summary: View Compliance Forms
+ summary: Fetch a Compliance Form
tags:
- Compliance Forms
responses:
@@ -2765,6 +3567,11 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getComplianceForms
x-java-method-name: list
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/compliance-forms/fetch-compliance-form.md
description: 'A webhook notifies you when Finix creates a `compliance_form`.
@@ -2772,7 +3579,7 @@ paths:
`/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.'
x-python-method-name: list
put:
- summary: Complete Compliance Forms
+ summary: Complete a Compliance Form
operationId: updateComplianceForms
responses:
'200':
@@ -2792,26 +3599,64 @@ paths:
as a PDF if requested.
- To complete PCI compliance forms:
-
-
- 1. Get the `compliance_form` generated for the merchant using the `ID` from
- the webhook and present the form to your users when requested.
-
- 2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent)
- to obtain consent.
-
- 3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire)
- information.
-
-
For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).'
tags:
- Compliance Forms
requestBody:
$ref: '#/components/requestBodies/UpdateComplianceForm'
x-java-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/compliance-forms/complete-compliance-form.md
x-python-method-name: update
+ /compliance_forms:
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ get:
+ summary: List Compliance Forms
+ tags:
+ - Compliance Forms
+ responses:
+ '200':
+ $ref: '#/components/responses/ComplianceFormList'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ operationId: listComplianceForms
+ x-java-method-name: list
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/compliance-forms/list-compliance-forms.md
+ description: Retrieves a list of `Compliance Forms`.
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ enum:
+ - INCOMPLETE
+ - COMPLETE
+ in: query
+ name: state
+ description: Filter by the `state` of the `Compliance Form`.
+ x-python-method-name: list
+ x-returns-list: true
/onboarding_forms:
post:
summary: Create an Onboarding Form
@@ -2829,21 +3674,31 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
- description: 'Create an onboarding_form with the name of the processor you plan
- to onboard users to and the links they get redirected to when completing or
- moving away from the Finix Onboarding Form.
+ description: 'Create an `onboarding_form` with the name of the processor you
+ plan to onboard users to and the links they` get redirected to when completing
+ or moving away from the Finix Onboarding Form.
- > Use your **ROLE_PARTNER** credentials to create an `onboarding_form`.'
+ Only **ROLE_PARTNER** credentials can be used to create an `onboarding_form`.'
requestBody:
$ref: '#/components/requestBodies/CreateOnboardingFormRequest'
tags:
- Onboarding Forms
x-java-method-name: create
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/onboarding-form/create-onboarding-form.md
x-python-method-name: create
parameters: []
/onboarding_forms/{onboarding_form_id}:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: onboarding_form_id
@@ -2858,13 +3713,31 @@ paths:
$ref: '#/components/responses/OnboardingForm'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
description: Retrieve the details of an `onboarding_form`.
tags:
- Onboarding Forms
x-java-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/onboarding-form/fetch-onboarding-form.md
x-python-method-name: get
/onboarding_forms/{onboarding_form_id}/links:
parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
- schema:
type: string
name: onboarding_form_id
@@ -2887,146 +3760,607 @@ paths:
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
- description: You can use the `onboarding_forms` API to create a link that can
- return users to where they left off completing their Finix Onboarding Form.
+ description: Use the `onboarding_forms` API to create a link that can return
+ users to where they left off completing their Finix Onboarding Form.
requestBody:
$ref: '#/components/requestBodies/CreateOnboardingFormLinkRequest'
tags:
- Onboarding Forms
x-java-method-name: createLink
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/onboarding-form/onboarding-form-link.md
x-python-method-name: create_link
-components:
- headers:
- date:
- schema:
- type: string
- finix-apiuser-role:
- schema:
- type: string
- enum:
- - ROLE_ADMIN
- - ROLE_PLATFORM
- - ROLE_PARTNER
- - ROLE_MERCHANT
- x-request-id:
- description: A unique ID for this specific API request attempt.
+ /payout_profiles:
+ get:
+ summary: List Payout Profiles
+ responses:
+ '200':
+ $ref: '#/components/responses/PayoutProfilesList'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ description: Not Acceptable
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
+ operationId: listPayoutprofiles
+ description: List all `Payout Profiles`.
+ x-java-method-name: list
+ x-group-parameters: true
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: "curl \"https://finix.sandbox-payments-api.com/payout_profiles\" \\\
+ \n -H \"Finix-Version: 2022-02-01\" \\\n -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1\n"
+ tags:
+ - Payout Profiles
+ parameters:
+ - $ref: '#/components/parameters/QueryAfterCursor'
+ - $ref: '#/components/parameters/QueryLimit'
+ x-python-method-name: list
+ x-returns-list: true
+ /payout_profiles/{payout_profile_id}:
+ parameters:
+ - name: Accept
+ in: header
schema:
type: string
- parameters:
- ApplicationId:
- description: ID of `Application` to use.
- in: path
- name: application_id
- schema:
+ default: application/hal+json
+ - schema:
type: string
- required: true
- ApplicationProfileId:
- description: ID of `Application` profile to use.
- required: true
+ name: payout_profile_id
in: path
- name: application_profile_id
- schema:
- type: string
- AuthorizationId:
- description: ID of `Authorization` to fetch.
required: true
- in: path
- name: authorization_id
+ description: ID of the `Payout Profile`.
+ get:
+ summary: Fetch a Payout Profile
+ responses:
+ '200':
+ $ref: '#/components/responses/PayoutProfile'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
+ operationId: getPayoutprofile
+ description: Retrieve the details of a previously created `Payout Profile`.
+ x-java-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: "curl \"https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1\n"
+ tags:
+ - Payout Profiles
+ x-python-method-name: get
+ put:
+ summary: Update a Payout Profile
+ operationId: updatePayoutProfileRequest
+ responses:
+ '200':
+ $ref: '#/components/responses/PayoutProfile'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
+ description: 'Update a `Payout Profile` to configure how fees and payouts get
+ calculated, credited, and debited.
+
+
+ By default, `Merchants` get configured with daily net settlements. Payouts
+ get submitted using the **Next-Day ACH** `rail`. Contact [Finix Support](/guides/getting-started/support-at-finix/)
+ to configure payouts on a custom schedule.'
+ requestBody:
+ $ref: '#/components/requestBodies/UpdatePayoutProfileRequest'
+ tags:
+ - Payout Profiles
+ x-java-method-name: update
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/payout-profile/update-payout-profile.md
+ x-python-method-name: update
+ /merchants/{merchant_id}/payout_profile:
+ parameters:
+ - name: Accept
+ in: header
schema:
type: string
- FeeId:
- description: ID of `fee` to use.
- required: true
+ default: application/hal+json
+ - schema:
+ type: string
+ name: merchant_id
in: path
- name: fee_id
+ required: true
+ description: ID of the `Merchant`.
+ get:
+ summary: Fetch Payout Profile by Merchant
+ responses:
+ '200':
+ $ref: '#/components/responses/PayoutProfile'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/Error422InvalidField'
+ operationId: fetchPayoutProfilesbyMerchant
+ description: Fetch the the `Payout Profile` createrd for a specific `Merchant`.
+ x-java-method-name: getByMerchantId
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: "curl \"https://finix.sandbox-payments-api.com/merchants/MUfbbKm7vRmBX2bP92pKw9zZ/payout_profile\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1\n"
+ tags:
+ - Payout Profiles
+ x-python-method-name: get_by_merchant_id
+ /disputes/{dispute_id}/submit:
+ parameters:
+ - name: Accept
+ in: header
schema:
type: string
- QueryAmountFilter:
- description: Filter by an amount equal to the given value.
- in: query
- name: amount
- schema:
- type: integer
- style: form
- QueryAmountGtFilter:
- description: Filter by an amount greater than.
- in: query
- name: amount.gt
- schema:
- type: integer
- style: form
- QueryAmountGteFilter:
- description: Filter by an amount greater than or equal.
- in: query
- name: amount.gte
- schema:
- type: integer
- style: form
- QueryAmountLtFilter:
- description: Filter by an amount less than.
- in: query
- name: amount.lt
- schema:
- type: integer
- style: form
- QueryAmountLteFilter:
- description: Filter by an amount less than or equal.
- in: query
- name: amount.lte
- schema:
- type: integer
- style: form
- QueryApplicationFilter:
- description: Filter by `Application` ID.
- in: query
- name: application
- schema:
+ default: application/hal+json
+ - schema:
type: string
- style: form
- QueryCreatedAtGteFilter:
- description: Filter where `created_at` is after the given date.
- in: query
- name: created_at.gte
+ name: dispute_id
+ in: path
+ required: true
+ description: ID of `Dispute` to move forward and submit evidence.
+ post:
+ summary: Submit Dispute Evidence
+ operationId: submitDisputeEvidence
+ responses:
+ '200':
+ $ref: '#/components/responses/Dispute'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/ErrorUnprocessableEntity'
+ tags:
+ - Disputes
+ description: 'You can manually submit evidence to the issuing bank to manually
+ move a dispute forward. Use the `/disputes/DISPUTE_ID/submit` endpoint to
+ submit evidence. Making a POST request lets the issuing bank know the seller
+ has completed submitting evidence and is prepared to move forward with the
+ dispute.
+
+
+ Related guides: [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/).'
+ x-java-method-name: post
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/disputes/submit-dispute-evidence.md
+ requestBody:
+ $ref: '#/components/requestBodies/SubmitDisputeEvidence'
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ default: '2018-01-01'
+ example: '2022-02-01'
+ in: header
+ name: Finix-Version
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ x-python-method-name: post
+ /disputes/{dispute_id}/accept:
+ parameters:
+ - name: Accept
+ in: header
schema:
type: string
- example: created_at.gte=2019-06-15
- style: form
- QueryCreatedAtLteFilter:
- description: Filter where `created_at` is before the given date.
- in: query
- name: created_at.lte
- schema:
+ default: application/hal+json
+ - schema:
type: string
- example: created_at.lte=2019-06-15
- style: form
- QueryDefaultStatementDescriptorFilter:
- description: Filter by the `default_statement_descriptor`.
- in: query
- name: default_statement_descriptor
+ name: dispute_id
+ in: path
+ required: true
+ description: ID of `Dispute` to move forward and submit evidence.
+ post:
+ summary: Accept a Dispute
+ operationId: acceptDispute
+ responses:
+ '200':
+ $ref: '#/components/responses/Dispute'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ '422':
+ $ref: '#/components/responses/ErrorUnprocessableEntity'
+ description: 'You can accept a `Dispute` to prevent a long (and potentially
+ expensive) process. When you accept a `Dispute`, you concede that the Dispute
+ is not worth challenging or representing.
+
+
+ Related guides: [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/)
+
+ '
+ x-java-method-name: post
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source:
+ $ref: xcode/curl/disputes/accept-dispute.md
+ requestBody:
+ $ref: '#/components/requestBodies/AcceptDisputeRequest'
+ tags:
+ - Disputes
+ x-python-method-name: post
+ /disputes/{dispute_id}/evidence/{evidence_id}/download:
+ parameters:
+ - name: Accept
+ in: header
schema:
type: string
- style: form
- QueryIdFilter:
- description: Filter by `id`.
- in: query
- name: id
- schema:
+ default: application/hal+json
+ - schema:
type: string
- style: form
- QueryIdempotencyIdFilter:
- description: Filter by `idempotency_id`.
- in: query
- name: idempotency_id
- schema:
+ example: DIpCy4sZTx6im6U1ofBBPzdM
+ name: dispute_id
+ in: path
+ required: true
+ description: ID of `Dispute` to download evidence from.
+ - schema:
type: string
- style: form
- QueryLimit:
- description: The numbers of items to return.
- example: 10
- in: query
- name: limit
- schema:
- type: integer
+ example: DFtiQ1LoNbjBTYiuuxju6tE2
+ name: evidence_id
+ in: path
+ required: true
+ description: ID of `evidence` to download.
+ get:
+ summary: Download Dispute Evidence
+ tags:
+ - Disputes
+ responses:
+ '200':
+ $ref: '#/components/responses/FileDownload'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ operationId: downloadDisputeEvidence
+ description: 'Download a file uploaded as `Dispute Evidence`.
+
+
+ **Note**: The file extension included in `output` must match the extension
+ of the original uploaded file.'
+ x-java-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: "curl \"https://finix.sandbox-payments-api.com/disputes/DIpCy4sZTx6im6U1ofBBPzdM/evidence/DFtiQ1LoNbjBTYiuuxju6tE2/download\"\
+ \ \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\
+ \ \\\n --output DFtiQ1LoNbjBTYiuuxju6tE2.png\n"
+ parameters: []
+ x-python-method-name: get
+ /split_transfers/{split_transfer_id}:
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ name: split_transfer_id
+ in: path
+ required: true
+ get:
+ summary: Fetch a Split Transfer
+ responses:
+ '200':
+ $ref: '#/components/responses/SplitTransfer'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ operationId: getSplitTransfer
+ description: 'Fetch a `split_transfer` that was created from a split transaction.
+
+
+ For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
+ x-jave-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q"
+ \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
+ tags:
+ - Split Transfers
+ parameters: []
+ x-python-method-name: get_split_transfer
+ /split_transfers/{split_transfer_id}/fees:
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ name: split_transfer_id
+ in: path
+ required: true
+ get:
+ summary: Fetch Split Transfer Fees
+ responses:
+ '200':
+ $ref: '#/components/responses/TransfersList'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ operationId: getSplitTransferFees
+ description: 'Fetch the fees associated with a `split_transfer`.
+
+
+
+ For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
+ x-jave-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q/fees"
+ \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
+ tags:
+ - Split Transfers
+ parameters: []
+ x-python-method-name: get_split_transfer_fees
+ /split_transfers:
+ parameters: []
+ get:
+ summary: List Split Transfers
+ responses:
+ '200':
+ $ref: '#/components/responses/SplitTransfersList'
+ '401':
+ $ref: '#/components/responses/ErrorUnauthorized'
+ '403':
+ $ref: '#/components/responses/ErrorForbidden403'
+ '404':
+ $ref: '#/components/responses/ErrorNotFound'
+ '406':
+ $ref: '#/components/responses/Error406NotAcceptable'
+ operationId: listSplitTransfer
+ description: 'Retireve a list of `split_transfers` created for a specifc split
+ `Transfer`.
+
+
+ For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
+ x-jave-method-name: get
+ x-codeSamples:
+ - lang: cURL
+ label: curl
+ source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j"
+ \
+
+ -H "Content-Type: application/json" \
+
+ -H "Finix-Version: 2022-02-01" \
+
+ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
+
+ '
+ parameters:
+ - name: Accept
+ in: header
+ schema:
+ type: string
+ default: application/hal+json
+ - schema:
+ type: string
+ example: TRvQN3v5mhA2Ttc78hzjLV3j
+ pattern: TRxxxxxxxxxxxxxxxxxxxxxx
+ in: query
+ name: parent_transfer_id
+ description: '**ID** of the parent `Transfer` that was split.'
+ required: true
+ x-python-method-name: list_split_transfer
+ x-returns-list: true
+components:
+ headers:
+ date:
+ schema:
+ type: string
+ finix-apiuser-role:
+ schema:
+ type: string
+ enum:
+ - ROLE_ADMIN
+ - ROLE_PLATFORM
+ - ROLE_PARTNER
+ - ROLE_MERCHANT
+ version:
+ description: Specify the API version of your request. For more details, see
+ [Versioning.](/guides/developers/versioning/)
+ schema:
+ type: string
+ default: '2018-01-01'
+ example: 'Finix-Version: 2022-02-01'
+ x-request-id:
+ description: A unique ID for this specific API request attempt.
+ schema:
+ type: string
+ parameters:
+ ApplicationId:
+ description: ID of `Application` to use.
+ in: path
+ name: application_id
+ schema:
+ type: string
+ required: true
+ ApplicationProfileId:
+ description: ID of `Application` profile to use.
+ required: true
+ in: path
+ name: application_profile_id
+ schema:
+ type: string
+ AuthorizationId:
+ description: ID of `Authorization` to fetch.
+ required: true
+ in: path
+ name: authorization_id
+ schema:
+ type: string
+ FeeId:
+ description: ID of `fee` to use.
+ required: true
+ in: path
+ name: fee_id
+ schema:
+ type: string
+ QueryAmountFilter:
+ description: Filter by an amount equal to the given value.
+ in: query
+ name: amount
+ schema:
+ type: integer
+ style: form
+ QueryAmountGtFilter:
+ description: Filter by an amount greater than.
+ in: query
+ name: amount.gt
+ schema:
+ type: integer
+ style: form
+ QueryAmountGteFilter:
+ description: Filter by an amount greater than or equal.
+ in: query
+ name: amount.gte
+ schema:
+ type: integer
+ style: form
+ QueryAmountLtFilter:
+ description: Filter by an amount less than.
+ in: query
+ name: amount.lt
+ schema:
+ type: integer
+ style: form
+ QueryAmountLteFilter:
+ description: Filter by an amount less than or equal.
+ in: query
+ name: amount.lte
+ schema:
+ type: integer
+ style: form
+ QueryApplicationFilter:
+ description: Filter by `Application` ID.
+ in: query
+ name: application
+ schema:
+ type: string
+ style: form
+ QueryCreatedAtGteFilter:
+ description: Filter where `created_at` is after the given date.
+ in: query
+ name: created_at.gte
+ schema:
+ type: string
+ example: '2022-09-27T11:21:23'
+ style: form
+ QueryCreatedAtLteFilter:
+ description: Filter where `created_at` is before the given date.
+ in: query
+ name: created_at.lte
+ schema:
+ type: string
+ example: '2022-09-27T11:21:23'
+ style: form
+ QueryDefaultStatementDescriptorFilter:
+ description: Filter by the `default_statement_descriptor`.
+ in: query
+ name: default_statement_descriptor
+ schema:
+ type: string
+ style: form
+ QueryIdFilter:
+ description: Filter by `id`.
+ in: query
+ name: id
+ schema:
+ type: string
+ style: form
+ QueryIdempotencyIdFilter:
+ description: Filter by `idempotency_id`.
+ in: query
+ name: idempotency_id
+ schema:
+ type: string
+ style: form
+ QueryLimit:
+ description: The numbers of items to return.
+ example: 10
+ in: query
+ name: limit
+ schema:
+ type: integer
style: form
QueryOffset:
description: The number of items to skip before starting to collect the result
@@ -3038,18 +4372,22 @@ components:
type: integer
style: form
QuerySettlementReadyToSettleAtGteFilter:
- description: Filter by `ready_to_settle_at`.
+ description: 'Filter where `ready_to_settle_at` is after the given date. Only
+ available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
in: query
name: ready_to_settle_at.gte
schema:
type: string
+ example: ?ready_to_settle_at.gte=2023-06-28T00:00:00
style: form
QuerySettlementReadyToSettleAtLteFilter:
- description: Filter by `ready_to_settle_at`.
+ description: 'Filter where `ready_to_settle_at` is before the given date. Only
+ available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
in: query
name: ready_to_settle_at.lte
schema:
type: string
+ example: ?ready_to_settle_at.lte=2023-06-28T00:00:00
style: form
QuerySort:
description: Specify key to be used for sorting the collection.
@@ -3123,7 +4461,7 @@ components:
required: false
schema:
type: string
- example: first_name=Daphne
+ example: Daphne
description: Filter by the first name of the person associated to the `Identity`.
QueryLastName:
name: last_name
@@ -3185,7 +4523,7 @@ components:
description: Filter by the 4 digit expiration year associated with the Payment
Instrument if applicable. This filter only applies to payment cards.
QueryLastFour:
- name: last_four
+ name: last4
in: query
required: false
schema:
@@ -3199,7 +4537,7 @@ components:
required: false
schema:
type: string
- example: fran%20lemke
+ example: john%20smith
description: Filter by the name.
QueryOwnerIdentity:
name: owner_identity_id
@@ -3244,142 +4582,166 @@ components:
example: /download?format=json
description: Specify the format you'd like to download the response in (JSON
is the only other format available for download).
+ TagsKey:
+ name: tags.key
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ TagsValue:
+ name: tags.value
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
+ QueryStatus:
+ name: status
+ in: query
+ required: false
+ schema:
+ type: string
+ enum:
+ - PENDING
+ - AWAITING_APPROVAL
+ - APPROVED
+ description: Filter by the status of the `Settlement`. Available values include:- **PENDING**
- **STAGED**
- **AWAITING_APPROVAL**
- **APPROVED**.
+ Merchants only receive payouts when `Settlements` are **APPROVED**. For more
+ information, see [Payouts](/docs/guides/payouts/payouts/).
requestBodies:
CreateApplicationRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateApplicationRequest'
examples:
Create an Application:
value:
- tags:
- application_name: Finix Flowers
- user: USpbnPYf1MMaYYtBqNsNzD6T
entity:
- business_type: LIMITED_LIABILITY_COMPANY
- business_phone: +1 (408) 756-4497
- first_name: John
- last_name: Smith
- dob:
- year: 1978
- day: 27
- month: 5
business_address:
city: San Mateo
country: USA
- region: CA
- line2: Apartment 8
line1: 741 Douglass St
+ line2: Apartment 8
postal_code: '94114'
- max_transaction_amount: 1200000
- phone: '1234567890'
+ region: CA
+ business_name: Finix Flowers
+ business_phone: +1 (408) 756-4497
+ business_tax_id: '123456789'
+ business_type: LIMITED_LIABILITY_COMPANY
+ dob:
+ day: 27
+ month: 5
+ year: 1978
doing_business_as: Finix Flowers
+ email: user@example.org
+ first_name: John
+ last_name: Smith
+ max_transaction_amount: 1200000
personal_address:
city: San Mateo
country: USA
- region: CA
- line2: Apartment 7
line1: 741 Douglass St
+ line2: Apartment 7
postal_code: '94114'
- business_name: Finix Flowers
- business_tax_id: '123456789'
- email: user@example.org
+ region: CA
+ phone: '14158885080'
tax_id: '123456789'
+ tags:
+ application_name: Finix Flowers
+ user: USpbnPYf1MMaYYtBqNsNzD6T
UpdateApplicationProfileRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateApplicationProfileRequest'
CreateAuthorizationRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateAuthorizationRequest'
examples:
- Create an Authorization:
+ Authorization:
value:
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ amount: 100
+ currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
- currency: USD
- amount: 100
- processor: DUMMY_V1
- Create an Authorization (with 3D Secure):
+ Authorization - 3D Secure:
value:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
3d_secure_authentication:
- electronic_commerce_indicator: AUTHENTICATED
cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
+ electronic_commerce_indicator: AUTHENTICATED
transaction_id: EaOMucALHQqLAEGAgk
+ amount: 100
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
- currency: USD
- amount: 100
- Create an Authorization (with Level 2 Processing):
+ Authorization - Level 2 Processing:
value:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- source: PIe2YvpcjvoVJ6PzoRPBK137
additional_purchase_data:
customer_reference_number: 321xyz
sales_tax: 200
- tags:
- order_number: 21DFASJSAKAS
- currency: USD
amount: 1000
- processor: DUMMY_V1
- Create an Authorization (with Level 3 Processing):
- value:
+ currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
+ tags:
+ order_number: 21DFASJSAKAS
+ Authorization - Level 3 Processing:
+ value:
additional_purchase_data:
+ customer_reference_number: 321xyz
+ customs_duty_amount: 10
+ discount_amount: 100
item_data:
- - amount_including_sales_tax: 500
- unit_of_measure: BX
- merchant_product_code: '1149611'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 175-62-20
- item_discount_amount: 100
+ cost_per_unit: 500
item_description: printing paper
+ item_discount_amount: 100
+ merchant_product_code: '1149611'
quantity: 1
- - amount_including_sales_tax: 500
- unit_of_measure: CTN
- merchant_product_code: '2149612'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ unit_of_measure: BX
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 207-72-54
- item_discount_amount: 0
+ cost_per_unit: 500
item_description: printing ink
+ item_discount_amount: 0
+ merchant_product_code: '2149612'
quantity: 1
- discount_amount: 100
- customer_reference_number: 321xyz
+ unit_of_measure: CTN
shipping_amount: 100
- customs_duty_amount: 10
+ amount: 1000
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
- currency: USD
- amount: 1000
- processor: DUMMY_V1
- Create a Card Present Authorization with an EMV Card:
+ Card Present Authorization - EMV Card:
value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
- tags:
- order_number: test123transfer
- currency: USD
amount: 150
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_AUTHORIZATION
- Create a Card Present Authorization with a Non-EMV Card:
- value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
tags:
order_number: test123transfer
- currency: USD
+ Card Present Authorization - Non-EMV Card:
+ value:
amount: 150
- operation_key: CARD_PRESENT_AUTHORIZATION
- Create an Authorization with Buyer Charges:
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
+ operation_key: CARD_PRESENT_DEBIT
+ tags:
+ order_number: chris123transfer
+ Authorization - Buyer Charges:
value:
additional_buyer_charges:
rent_surcharge_amount: 150
@@ -3389,48 +4751,64 @@ components:
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
+ Authorization - HSA or FSA Card:
+ value:
+ amount: 950
+ currency: USD
+ hsa_fsa_payment: true
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ tags:
+ order_number: 21DFASJSAKAS
+ Authorization - Authorization with CVV:
+ value:
+ amount: 100
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ security_code: '022'
+ source: PI6QyMT6W6c62u5bY8Y17TBj
UpdateAuthorizationRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateAuthorizationRequest'
examples:
- Capture an Authorization:
+ Capture Authorization:
value:
- fee: 0
capture_amount: 100
- Capture an Authorization (with Level 2/3 Processing):
+ fee: 0
+ Capture Authorization - Level 2/3 Processing:
value:
additional_purchase_data:
item_data:
- - amount_including_sales_tax: 500
- unit_of_measure: BX
- merchant_product_code: '1149611'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 175-62-20
- item_discount_amount: 100
+ cost_per_unit: 500
item_description: printing paper
+ item_discount_amount: 100
+ merchant_product_code: '1149611'
quantity: 1
- - amount_including_sales_tax: 500
- unit_of_measure: CTN
- merchant_product_code: '2149612'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ unit_of_measure: BX
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 207-72-54
- item_discount_amount: 0
+ cost_per_unit: 500
item_description: printing ink
+ item_discount_amount: 0
+ merchant_product_code: '2149612'
quantity: 1
- discount_amount: 100
+ unit_of_measure: CTN
customer_reference_number: 321xyz
- shipping_amount: 100
customs_duty_amount: 10
- fee: 0
+ discount_amount: 100
+ shipping_amount: 100
capture_amount: 100
- Void an Authorization:
+ fee: 0
+ Void Authorization:
value:
void_me: true
- Capture a Card Present Authorization:
+ Capture Card Present Authorization:
value:
capture_amount: 150
CreateDisputeEvidenceRequest:
@@ -3439,12 +4817,12 @@ components:
schema:
$ref: '#/components/schemas/CreateDisputeEvidenceRequest'
examples:
- Upload dispute evidence:
+ Upload Dispute Evidence:
value:
file: '@path/to/local/file'
CreateFeeRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateFeeRequest'
examples:
@@ -3452,118 +4830,121 @@ components:
value:
amount: 1000
currency: USD
- fee_type: CUSTOM
fee_subtype: CUSTOM
- merchant_id: MUhQVWbSdd3Da68RKpfodqEV
+ fee_type: CUSTOM
label: April_Performance_Analytics_Fees
+ merchant_id: MUhQVWbSdd3Da68RKpfodqEV
settlement_delay_days: 3
CreateFeeProfileRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateFeeProfileRequest'
examples:
Create a Fee Profile:
value:
+ ach_basis_points: 300
ach_fixed_fee: 30
- tags:
- app pricing: sample
- basis_points: 200
application: APmuwPBaW8pVcwb4vCTHQH32
+ basis_points: 200
+ card_cross_border_basis_points: 300
+ card_cross_border_fixed_fee: 400
charge_interchange: false
fixed_fee: 100
- ach_basis_points: 300
+ tags:
+ app pricing: sample
UpdateFeeRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateFeeRequest'
examples: {}
CreateIdentityRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateIdentityRequest'
examples:
- Create an Identity (Merchant):
+ Identity - Merchant:
value:
additional_underwriting_data:
+ annual_ach_volume: 200000
+ average_ach_transfer_amount: 200000
+ average_card_transfer_amount: 200000
+ business_description: SB3 vegan cafe
+ card_volume_distribution:
+ card_present_percentage: 30
+ mail_order_telephone_order_percentage: 10
+ ecommerce_percentage: 60
+ credit_check_allowed: true
+ credit_check_ip_address: 42.1.1.113
+ credit_check_timestamp: '2021-04-28T16:42:55Z'
+ credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10
+ _14_6)
merchant_agreement_accepted: true
merchant_agreement_ip_address: 42.1.1.113
+ merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
+ merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac
+ OS X 10_14_6)
+ refund_policy: MERCHANDISE_EXCHANGE_ONLY
volume_distribution_by_business_type:
other_volume_percentage: 0
consumer_to_consumer_volume_percentage: 0
business_to_consumer_volume_percentage: 0
business_to_business_volume_percentage: 100
person_to_person_volume_percentage: 0
- average_ach_transfer_amount: 200000
- annual_ach_volume: 200000
- credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10
- _14_6)
- refund_policy: MERCHANDISE_EXCHANGE_ONLY
- credit_check_timestamp: '2021-04-28T16:42:55Z'
- credit_check_allowed: true
- merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
- business_description: SB3 vegan cafe
- average_card_transfer_amount: 200000
- credit_check_ip_address: 42.1.1.113
- merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac
- OS X 10_14_6)
- card_volume_distribution:
- card_present_percentage: 30
- mail_order_telephone_order_percentage: 10
- ecommerce_percentage: 60
- tags:
- Studio Rating: '4.7'
entity:
- last_name: Smith
- max_transaction_amount: 12000000
- has_accepted_credit_cards_previously: true
- default_statement_descriptor: Daphne's Corner
- personal_address:
+ annual_card_volume: 12000000
+ business_address:
city: San Mateo
country: USA
region: CA
- line2: Apartment 7
+ line2: Apartment 8
line1: 741 Douglass St
postal_code: '94114'
+ business_name: Finix Flowers
+ business_phone: +1 (408) 756-4497
+ business_tax_id: '123456789'
+ business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
+ default_statement_descriptor: Finix Flowers
+ dob:
+ year: 1978
+ day: 27
+ month: 6
+ doing_business_as: Finix Flowers
+ email: user@example.org
+ first_name: John
+ has_accepted_credit_cards_previously: true
incorporation_date:
year: 1978
day: 27
month: 6
- business_address:
+ last_name: Smith
+ max_transaction_amount: 1200000
+ ach_max_transaction_amount: 1000000
+ mcc: '4900'
+ ownership_type: PRIVATE
+ personal_address:
city: San Mateo
country: USA
region: CA
- line2: Apartment 8
+ line2: Apartment 7
line1: 741 Douglass St
postal_code: '94114'
- ownership_type: PRIVATE
- first_name: dwayne
- title: CEO
- business_tax_id: '123456789'
- doing_business_as: Petes Coffee
+ phone: '14158885080'
principal_percentage_ownership: 50
- email: user@example.org
- mcc: '0742'
- phone: '1234567890'
- business_name: Petes Coffee
tax_id: '123456789'
- business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
- business_phone: +1 (408) 756-4497
- dob:
- year: 1978
- day: 27
- month: 6
- url: www.PetesCoffee.com
- annual_card_volume: 12000000
- Create an Identity (Buyer):
+ title: CEO
+ url: https://www.finix.com
+ tags:
+ Studio Rating: '4.7'
+ Identity - Buyer:
value:
entity:
phone: '7145677613'
first_name: John
last_name: Smith
- email: user@example.org
+ email: finix_example@finix.com
personal_address:
city: San Mateo
country: USA
@@ -3571,12 +4952,12 @@ components:
line2: Apartment 7
line1: 741 Douglass St
postal_code: '94114'
- tags:
- key: value
+ tags:
+ key: value
description: ''
CreateIdentitySettlementRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSettlementRequest'
examples:
@@ -3588,7 +4969,7 @@ components:
Internal Daily Settlement ID: 21DFASJSAKAS
UpdateMerchantProfileRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateMerchantProfileRequest'
examples:
@@ -3597,304 +4978,360 @@ components:
fee_profile: FP4xXhxyFRiRePKBQXmueVTh
CreateMerchantUnderwritingRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateMerchantUnderwritingRequest'
examples:
- Create a Merchant:
+ Merchant:
value:
- tags:
- key_2: value_2
processor: DUMMY_V1
- Create a Merchant with Card Present Enabled:
- value:
tags:
key_2: value_2
+ Merchant - Card Present Enabled:
+ value:
gateway: TRIPOS_CLOUD_V1
processor: VANTIV_V1
+ tags:
+ key_2: value_2
CreatePaymentInstrumentRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreatePaymentInstrumentRequest'
descriminator:
propertyName: type
examples:
- Create a Payment Instrument (Card):
+ Payment Instrument - Card:
value:
- name: Amy White
- expiration_year: 2029
- tags:
- card_name: Business Card
- number: '5200828282828210'
- expiration_month: 12
address:
city: San Francisco
- region: CA
- postal_code: '94404'
- line1: 900 Metro Center Blv
country: USA
+ line1: 900 Metro Center Blv
+ postal_code: '94404'
+ region: CA
+ expiration_month: 12
+ expiration_year: 2029
+ identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ name: John Smith
+ number: '5200828282828210'
security_code: '022'
type: PAYMENT_CARD
- identity: IDgWxBhfGYLLdkhxx2ddYf9K
- Create a Payment Instrument (Bank Account):
+ Payment Instrument - Bank Account:
value:
+ account_number: '123123123'
account_type: SAVINGS
- name: Alice
- tags:
- Bank Account: Company Account
- country: USA
bank_code: '123123123'
- account_number: '123123123'
- type: BANK_ACCOUNT
identity: IDpYDM7J9n57q849o9E9yNrG
- Create a Payment Instrument (Token):
+ name: John Smith
+ type: BANK_ACCOUNT
+ Payment Instrument - Token:
value:
token: TKiMxe323RE5Dq3wLVtG8kSW
type: TOKEN
identity: IDpYDM7J9n57q849o9E9yNrG
- Create Apple Pay Web Payment Instrument:
+ Payment Instrument - Apple Pay:
value:
identity: IDgWxBhfGYLLdkhxx2ddYf9K
merchant_identity: IDpYDM7J9n57q849o9E9yNrG
name: John Smith
third_party_token: '{"token":{"paymentMethod":{"network":"barcode","type":"credit","displayName":""},"transactionIdentifier":"AE514ADAA44E9C3A0A862C7E4EDEE43C422556FA4748B045F1764860557E8EE6","paymentData":{"data":"IOg9H5\/hdpccvHZ03ESJwlJXFlmcnI18WXTSOHOPA82ewYoWVyEMiy63HCsdejXsHIR8a+N\/5aR24OeJrkxheck2AAl5o1LLJ7jL+75scnf7Z55uQmtVyKITTkH22LrC6E6SgMnXaefJYOTUcG1Veqb\/dXtpPzqaKACEKDkbVivpDk+A2iX5PLROFTMRgmb9a0HYwHOnVGQzXwiHkX1g6f1R4rILUyMaQ5qLxCplE1t\/guEYmkGBtOb\/v8+GRDTl8YrC1tOe\/cs4aQm4cAKJktFQUTbfAApNFBnKI06mtCM7e7qRna\/YON3gyci035jA7Zq4kBMo7rQB8puGH6dDqB\/KsPS6Ps+w688+rqEKz16YUJ\/LMCOzzBM6bCTOS6eouB1eCh3SJdm\/lmY=","signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID4zCCA4igAwIBAgIITDBBSVGdVDYwCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE5MDUxODAxMzI1N1oXDTI0MDUxNjAxMzI1N1owXzElMCMGA1UEAwwcZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtUFJPRDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhV37evWx7Ihj2jdcJChIY3HsL1vLCg9hGCV2Ur0pUEbg0IO2BHzQH6DMx8cVMP36zIg1rrV1O\/0komJPnwPE6OCAhEwggINMAwGA1UdEwEB\/wQCMAAwHwYDVR0jBBgwFoAUI\/JJxE+T5O8n5sT2KGw\/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFJRX22\/VdIGGiYl2L35XhQfnm1gkMA4GA1UdDwEB\/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0kAMEYCIQC+CVcf5x4ec1tV5a+stMcv60RfMBhSIsclEAK2Hr1vVQIhANGLNQpd1t1usXRgNbEess6Hz6Pmr2y9g4CJDcgs3apjMIIC7jCCAnWgAwIBAgIISW0vvzqY2pcwCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0NjMwWhcNMjkwNTA2MjM0NjMwWjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATwFxGEGddkhdUaXiWBB3bogKLv3nuuTeCN\/EuT4TNW1WZbNa4i0Jd2DSJOe7oI\/XYXzojLdrtmcL7I6CmE\/1RFo4H3MIH0MEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcwAYYqaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZXJvb3RjYWczMB0GA1UdDgQWBBQj8knET5Pk7yfmxPYobD+iu\/0uSzAPBgNVHRMBAf8EBTADAQH\/MB8GA1UdIwQYMBaAFLuw3qFYM4iapIqZ3r6966\/ayySrMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkiG92NkBgIOBAIFADAKBggqhkjOPQQDAgNnADBkAjA6z3KDURaZsYb7NcNWymK\/9Bft2Q91TaKOvvGcgV5Ct4n4mPebWZ+Y1UENj53pwv4CMDIt1UQhsKMFd2xd8zg7kGf9F3wsIW2WT8ZyaYISb1T4en0bmcubCYkhYQaZDwmSHQAAMYIBjDCCAYgCAQEwgYYwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTAghMMEFJUZ1UNjANBglghkgBZQMEAgEFAKCBlTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMjA0MDExODE2MjJaMCoGCSqGSIb3DQEJNDEdMBswDQYJYIZIAWUDBAIBBQChCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEINpyGxYyGbl1Kj57wU\/3PijxngHUcidFy9jukG9sccOHMAoGCCqGSM49BAMCBEcwRQIhAPHvbeAIDmJKf2YGS5xcCoySSeCeFf6ThUsKE3UIPWBJAiBQIZZu4wTlZn7R16N+2iTfvuvzJKgeSv8rAs3YM6z56AAAAAAAAA==","header":{"publicKeyHash":"eOvce9ya55opFC5EXVWlLwzZRVDEY3Hgakf3+C+0zkc=","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3VnkF5JR9cWuYoeT68dUNp\/2\/jGaOiid19UfCV9rEkcPomrzFWEZw\/dN1uU9RTblnrIQPajFj4R2ZKIpYIlkgA==","transactionId":"ae514adaa44e9c3a0a862c7e4edee43c422556fa4748b045f1764860557e8ee6"},"version":"EC_v1"}}}'
type: APPLE_PAY
+ Payment Instrument - Google Pay:
+ value:
+ identity: ID78Fh8mcnnzukVzbdoyex5y
+ merchant_identity: IDwhCCvPwCDEmiFd8Be7pDzN
+ name: Finix Sandbox
+ third_party_token: '{"signature":"MEYCIQCYTkaEMgug7pcjzEEdbIn+R57kYO5yYc2KYj41AQQn9wIhAN1QvylvZ2XydVecfejwi2xYS9y3Y9y/MmDnRnUfNw5H","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4xc3fjeM9SMTjd1TL2GQCPmgqPf2h42aM3akPh/mTUBqWEgOITruK10A02rQ+4YZOvLCpQKQZzLSAd09nctnuA\\u003d\\u003d\",\"keyExpiration\":\"1648843199734\"}","signatures":["MEQCICwCI4s5YCLu4qRCyXwSJ3qG8y3ocFtP1Mque4Uzysl8AiARoD/0qbj5W0Q2PWKpxkEnfcP+nU5kwYS8FyQ9boDTmQ\u003d\u003d"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"roD4ikTpZ7Srunq+0zUnp+eiXzcuZBfIFSuZAJu1PQLXcP0RvnGDiGKtoarNCHvn+cnXsHCzIBWXMZSJ9Aglqky9VfP5a+qsXQhf5m5AFUbT2xnihtKwageGQQK6HzyjHSXXSjvuCzeo75ToOgIUxLFASZyaZ89u3Jifqhhc2c4a0Mtlx564BxXiwcxDFdtNkOle7uAIsJzsryk7Rcwgr8ZMJJM//XpvaeE5wNmkVFHUtR2uTqPm0BvkoYkFHCTRo4NHXWpxeLjXWzKGk2ELyTK1diuCa6c9ig0jO3t8BIh1cR63UeP8Ar7u5fh8C9FPPAsgPbTGLfiaRe615e4SxASgcZ4/8uWo5mikEPFqA5s2K2mid9ncXoMNYaHUc3qzJAyxHVYSd5SRNZYXHMkEcWcjnpDx+ErYjR1sMo1LMYXfrfGyZz3M69bQLKPYFe7ChjvgFI9MnfcFTNB4HAdNKMhbZT0EKinfxxGWkT7LVbGnUuqPlHp4toCe4kpbx7fulwXTj3bAFvg/qvxxwGOS38iP0HR/f+4GF0xHspqYVbdWdIJ5iJUdpBG8Nu5P56h2GEDxXMkKSmh+qbvKWlYipNNGoeg8uHc\\u003d\",\"ephemeralPublicKey\":\"BMqIyb1IyXhuZ4YpWm1PiRr74i3tCwDfQqJ1P4OZ3zK4Rq16SuwgJ605fCEvlViwSQuo2Hpv+CcR+2D3+/YrLB8\\u003d\",\"tag\":\"5K4LlTucDK7jAThbIozYtyoxX95hRNd5cJJGfxWAxw8\\u003d\"}"}'
+ type: GOOGLE_PAY
description: ''
CreateProcessorRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateProcessorRequest'
examples:
'Enable an Application Processor ':
value:
- type: DUMMY_V1
config:
canDebitBankAccount: true
+ type: DUMMY_V1
UpdateProcessorRequest:
content:
- application/hal+json:
+ application/json:
schema:
type: object
CreateReversalRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateReversalRequest'
examples:
- Refund a Transfer:
+ Refund Transfer:
value:
refund_amount: 100
tags:
test: refund
- Refund a Transfer (Card Present):
+ Refund Transfer - Card Present:
value:
- refund_amount: 150
device: DVkBqa68V1ZQusodU8o6mB62
- Refund a Transfer (Swiped Card):
+ refund_amount: 150
+ Refund Transfer - Swiped Card:
value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
- tags:
- test: refund
- currency: USD
amount: 150
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_UNREFERENCED_REFUND
+ tags:
+ test: refund
+ Refund Transfer - Split Transaction:
+ value:
+ refund_amount: 1000
+ split_transfers:
+ - merchant: MU4jpoNGRkAyjBxumZhGa6Hc
+ amount: 600
+ tags:
+ key: value
+ - merchant: MUeHUEPKybMjqV1STcqrFTSH
+ amount: 300
+ - merchant: MU3Gh6DT5fCBxVtWB8VJc1St
+ amount: 100
+ tags:
+ test: refund
CreateSettlementRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSettlementRequest'
- examples:
- Create a Settlement:
- value:
- currency: USD
- processor: DUMMY_V1
- merchant_id: MUfBgBvvv355djUi4uXQKtit
- tags:
- Internal Daily Settlement ID: 21DFASJSAKAS
CreateTransferRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateTransferRequest'
examples:
- Create a Transfer:
+ Transfer:
value:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- currency: USD
amount: 662154
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
- Create a Transfer (Debit a Bank Account):
+ Transfer - Debit Bank Account:
value:
- fee: 603
+ amount: 6031
currency: USD
+ fee: 603
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIr1Ru7ewBkEYVVn7SP1u5FW
tags:
order_number: 21DFASJSAKAS
- source: PIk3AG7aUSCyNgYpDwCKkwDC
- amount: 6031
- Create a Transfer (with 3D Secure):
+ Transfer - 3D Secure:
value:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
3d_secure_authentication:
- electronic_commerce_indicator: AUTHENTICATED
cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
+ electronic_commerce_indicator: AUTHENTICATED
transaction_id: EaOMucALHQqLAEGAgk
+ amount: 92169
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
- currency: USD
- amount: 92169
- Create a Transfer (with Level 2 Processing):
+ Transfer - Level 2 Processing:
value:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- source: PIe2YvpcjvoVJ6PzoRPBK137
additional_purchase_data:
customer_reference_number: 321xyz
sales_tax: 200
- tags:
- test: sale
- currency: USD
amount: 1000
- Create a Transfer (with Level 3 Processing):
- value:
+ currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
+ tags:
+ test: sale
+ Transfer - Level 3 Processing:
+ value:
additional_purchase_data:
item_data:
- - amount_including_sales_tax: 500
- unit_of_measure: BX
- merchant_product_code: '1149611'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 175-62-20
- item_discount_amount: 100
+ cost_per_unit: 500
item_description: printing paper
+ item_discount_amount: 100
+ merchant_product_code: '1149611'
quantity: 1
- - amount_including_sales_tax: 500
- unit_of_measure: CTN
- merchant_product_code: '2149612'
- amount_excluding_sales_tax: 400
- cost_per_unit: 500
+ unit_of_measure: BX
+ - amount_excluding_sales_tax: 400
+ amount_including_sales_tax: 500
commodity_code: 207-72-54
- item_discount_amount: 0
+ cost_per_unit: 500
item_description: printing ink
+ item_discount_amount: 0
+ merchant_product_code: '2149612'
quantity: 1
- discount_amount: 100
+ unit_of_measure: CTN
customer_reference_number: 321xyz
- shipping_amount: 100
customs_duty_amount: 10
+ discount_amount: 100
+ shipping_amount: 100
+ amount: 1000
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
- currency: USD
- amount: 1000
- Create a Card Present Transfer with an EMV Card:
+ Card Present Transfer - EMV Card:
value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
- tags:
- order_number: test123transfer
- currency: USD
amount: 150
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_DEBIT
- Create a Card Present Transfer with a Non-EMV Card:
+ tags:
+ order_number: chris123transfer
+ Card Present Transfer - Non-EMV Card:
value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
- currency: USD
amount: 150
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_DEBIT
tags:
- order_number: test123transfer
- Create a Card Present Transfer via Manual Entry:
+ order_number: chris123transfer
+ Card Present Transfer - Manual Entry:
value:
- device: DVf2H8sh4LZZC52GTUrwCPPf
- tags:
- order_number: test123transfer
+ amount: 150
+ currency: USD
+ device: DVsEanpBtsAVvCHbNXkFaH6f
device_configuration:
prompt_manual_entry: true
- currency: USD
- amount: 150
operation_key: CARD_PRESENT_DEBIT
- Create a Transfer with Buyer Charges:
+ tags:
+ order_number: chris123transfer
+ Transfer - HSA or FSA Cards:
value:
- additional_buyer_charges:
- convenience_amount: 300
- amount: 10300
+ amount: 950
+ currency: USD
+ hsa_fsa_payment: true
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ tags:
+ order_number: 21DFASJSAKAS
+ Transfer - Card Verification Checks:
+ value:
+ amount: 662154
+ currency: USD
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ security_code: '022'
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ Transfer - Split Transaction:
+ value:
+ amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers:
+ - merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ amount: 600
+ tags:
+ key: value
+ - merchant: MUeHUEPKybMjqV1STcqrFTSH
+ amount: 300
+ - merchant: MU3Gh6DT5fCBxVtWB8VJc1St
+ amount: 100
tags:
test: sale
UpdateDeviceRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateDeviceRequest'
examples:
- Activate a Device:
+ Device - Activated (DATACAP_V1):
+ value:
+ action: ACTIVATE
+ Device - Activated (TRIPOS_CLOUD_V1):
value:
- activation_code: C887298
action: ACTIVATE
- Reboot a Device:
+ activation_code: '609732'
+ Reboot Device:
value:
action: REBOOT
- Set Idle Message on Device:
+ Device - Idle Message Set:
value:
- idle_message: Finix Flowers
action: CREATE_IDLE_MESSAGE
- Deactivate a Device:
+ idle_message: Finix Flowers
+ Device - Deactivated:
value:
action: DEACTIVATE
+ Device - Update Details:
+ value:
+ configuration:
+ allow_debit: true
+ bypass_device_on_capture: true
+ prompt_signature: NEVER
+ description: Flowers
+ name: Finix Flowers - triPOS
CreateUserRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
CreateVerificationRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateVerificationRequest'
examples:
- Create a Merchant Verification:
+ "Payment Instrument - Verify a Card\u2019s CVV":
value:
merchant: MUgWbPVvtKbzjKNNGKqdQYV7
- processor: DUMMY_V1
+ security_code: '123'
+ verify_payment_card: true
+ "Payment Instrument - Verify a Card\u2019s Address":
+ value:
+ address:
+ city: San Francisco
+ country: USA
+ line1: 900 Metro Center Blv
+ postal_code: '94404'
+ region: CA
+ merchant: MUgWbPVvtKbzjKNNGKqdQYV7
+ verify_payment_card: true
+ Payment Instrument - Verify Push-to-Card Eligibility:
+ value:
identity: ID2CGJmjqyYaQAu6qyuvGeWK
+ merchant: MUgWbPVvtKbzjKNNGKqdQYV7
tags:
card_name: Business_Card
CreateWebhookRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateWebhookRequest'
examples:
- Create a Webhook with no Authentication:
+ Webhook:
value:
- url: https://example.com/event_handler
authentication:
type: NONE
- Create a Webhook with Basic authentication:
- value:
url: https://example.com/event_handler
+ Webhook - Basic Authentication:
+ value:
authentication:
type: BASIC
basic:
username: basic-auth-username
password: basic-auth-password
- Create a Webhook with Bearer Token Authentication:
- value:
url: https://example.com/event_handler
- enabled: true
+ Webhook - Bearer Token Authentication:
+ value:
authentication:
type: BEARER
bearer:
token: U3VwZXIgc2VjcmV0IGVuY29kZWQgdG9rZW4=
+ enabled: true
+ url: https://example.com/event_handler
UpdateTransferRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateTransferRequest'
examples:
@@ -3904,12 +5341,12 @@ components:
test: sale
UpdateSettlementRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateSettlementRequest'
CreateSubscriptionAmountRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionAmountRequest'
examples:
@@ -3917,15 +5354,15 @@ components:
value:
amount_type: FEE
fee_amount_data:
- currency: USD
amount: 2500
+ currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
tags:
order_number: '124'
UpdateSubscriptionAmountRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionAmountRequest'
examples:
@@ -3933,19 +5370,19 @@ components:
value:
amount_type: FEE
fee_amount_data:
- currency: USD
amount: 2500
+ currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
tags:
order_number: '124'
CreateSubscriptionScheduleRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionScheduleRequest'
examples:
- Create a Subscription Schedule (FIXED_TIME_INTERVAL):
+ Subscription Schedule - FIXED_TIME_INTERVAL:
value:
line_item_type: FEE
nickname: Fixed_Time_Subscription_Schedule
@@ -3953,7 +5390,7 @@ components:
interval_count: 4
hourly_interval: 24
subscription_type: FIXED_TIME_INTERVAL
- Create a Subscription Schedule (PERIODIC_MONTHLY):
+ Subscription Schedule - PERIODIC_MONTHLY:
value:
line_item_type: FEE
period_offset:
@@ -3961,7 +5398,7 @@ components:
month: null
nickname: Monthly_Subscription_Schedule
subscription_type: PERIODIC_MONTHLY
- Create a Subscription Schedule (PERIODIC_YEARLY):
+ Subscription Schedule - PERIODIC_YEARLY:
value:
line_item_type: FEE
period_offset:
@@ -3971,7 +5408,7 @@ components:
subscription_type: PERIODIC_YEARLY
UpdateSubscriptionScheduleRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionScheduleRequest'
examples:
@@ -3981,25 +5418,25 @@ components:
order-reference: A1B2C3D4E5
CreateSubscriptionEnrollmentRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionEnrollmentRequest'
examples:
Example of a "Security Fee":
value:
merchant: MUucec6fHeaWo3VHYoSkUySM
- started_at: '2022-11-11T16:50:59.891Z'
nickname: Security Fee
+ started_at: '2022-11-11T16:50:59.891Z'
tags:
enrollment_info: Security Fee Enrollment
UpdateSubscriptionEnrollmentRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionEnrollmentRequest'
UpdateUserRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
examples:
@@ -4009,97 +5446,120 @@ components:
card_name: New Employee
CreateDeviceRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateDevice'
examples:
Create a Device:
value:
- name: 'Finix triPOS #1'
- model: MX915
- description: John Smith
configuration:
allow_debit: true
+ bypass_device_on_capture: true
prompt_signature: NEVER
+ description: John Smith
+ model: MX915
+ name: 'Finix triPOS #1'
UpdatePaymentInstrumentRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdatePaymentInstrumentRequest'
examples:
- Update Tag:
+ Payment Instrument - Update a Card's Address:
+ value:
+ address:
+ city: Los Angeles
+ region: CA
+ postal_code: '90036'
+ line1: 270 Lincoln Center Blv
+ line2: Suite 1A
+ country: USA
+ merchant: MUjJUJxMKoL24H8MotYNjtZP
+ verify_payment_card: true
+ Payment Instrument - Disable a Payment Instrument:
+ value:
+ enabled: false
+ tags:
+ card_name: Personal Card
+ Payment Instrument - Bank Account Validation Check:
+ value:
+ attempt_bank_account_validation_check: 'true'
+ Payment Instrument - Update Payment Instrument Tags:
value:
tags:
- custom_key: custome value
+ card_name: Personal Card
UpdateMerchantRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateMerchantRequest'
examples:
- Update Merchant to Enable Level 2/3 Processing:
+ Merchant - Level 2/3 Processing:
value:
level_two_level_three_data_enabled: true
- Update Merchant to Enable Buyer Charges:
+ Merchant - Buyer Charges:
value:
convenience_charges_enabled: true
rent_surcharges_enabled: true
+ Merchant - Disable a Merchant:
+ value:
+ processing_enabled: false
UpdateIdentityRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateIdentityRequest'
examples:
Update an Identity:
value:
entity:
- last_name: Smith
- first_name: John
email: user@example.org
+ first_name: John
+ last_name: Smith
phone: '7145677613'
CreateAssociatedIdentityRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateAssociatedIdentityRequest'
examples:
Create an Associated Identity:
value:
entity:
- first_name: John
- last_name: Smith
- title: Founder
dob:
- month: 1
day: 1
+ month: 1
year: 2013
- principal_percentage_ownership: 25
- phone: '1234567890'
+ email: john.smith@company1.com
+ first_name: John
+ last_name: Smith
personal_address:
city: San Francisco
- region: CA
- postal_code: '90650'
- line1: 123 Main Street
country: USA
- email: john.smith@company1.com
+ line1: 123 Main Street
+ postal_code: '90650'
+ region: CA
+ phone: '14158885080'
+ principal_percentage_ownership: 25
tax_id: '123456789'
+ title: Founder
CreateBalanceTransferRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateBalanceTransferRequest'
examples:
Create a Balance Transfer:
value:
+ amount: 4000
+ currency: USD
description: Need to increase buffer given the high number of NSFs
on merchant fee debits
- tags:
- example: documentation tag
destination: FOR_BENEFIT_OF_ACCOUNT
- currency: USD
- amount: 4000
- source: OPERATING_ACCOUNT
processor_type: LITLE_V1
+ source: OPERATING_ACCOUNT
+ tags:
+ example: documentation tag
CreateInstrumentUpdateRequest:
content:
multipart/form-data:
@@ -4113,7 +5573,7 @@ components:
description: ''
CreateFileRequest:
content:
- application/vnd.api+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateFileRequest'
examples:
@@ -4126,17 +5586,17 @@ components:
type: DRIVERS_LICENSE_FRONT
CreateExternalLinkRequest:
content:
- application/vnd.api+json:
+ application/json:
schema:
$ref: '#/components/schemas/CreateExternalLinkRequest'
examples:
Create an External Link:
value:
- type: UPLOAD
duration: 15
+ type: UPLOAD
CreateApplePaySessionRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ApplePaySessionRequest'
examples:
@@ -4148,7 +5608,7 @@ components:
validation_url: https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession
RemoveSettlementTransfer:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/RemoveSettlementTransfer'
examples:
@@ -4163,14 +5623,24 @@ components:
$ref: '#/components/schemas/UploadFileRequest'
UpdateWebhookRequest:
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UpdateWebhookRequest'
examples:
- Update a Webhook:
+ Update Webhook:
value:
- url: https://eohzjuj2prziycz.m.pipedream.net
enabled: true
+ url: https://eohzjuj2prziycz.m.pipedream.net
+ Filter Webhook Events:
+ value:
+ enabled_events:
+ - entity: merchant
+ types:
+ - created
+ - underwritten
+ - entity: transfer
+ types:
+ - created
UpdateComplianceForm:
content:
application/json:
@@ -4180,11 +5650,11 @@ components:
Complete Compliance Form:
value:
pci_saq_a:
- name: John Booker
- signed_at: '2022-03-18T16:42:55Z'
- user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
ip_address: 42.1.1.113
+ name: John Smith
+ signed_at: '2022-03-18T16:42:55Z'
title: CTO
+ user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
CreateOnboardingFormRequest:
content:
application/json:
@@ -4194,19 +5664,95 @@ components:
Create an Onboarding Form:
value:
onboarding_data:
- entity: {}
- associated_entities: []
- additional_underwriting_data: {}
- payment_instruments: {}
+ entity:
+ title: CEO
+ first_name: John
+ last_name: Smith
+ email: john.smith@finix.com
+ business_name: Finix Flowers
+ business_type: CORPORATION
+ doing_business_as: Finix Flowers
+ phone: '14158885080'
+ business_phone: '14158885080'
+ personal_address:
+ city: Seattle
+ country: USA
+ line1: 123 Boren Ave
+ postal_code: '98040'
+ region: WA
+ business_address:
+ city: Bellevue
+ country: USA
+ line1: 123 Bellevue Way
+ postal_code: '98039'
+ region: WA
+ dob:
+ day: 13
+ month: 4
+ year: 1982
+ incorporation_date:
+ day: 9
+ month: 3
+ year: 2018
+ mcc: '4900'
+ url: https://www.finix.com
+ ownership_type: PRIVATE
+ default_statement_descriptor: DEMOCOMPANY
+ max_transaction_amount: 100000
+ annual_card_volume: 1000000
+ principal_percentage_ownership: 75
+ tax_id: '123456789'
+ business_tax_id: '123456789'
+ has_accepted_credit_cards_previously: false
+ additional_underwriting_data:
+ refund_policy: NO_REFUNDS
+ card_volume_distribution:
+ ecommerce_percentage: 100
+ card_present_percentage: 0
+ mail_order_telephone_order_percentage: 0
+ average_ach_transfer_amount: 200000
+ average_card_transfer_amount: 20000
+ annual_ach_volume: 2000000
+ business_description: CONSUMER
+ volume_distribution_by_business_type:
+ other_volume_percentage: 0
+ person_to_person_volume_percentage: 0
+ business_to_business_volume_percentage: 90
+ business_to_consumer_volume_percentage: 10
+ consumer_to_consumer_volume_percentage: 0
+ associated_entities:
+ - title: CFO
+ first_name: Alex
+ last_name: Smith
+ email: alex.smith@finix.com
+ phone: '14158885080'
+ personal_address:
+ city: Bellevue
+ country: USA
+ line1: 4848 84th St
+ postal_code: '98032'
+ region: WA
+ dob:
+ day: 13
+ month: 4
+ year: 1985
+ principal_percentage_ownership: 25
+ tax_id: '123456789'
+ payment_instruments:
+ name: SARAH BANKER
+ bank_code: '123456789'
+ account_number: '123456789'
+ account_type: CHECKING
+ type: BANK_ACCOUNT
max_transaction_amount: 100000
merchant_processors:
- processor: LITLE_V1
onboarding_link_details:
- return_url: https://www.finix.com/docs
- expired_session_url: https://www.finix.com/
- terms_of_service_url: https://www.finix.com/terms-and-policies
- fee_details_url: https://www.finix.com/docs
- expiration_in_minutes: '30'
+ return_url: https://www.finixflowers.com/
+ expired_session_url: https://www.finixflowers.com/login
+ terms_of_service_url: https://www.finixflowers.com/ToS
+ fee_details_url: https://www.finixflowers.com/fee_details
+ expiration_in_minutes: 10080
CreateOnboardingFormLinkRequest:
content:
application/json:
@@ -4215,37 +5761,117 @@ components:
examples:
Create an Onboarding Form Link:
value:
- terms_of_service_url: https://www.finix.com/terms-and-policies
- return_url: https://www.finix.com/docs
- fee_details_url: https://www.finix.com/docs
+ expiration_in_minutes: 10080
expired_session_url: https://www.finix.com/
- expiration_in_minutes: 30
+ fee_details_url: https://www.finix.com/docs
+ return_url: https://www.finix.com/docs
+ terms_of_service_url: https://www.finix.com/terms-and-policies
+ UpdatePayoutProfileRequest:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdatePayoutProfileRequest'
+ examples:
+ Payout Profile - Gross:
+ value:
+ type: GROSS
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: '1'
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ fees:
+ frequency: MONTHLY
+ day_of_month: '1'
+ submission_delay_days: '3'
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ Payout Profile - Net:
+ value:
+ type: NET
+ net:
+ frequency: CONTINUOUS
+ submission_delay_days: '1'
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ VoidAuthorizationRequest:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VoidAuthorization'
+ examples:
+ Void Authorization:
+ value:
+ void_me: true
+ SubmitDisputeEvidence:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SubmitDisputeEvidence'
+ examples:
+ Example 1:
+ value:
+ note: '"Submitting Dispute Evidence: July 23rd Receipt"'
+ UpdateDisputeEvidence:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateDisputeEvidence'
+ examples:
+ Dispute - Tags:
+ value:
+ tags:
+ order_number: 41BFASJSAKAS
+ AcceptDisputeRequest:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AcceptDispute'
+ examples:
+ Dispute Accepted:
+ value:
+ note: 'Accepting Dispute: Valid Reason'
+ CloseSettlement:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloseSettlement'
+ examples:
+ Close Settlement:
+ value:
+ action: STOP_ACCRUAL
+ CreateSplitTransferRequest:
+ content:
+ application/json:
+ schema:
+ type: object
responses:
Application:
description: Single application object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Application'
examples:
Application Created:
value:
id: APgPDQrLD52TYvqazjHJJchM
+ created_at: '2022-01-27T07:36:33.59Z'
+ updated_at: '2022-01-27T07:44:04.94Z'
+ card_cvv_required: false
+ card_expiration_date_required: true
+ creating_transfer_from_report_enabled: true
enabled: true
- tags:
- application_name: Finix Flowers
+ fee_ready_to_settle_upon: RECONCILIATION
+ name: BrainTree
owner: IDuquemzE7UkUJioGJfVKBKt
- name: Finix Flowers
processing_enabled: true
+ ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
- card_cvv_required: false
settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
- fee_ready_to_settle_upon: RECONCILIATION
- created_at: '2022-01-27T07:36:33.59Z'
- updated_at: '2022-01-27T07:44:04.94Z'
+ tags:
+ application_name: BrainTree
_links:
self:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -4287,26 +5913,28 @@ components:
ApplicationProfile:
description: Single application_profile object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ApplicationProfile'
examples:
Application Profile:
value:
- id: PP6Gu3JTdcS5CVuTsY8eCoU7
+ id: PPqjTEKAmRNGLquQUeLKmXhi
+ created_at: '2022-01-27T07:36:33.65Z'
+ updated_at: '2022-01-27T07:37:38.07Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ fee_profile: FPvCQUcnsueN3Bc3zR1qCBG8
+ risk_profile: RPvF6X3AcLnvMby9wBkaVoBi
tags: {}
- application: APkhCuFhbgVgNKKExUf8rpdV
- fee_profile: null
- risk_profile: RPk3988fTnZS6nEyU1WtNgyd
- created_at: '2022-07-28T21:52:54.54Z'
- updated_at: '2022-07-28T21:52:54.54Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/application_profiles/PP6Gu3JTdcS5CVuTsY8eCoU7
+ href: https://finix.sandbox-payments-api.com/application_profiles/PPqjTEKAmRNGLquQUeLKmXhi
application:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPk3988fTnZS6nEyU1WtNgyd
+ href: https://finix.sandbox-payments-api.com/risk_profiles/RPvF6X3AcLnvMby9wBkaVoBi
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -4317,7 +5945,7 @@ components:
ApplicationProfilesList:
description: List of application_profile objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ApplicationProfilesList'
examples:
@@ -4325,40 +5953,29 @@ components:
value:
_embedded:
application_profiles:
- - id: PPrVzFBWaCL3TeEWHq1tv4Ay
- tags: {}
- application: APtjNWUxQKj4Gkw1L4rQ1yNB
- fee_profile: null
- risk_profile: RPaPp5SBdiR6TpiS6sZUKxwd
- created_at: '2022-05-31T16:18:44.56Z'
- updated_at: '2022-05-31T16:18:44.56Z'
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/application_profiles/PPrVzFBWaCL3TeEWHq1tv4Ay
- application:
- href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB
- risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPaPp5SBdiR6TpiS6sZUKxwd
- - id: PPc931nKUintrvYY98itsM9M
+ - id: PPqjTEKAmRNGLquQUeLKmXhi
+ created_at: '2022-01-27T07:36:33.65Z'
+ updated_at: '2022-01-27T07:37:38.07Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ fee_profile: FPvCQUcnsueN3Bc3zR1qCBG8
+ risk_profile: RPvF6X3AcLnvMby9wBkaVoBi
tags: {}
- application: APoUsWg49wfXomJTGnvuKZeT
- fee_profile: null
- risk_profile: RPjEJsR9nVbHPzPvGU8vg8g9
- created_at: '2022-03-24T16:25:56.28Z'
- updated_at: '2022-03-24T16:25:56.28Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/application_profiles/PPc931nKUintrvYY98itsM9M
+ href: https://finix.sandbox-payments-api.com/application_profiles/PPqjTEKAmRNGLquQUeLKmXhi
application:
- href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPjEJsR9nVbHPzPvGU8vg8g9
+ href: https://finix.sandbox-payments-api.com/risk_profiles/RPvF6X3AcLnvMby9wBkaVoBi
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
_links:
self:
href: https://finix.sandbox-payments-api.com/application_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
- next_cursor: PPc931nKUintrvYY98itsM9M
+ offset: 0
limit: 20
+ count: 1
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -4369,7 +5986,7 @@ components:
ApplicationsList:
description: List of `Applications`.
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ApplicationsList'
examples:
@@ -4377,99 +5994,99 @@ components:
value:
_embedded:
applications:
- - id: APkhCuFhbgVgNKKExUf8rpdV
+ - id: APdoThHn4jjYUSxQf76txAgg
+ created_at: '2022-09-20T23:03:21.74Z'
+ updated_at: '2022-09-20T23:03:21.74Z'
+ card_cvv_required: false
+ card_expiration_date_required: true
+ creating_transfer_from_report_enabled: false
enabled: true
- tags:
- name: application
- owner: IDthvyMNJ4tK2A8K35rdX1kx
- name: business inc
+ fee_ready_to_settle_upon: RECONCILIATION
+ name: Abhishek Test
+ owner: IDpxUfpKm1UCqtx5N4SkqVr5
processing_enabled: true
+ ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
- creating_transfer_from_report_enabled: false
- card_expiration_date_required: true
- card_cvv_required: false
settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
- fee_ready_to_settle_upon: RECONCILIATION
- created_at: '2022-07-28T21:52:54.47Z'
- updated_at: '2022-07-28T21:52:54.47Z'
+ tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg
processors:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/processors
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/processors
users:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/users
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/users
owner_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDthvyMNJ4tK2A8K35rdX1kx
+ href: https://finix.sandbox-payments-api.com/identities/IDpxUfpKm1UCqtx5N4SkqVr5
transfers:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/transfers
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/transfers
disputes:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/disputes
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/disputes
authorizations:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/authorizations
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/authorizations
settlements:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/settlements
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/settlements
merchants:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/merchants
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/merchants
identities:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/identities
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/identities
webhooks:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/webhooks
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/webhooks
reversals:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/reversals
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/reversals
tokens:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/tokens
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/tokens
payment_instruments:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/payment_instruments
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/payment_instruments
application_profile:
- href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/application_profile
- - id: APeT9uYCjww9UuKQB2mgi21A
+ href: https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/application_profile
+ - id: APrpAfFbr9TqMw1FXLAD6vNg
+ created_at: '2022-04-29T00:48:15.01Z'
+ updated_at: '2022-04-29T00:48:16.56Z'
+ card_cvv_required: false
+ card_expiration_date_required: true
+ creating_transfer_from_report_enabled: false
enabled: true
- tags: {}
- owner: IDcfZEYCYQG42RDZR2nqUVNm
- name: Chris application
+ fee_ready_to_settle_upon: RECONCILIATION
+ name: BrainTree
+ owner: IDfEzc4SsQkk1FN516DDQWuj
processing_enabled: true
+ ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
- creating_transfer_from_report_enabled: false
- card_expiration_date_required: true
- card_cvv_required: false
settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
- fee_ready_to_settle_upon: RECONCILIATION
- created_at: '2022-04-22T20:32:33.47Z'
- updated_at: '2022-04-22T20:32:33.47Z'
+ tags:
+ application_name: BrainTree
_links:
self:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg
processors:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/processors
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/processors
users:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/users
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/users
owner_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDcfZEYCYQG42RDZR2nqUVNm
+ href: https://finix.sandbox-payments-api.com/identities/IDfEzc4SsQkk1FN516DDQWuj
transfers:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/transfers
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/transfers
disputes:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/disputes
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/disputes
authorizations:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/authorizations
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/authorizations
settlements:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/settlements
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/settlements
merchants:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/merchants
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/merchants
identities:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/identities
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/identities
webhooks:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/webhooks
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/webhooks
reversals:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/reversals
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/reversals
tokens:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/tokens
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/tokens
payment_instruments:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/payment_instruments
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/payment_instruments
application_profile:
- href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/application_profile
+ href: https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/application_profile
_links:
self:
href: https://finix.sandbox-payments-api.com/applications?offset=0&limit=20&sort=created_at,desc&sort=id,desc
@@ -4480,7 +6097,7 @@ components:
page:
offset: 0
limit: 20
- count: 2
+ count: 110412
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -4491,295 +6108,419 @@ components:
Authorization:
description: Single Authorization object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Authorization'
examples:
Authorization:
value:
- id: AUcaGi9WKyKn2GwX3bNSpsXo
- application: AP3AB2itAWrrrPVS6spvrGYp
- amount: 100
- tags: {}
- state: SUCCEEDED
- currency: USD
- transfer: null
- messages: []
- raw:
- additional_large_number: 9223372036854776000
- value: 100
- order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
- created_at: '2022-08-01T22:15:30.41Z'
- updated_at: '2022-08-01T22:15:30.51Z'
- trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
- source: PIbDnouV59En1yKfYUNLTpG9
- merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
+ id: AUvZbBaTJkFCbiAMrGtc66ko
+ created_at: '2022-10-11T02:27:39.10Z'
+ updated_at: '2022-10-11T02:27:39.48Z'
3ds_redirect_url: null
- is_void: false
- void_state: UNATTEMPTED
- expires_at: '2022-08-08T22:15:30.41Z'
- idempotency_id: null
additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 100
+ amount_requested: 100
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ expires_at: '2022-10-18T02:27:39.10Z'
failure_code: null
failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ security_code_verification: MATCHED
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: e1a10287-4909-4aa7-9cb7-abd069a3b833
+ transfer: null
+ void_state: UNATTEMPTED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo
+ href: https://finix.sandbox-payments-api.com/authorizations/AUvZbBaTJkFCbiAMrGtc66ko
application:
- href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
- Authorization (with 3D Secure):
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ Authorization - 3D Secure:
value:
- id: AU27TBqkcCQn94aSVyTvRyrn
- application: APgPDQrLD52TYvqazjHJJchM
+ id: AUtmuV1dapVdEe16ivUEUhSE
+ created_at: '2022-10-11T02:28:28.50Z'
+ updated_at: '2022-10-11T02:28:28.66Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
+ amount_requested: 100
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: TRsBcF8LjV1UaK5vXY6pFHmG
+ expires_at: '2022-10-18T02:28:28.50Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:19.95Z'
- updated_at: '2022-01-27T07:37:20.03Z'
- trace_id: ce97465f-b620-4d98-adba-378756d7013a
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 20374045-2f90-48f4-80e0-7edf32b9e626
+ transfer: null
void_state: UNATTEMPTED
- expires_at: '2022-02-03T07:37:19.95Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AU27TBqkcCQn94aSVyTvRyrn
+ href: https://finix.sandbox-payments-api.com/authorizations/AUtmuV1dapVdEe16ivUEUhSE
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
- Authorization (with Level 2 Processing):
+ Authorization - Level 2 Processing:
value:
- id: AUq2Xz5VS46U4hzzhX9WJCxx
- application: APgPDQrLD52TYvqazjHJJchM
+ id: AUpkH5f8YoLe2DBNKgqCua4N
+ created_at: '2022-10-11T02:28:59.99Z'
+ updated_at: '2022-10-11T02:29:00.47Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 1000
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
+ amount_requested: 1000
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: null
+ expires_at: '2022-10-18T02:28:59.99Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:20.68Z'
- updated_at: '2022-01-27T07:37:20.86Z'
- trace_id: 2b181625-616a-45b1-a8e7-311d76fddd5e
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 595ef280-35b9-4566-8884-7333739245f9
+ transfer: null
void_state: UNATTEMPTED
- expires_at: '2022-02-03T07:37:20.68Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUq2Xz5VS46U4hzzhX9WJCxx
+ href: https://finix.sandbox-payments-api.com/authorizations/AUpkH5f8YoLe2DBNKgqCua4N
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
- Authorization (with Level 3 Processing):
+ Authorization - Level 3 Processing:
value:
- id: AUsQsCLRp9ENxrh563w1zZHi
- application: APgPDQrLD52TYvqazjHJJchM
+ id: AUeNCQ37HbQgVQtToJiUtxpd
+ created_at: '2022-10-11T02:29:36.07Z'
+ updated_at: '2022-10-11T02:29:36.24Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 1000
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
+ amount_requested: 1000
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: null
+ expires_at: '2022-10-18T02:29:36.07Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:21.55Z'
- updated_at: '2022-01-27T07:37:21.68Z'
- trace_id: 88136ea9-9393-4b95-b4c0-940b49ab707d
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 3ce1a866-6a38-4a3b-b993-6ac9529afa53
+ transfer: null
void_state: UNATTEMPTED
- expires_at: '2022-02-03T07:37:21.55Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUsQsCLRp9ENxrh563w1zZHi
+ href: https://finix.sandbox-payments-api.com/authorizations/AUeNCQ37HbQgVQtToJiUtxpd
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
Voided Authorization:
value:
- id: AU2UkcVZU94rNqonfcLGZRSJ
- application: APgPDQrLD52TYvqazjHJJchM
+ id: AUeYYckKJTrBVu1j8FYLzJ3W
+ created_at: '2022-10-07T18:25:23.30Z'
+ updated_at: '2022-10-07T18:29:59.38Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
+ amount_requested: 100
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: null
+ expires_at: '2022-10-14T18:25:23.30Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: true
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:28.10Z'
- updated_at: '2022-01-27T07:37:29.15Z'
- trace_id: 710b6745-c424-4101-84e5-4a49cf317dc7
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDpYDM7J9n57q849o9E9yNrG
- 3ds_redirect_url: null
- is_void: true
- void_state: PENDING
- expires_at: '2022-02-03T07:37:28.10Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 560e44af-5d22-4af2-801e-03d2dad69dc7
+ transfer: null
+ void_state: SUCCEEDED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AU2UkcVZU94rNqonfcLGZRSJ
+ href: https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
- Card Present Authorization with an EMV Card:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ Card Present Authorization - EMV Card:
value:
- id: AUeEok8811pDqsR1BbxZLbw1
+ id: AUarp7Pz21Low4u2Urw5Ub4W
+ created_at: '2019-04-29T20:44:00.13Z'
+ updated_at: '2022-10-10T05:59:17.59Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 3138
+ amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
- amount: 150
- tags:
- order_number: test123transfer
- state: SUCCEEDED
- currency: USD
- transfer: null
- messages: []
- raw: null
card_present_details:
emv_data:
- application_identifier: A0000000031010
- application_label: Visa Credit
+ application_identifier: A0000001523010
+ application_label: DISCOVER
application_preferred_name: null
- application_transaction_counter: '004F'
- cryptogram: TC F8C706E8A0368D15
+ application_transaction_counter: '0005'
+ cryptogram: ARCQ F666F8891F870D33
issuer_code_table_index: null
pin_verified: false
- tags: {}
- masked_account_number: '************7564'
- name: 'AARON/CHRISTOPHER W '
- brand: VISA
+ tags: null
+ masked_account_number: '************0059'
+ name: Test Card 05
+ brand: DISCOVER
entry_mode: CHIP_ENTRY
payment_type: CREDIT
- approval_code: '000036'
- created_at: '2019-03-11T23:36:42.03Z'
- updated_at: '2019-03-11T23:36:57.09Z'
- trace_id: FNXmEM7d6ns8LMMzt61AD8TrR
- source: PIcW77CfRyBUWJhA231TWXWf
- merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
- 3ds_redirect_url: null
- is_void: false
- void_state: UNATTEMPTED
- expires_at: '2019-03-18T23:36:42.03Z'
- idempotency_id: null
- additional_buyer_charges: null
+ approval_code: '004839'
+ currency: USD
+ device: DVfKLD9GZtsjcJxLtc2yCcfd
+ expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
- sub_type: API
+ idempotency_id: null
+ is_void: false
+ merchant: MU4LYrniAvqVKUBqcATb7Y7p
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
+ messages: []
+ raw: null
+ security_code_verification: null
+ source: PImTHaz7XVPx4M7mhu9x8gkU
+ state: SUCCEEDED
+ tags:
+ TicketNumber: '45878'
+ trace_id: FNX35FSuraeKKJr65wkGVFJni
+ transfer: TRqQCAX7nYHUnkE5YPFTknqd
+ void_state: UNATTEMPTED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUeEok8811pDqsR1BbxZLbw1
+ href: https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
- Card Present Authorization with a Non-EMV Card:
+ Card Present Authorization - Non-EMV Card:
value:
- id: AUiJS1VhMy8zpACLoacPFG7m
+ id: AUarp7Pz21Low4u2Urw5Ub4W
+ created_at: '2019-04-29T20:44:00.13Z'
+ updated_at: '2022-10-10T05:59:17.59Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 3138
+ amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
- amount: 150
- tags:
- order_number: test123transfer
- state: SUCCEEDED
- currency: USD
- transfer: null
- messages: []
- raw: null
card_present_details:
- emv_data: null
- masked_account_number: '************0011'
- name: TEST/WORLDPAY
- brand: UNKNOWN
- entry_mode: SWIPED
+ emv_data:
+ application_identifier: A0000001523010
+ application_label: DISCOVER
+ application_preferred_name: null
+ application_transaction_counter: '0005'
+ cryptogram: ARCQ F666F8891F870D33
+ issuer_code_table_index: null
+ pin_verified: false
+ tags: null
+ masked_account_number: '************0059'
+ name: Test Card 05
+ brand: DISCOVER
+ entry_mode: CHIP_ENTRY
payment_type: CREDIT
- approval_code: '000037'
- created_at: '2019-03-01T03:37:10.10Z'
- updated_at: '2019-03-01T03:37:23.63Z'
- trace_id: 556185b9-ceaa-490b-bae2-a662757b42e0
- source: PIaqFoGabsBTTowVr5z7jiLv
- merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
- is_void: false
- expires_at: '2019-03-08T03:37:10.10Z'
- idempotency_id: null
- additional_buyer_charges: null
+ approval_code: '004839'
+ currency: USD
+ device: DVfKLD9GZtsjcJxLtc2yCcfd
+ expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MU4LYrniAvqVKUBqcATb7Y7p
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
+ messages: []
+ raw: null
+ security_code_verification: null
+ source: PImTHaz7XVPx4M7mhu9x8gkU
+ state: SUCCEEDED
+ tags:
+ TicketNumber: '45878'
+ trace_id: FNX35FSuraeKKJr65wkGVFJni
+ transfer: TRqQCAX7nYHUnkE5YPFTknqd
+ void_state: UNATTEMPTED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUiJS1VhMy8zpACLoacPFG7m
+ href: https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
- Authorization with Buyer Charges:
+ Authorization - Buyer Charges:
value:
- id: AUnxmW39jBePKqYKwQamC3BR
+ id: AUmoNHYYU26opc8gEqAYEaGj
+ created_at: '2022-10-11T02:31:28.42Z'
+ updated_at: '2022-10-11T02:31:28.81Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges:
+ convenience_amount: 0
+ rent_surcharge_amount: 200
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 5000
+ amount_requested: 5000
application: APgPDQrLD52TYvqazjHJJchM
- amount: 5200
- tags:
- test: sale
- state: SUCCEEDED
currency: USD
- transfer: null
+ expires_at: '2022-10-18T02:31:28.42Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-08-01T19:04:00.29Z'
- updated_at: '2022-08-01T19:04:00.43Z'
- trace_id: dcb4b954-89b3-4c5e-9b3a-1b8e70e30556
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ state: SUCCEEDED
+ tags:
+ test: sale
+ trace_id: a885a132-bf11-48fd-9eed-10d29909c068
+ transfer: null
+ void_state: UNATTEMPTED
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/authorizations/AUmoNHYYU26opc8gEqAYEaGj
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ Authorization - HSA or FSA Card:
+ value:
+ id: AUo8BiLgvzZzT41KBB7C8GQo
+ created_at: '2022-10-10T06:32:17.04Z'
+ updated_at: '2022-10-10T06:32:17.30Z'
3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 950
+ amount_requested: 950
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ expires_at: '2022-10-17T06:32:17.04Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ security_code_verification: MATCHED
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: f702ed93-d38d-430d-8924-a09d946e037c
+ transfer: null
void_state: UNATTEMPTED
- expires_at: '2022-08-08T19:04:00.29Z'
- idempotency_id: null
- additional_buyer_charges:
- convenience_amount: 0
- rent_surcharge_amount: 200
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/authorizations/AUo8BiLgvzZzT41KBB7C8GQo
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ Authorization - Authorization with CVV:
+ value:
+ id: AUg5fBP1vDXcFtSdiL3e4vzp
+ created_at: '2022-10-11T02:32:54.64Z'
+ updated_at: '2022-10-11T02:32:55.05Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 100
+ amount_requested: 100
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ expires_at: '2022-10-18T02:32:54.64Z'
failure_code: null
failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ security_code_verification: MATCHED
+ source: PI6QyMT6W6c62u5bY8Y17TBj
+ state: SUCCEEDED
+ tags: {}
+ trace_id: 526f28d0-73eb-46d6-b78c-aad6ab891dba
+ transfer: null
+ void_state: UNATTEMPTED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUnxmW39jBePKqYKwQamC3BR
+ href: https://finix.sandbox-payments-api.com/authorizations/AUg5fBP1vDXcFtSdiL3e4vzp
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
@@ -4794,7 +6535,7 @@ components:
AuthorizationsList:
description: List of Authorization objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/AuthorizationsList'
examples:
@@ -4802,49 +6543,35 @@ components:
value:
_embedded:
authorizations:
- - id: AUcaGi9WKyKn2GwX3bNSpsXo
- application: AP3AB2itAWrrrPVS6spvrGYp
- amount: 100
- tags: {}
- state: SUCCEEDED
- currency: USD
- transfer: null
- messages: []
- raw:
- additional_large_number: 9223372036854776000
- value: 100
- order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
- created_at: '2022-08-01T22:15:30.41Z'
- updated_at: '2022-08-01T22:15:30.51Z'
- trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce
- source: PIbDnouV59En1yKfYUNLTpG9
- merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
+ - id: AUoCse3evsJWctBbh6hSEsZj
+ created_at: '2022-10-10T06:14:57.84Z'
+ updated_at: '2022-10-10T06:14:58.28Z'
3ds_redirect_url: null
- is_void: false
- void_state: UNATTEMPTED
- expires_at: '2022-08-08T22:15:30.41Z'
- idempotency_id: null
additional_buyer_charges: null
- failure_code: null
- failure_message: null
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo
- application:
- href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
- merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
- - id: AUfh49WdxqokwZMkxiDaAp9d
- application: APeUbTUjvYb1CdPXvNcwW1wP
+ additional_healthcare_data: null
+ address_verification: null
amount: 150
- tags:
- order_number: test123transfer
- state: FAILED
+ amount_requested: 150
+ application: APeUbTUjvYb1CdPXvNcwW1wP
+ card_present_details:
+ emv_data: null
+ masked_account_number: null
+ name: null
+ brand: null
+ entry_mode: null
+ payment_type: NONE
+ approval_code: null
currency: USD
- transfer: null
+ device: DVsEanpBtsAVvCHbNXkFaH6f
+ expires_at: '2022-10-17T06:14:57.84Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages:
- LaneID 1 does not exist.
- - 'Authorization AUfh49WdxqokwZMkxiDaAp9d could not be submitted.
+ - 'Authorization AUoCse3evsJWctBbh6hSEsZj could not be submitted.
Cause: LaneID 1 does not exist.'
- DECLINED
raw:
@@ -4859,7 +6586,7 @@ components:
sub_total_amount: 0
tip_amount: 0
total_amount: 0
- order_id: FNX7FBcyvYEAfuVczJdtR8VpV
+ order_id: FNXhDjLCPDzR33zk8jjTicZv2
lane_id: 1
_errors:
- developer_message: "ERROR:POST error\r\nEXCEPTION: LaneID\
@@ -4880,37 +6607,59 @@ components:
processor_response_code: Unknown
_type: authorizationResponse
_warnings: []
- card_present_details:
- emv_data: null
- masked_account_number: null
- name: null
- brand: null
- entry_mode: null
- payment_type: NONE
- approval_code: '000037'
- created_at: '2022-08-01T20:00:07.65Z'
- updated_at: '2022-08-01T20:00:08.07Z'
- trace_id: FNX7FBcyvYEAfuVczJdtR8VpV
- source: PI2tXhSnoqT6pwyvWLHBkun5
- merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
- 3ds_redirect_url: null
- is_void: false
+ security_code_verification: null
+ source: PIg2q5tVAPcHpUpbJBNe4Vus
+ state: FAILED
+ tags:
+ order_number: chris123transfer
+ trace_id: FNXhDjLCPDzR33zk8jjTicZv2
+ transfer: null
void_state: UNATTEMPTED
- expires_at: '2022-08-08T20:00:07.65Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUfh49WdxqokwZMkxiDaAp9d
+ href: https://finix.sandbox-payments-api.com/authorizations/AUoCse3evsJWctBbh6hSEsZj
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
+ - id: AUuRnfhaBm84RhHyonkHAUrt
+ created_at: '2022-08-01T22:14:13.31Z'
+ updated_at: '2022-08-01T22:14:13.44Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 100
+ amount_requested: 100
+ application: AP3AB2itAWrrrPVS6spvrGYp
+ currency: USD
+ expires_at: '2022-08-08T22:14:13.31Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
+ messages: []
+ raw:
+ additional_large_number: 9223372036854776000
+ value: 100
+ order_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
+ security_code_verification: MATCHED
+ source: PIbDnouV59En1yKfYUNLTpG9
+ state: SUCCEEDED
+ tags: {}
+ trace_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
+ transfer: null
+ void_state: UNATTEMPTED
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/authorizations/AUuRnfhaBm84RhHyonkHAUrt
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED
_links:
self:
href: https://finix.sandbox-payments-api.com/authorizations?offset=0&limit=20&sort=created_at,desc&sort=id,desc
@@ -4921,7 +6670,7 @@ components:
page:
offset: 0
limit: 20
- count: 2
+ count: 633397
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -4932,64 +6681,59 @@ components:
CreatePaymentInstrumentToken:
description: Token response object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentToken'
headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
date:
- required: true
- schema:
- type: string
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
Device:
description: Single Device object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Device'
examples:
Device:
value:
- id: DVf2H8sh4LZZC52GTUrwCPPf
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix Tripos #1'
- model: MX915
- description: John Smith
- serial_number: null
- idle_message: null
- enabled: false
- tags: {}
+ id: DVsEanpBtsAVvCHbNXkFaH6f
created_at: '2019-03-01T02:27:20.366Z'
updated_at: '2022-04-05T18:48:40.383Z'
configuration_details:
allow_debit: true
- check_for_duplicate_transactions: false
- prompt_amount_confirmation: true
- prompt_manual_entry: false
- prompt_signature: NEVER
- signature_threshold_amount: 0
- bypass_device_on_capture: null
+ check_for_duplicate_transactions: true
+ prompt_amount_confirmation: false
+ prompt_manual_entry: true
+ prompt_signature: AMOUNT
+ signature_threshold_amount: 10
+ bypass_device_on_capture: false
+ connection: OPEN
+ description: Mike Jones
+ enabled: false
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: Johnnys Juice Shop
+ serial_number: '343434343'
+ tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
merchant:
href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
transfers:
href: https://finix.sandbox-payments-api.com/transfers
authorizations:
href: https://finix.sandbox-payments-api.com/authorizations
- Device (Activated):
+ Device - Activated (DATACAP_V1):
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix Tripos #1'
- model: MX915
- description: John Smith
- serial_number: 262-410-025
- idle_message: null
- enabled: true
- tags: {}
- created_at: '2022-06-06T03:59:42.415893Z'
- updated_at: '2022-06-06T03:59:42.416446Z'
+ created_at: '2022-06-06T03:59:42.415Z'
+ updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
@@ -4998,6 +6742,15 @@ components:
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
+ connection: OPEN
+ description: John Smith
+ enabled: true
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: 'Finix triPOS #1'
+ serial_number: '111023985764'
+ tags: {}
_links:
self:
href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
@@ -5007,19 +6760,11 @@ components:
href: https://finix.sandbox-payments-api.com/transfers
authorizations:
href: https://finix.sandbox-payments-api.com/authorizations
- Device (Idle Message Set):
+ Device - Activated (TRIPOS_CLOUD_V1):
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix Tripos #1'
- model: MX915
- description: John Smith
- serial_number: 262-410-025
- idle_message: Daphne's Corner
- enabled: true
- tags: {}
- created_at: '2022-06-06T03:59:42.415893Z'
- updated_at: '2022-06-06T03:59:42.416446Z'
+ created_at: '2022-06-06T03:59:42.415Z'
+ updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
@@ -5028,6 +6773,15 @@ components:
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
+ connection: OPEN
+ description: John Smith
+ enabled: true
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: 'Finix triPOS #1'
+ serial_number: null
+ tags: {}
_links:
self:
href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
@@ -5037,20 +6791,42 @@ components:
href: https://finix.sandbox-payments-api.com/transfers
authorizations:
href: https://finix.sandbox-payments-api.com/authorizations
- Device (Connection Check):
+ Device - Idle Message Set:
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
+ created_at: '2022-06-06T03:59:42.415Z'
+ updated_at: '2022-06-06T03:59:42.420647Z'
+ configuration_details:
+ allow_debit: true
+ check_for_duplicate_transactions: true
+ prompt_amount_confirmation: true
+ prompt_manual_entry: false
+ prompt_signature: NEVER
+ signature_threshold_amount: 0
+ bypass_device_on_capture: false
+ connection: OPEN
+ description: John Smith
+ enabled: false
+ idle_message: Finix Flowers
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix Tripos #1'
model: MX915
- description: John Smith
- serial_number: 262-410-025
- idle_message: Daphne's Corner
- connection: Open
- enabled: true
+ name: 'Finix triPOS #1'
+ serial_number: null
tags: {}
- created_at: '2022-06-06T03:59:42.415893Z'
- updated_at: '2022-06-06T03:59:42.416446Z'
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
+ merchant:
+ href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
+ transfers:
+ href: https://finix.sandbox-payments-api.com/transfers
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/authorizations
+ Device - Connection Check:
+ value:
+ id: DV8EVnpCwHwB9Dk3xTysgt5d
+ created_at: '2022-06-06T03:59:42.415Z'
+ updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
@@ -5059,6 +6835,15 @@ components:
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
+ connection: OPEN
+ description: John Smith
+ enabled: false
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: 'Finix triPOS #1'
+ serial_number: null
+ tags: {}
_links:
self:
href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
@@ -5068,20 +6853,28 @@ components:
href: https://finix.sandbox-payments-api.com/transfers
authorizations:
href: https://finix.sandbox-payments-api.com/authorizations
- Device (Deactivated):
+ Device - Deactivated:
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix Tripos #1'
- model: MX915
+ created_at: '2022-06-06T03:59:42.415Z'
+ updated_at: '2022-06-06T03:59:42.420647Z'
+ configuration_details:
+ allow_debit: true
+ check_for_duplicate_transactions: true
+ prompt_amount_confirmation: true
+ prompt_manual_entry: false
+ prompt_signature: NEVER
+ signature_threshold_amount: 0
+ bypass_device_on_capture: false
+ connection: OPEN
description: John Smith
- serial_number: 262-410-025
- idle_message: Daphne's Corner
enabled: false
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: 'Finix triPOS #1'
+ serial_number: null
tags: {}
- created_at: '2022-06-06T03:59:42.415893Z'
- updated_at: '2022-06-06T03:59:42.416446Z'
- configuration_details: null
_links:
self:
href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d
@@ -5091,6 +6884,37 @@ components:
href: https://finix.sandbox-payments-api.com/transfers
authorizations:
href: https://finix.sandbox-payments-api.com/authorizations
+ Device - Update Details:
+ value:
+ id: DVsEanpBtsAVvCHbNXkFaH6f
+ created_at: '2019-03-01T02:27:20.366Z'
+ updated_at: '2022-04-05T18:48:40.383Z'
+ configuration_details:
+ allow_debit: true
+ check_for_duplicate_transactions: true
+ prompt_amount_confirmation: false
+ prompt_manual_entry: true
+ prompt_signature: NEVER
+ signature_threshold_amount: 10
+ bypass_device_on_capture: true
+ connection: OPEN
+ description: Flowers
+ enabled: false
+ idle_message: null
+ merchant: MUu56ZGx3Xb6U9gAqKfgNisd
+ model: MX915
+ name: Finix Flowers - triPOS
+ serial_number: '343434343'
+ tags: {}
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
+ merchant:
+ href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
+ transfers:
+ href: https://finix.sandbox-payments-api.com/transfers
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/authorizations
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -5101,29 +6925,164 @@ components:
Dispute:
description: Single Dispute object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Dispute'
examples:
Dispute:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
+ created_at: '2022-01-27T07:43:03.74Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
+ action: null
+ amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
+ dispute_details:
+ arn: '123'
+ evidence_submitted: CHARGEBACK
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ message: null
+ occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
+ respond_by: '2022-02-03T07:43:03.73Z'
+ response_state: ACCEPTED
+ state: WON
tags:
order_number: 21DFASJSAKAS
- amount: 888888
- state: PENDING
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
- reason: FRAUD
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
+ evidence:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
+ adjustment_transfers:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
+ Dispute - Inquiry:
+ value:
+ id: DIs7yQRkHDdMYhurzYz72SFk
+ created_at: '2022-01-27T07:43:03.74Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
+ action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute_details:
+ arn: '123'
+ evidence_submitted: INQUIRY
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
+ occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
+ respond_by: '2022-02-03T07:43:03.73Z'
+ response_state: NEEDS_RESPONSE
+ state: INQUIRY
+ tags:
+ order_number: 21DFASJSAKAS
+ transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
+ evidence:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
+ adjustment_transfers:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
+ Dispute - Chargeback:
+ value:
+ id: DIs7yQRkHDdMYhurzYz72SFk
+ created_at: '2022-01-27T07:43:03.74Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute_details:
+ arn: '123'
+ evidence_submitted: CHARGEBACK
identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ message: null
+ occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
+ respond_by: '2022-02-03T07:43:03.73Z'
+ response_state: RESPONDED
+ state: PENDING
+ tags:
+ order_number: 21DFASJSAKAS
+ transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
+ evidence:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
+ adjustment_transfers:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
+ Dispute - Accepted:
+ value:
+ id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
- updated_at: '2022-01-27T07:43:03.48Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
+ action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute_details:
+ arn: '123'
+ evidence_submitted: INQUIRY
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ message: null
occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
+ response_state: ACCEPTED
+ state: INQUIRY
+ tags:
+ order_number: 21DFASJSAKAS
+ transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
+ evidence:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
+ adjustment_transfers:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
+ Dispute - Tags:
+ value:
+ id: DIs7yQRkHDdMYhurzYz72SFk
+ created_at: '2022-01-27T07:43:03.74Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
+ action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
+ evidence_submitted: CHARGEBACK
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ message: null
+ occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
+ respond_by: '2022-02-03T07:43:03.73Z'
+ response_state: ACCEPTED
+ state: WON
+ tags:
+ order_number: 41BFASJSAKAS
+ transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
@@ -5145,21 +7104,39 @@ components:
DisputeEvidence:
description: Single Evidence object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/DisputeEvidence'
examples:
Dispute Evidence:
value:
id: DF58kdVTa5eMQUjcXH2F7DH4
+ created_at: '2022-08-15T21:37:04.41Z'
+ updated_at: '2022-08-15T21:45:00.74Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute: DIs7yQRkHDdMYhurzYz72SFk
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ state: SUCCEEDED
tags:
file-extension: .png
content-type: image/png
file-name: test_file.png
- dispute: DIs7yQRkHDdMYhurzYz72SFk
- state: SUCCEEDED
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4
+ Dispute - Tags:
+ value:
+ id: DF58kdVTa5eMQUjcXH2F7DH4
created_at: '2022-08-15T21:37:04.41Z'
updated_at: '2022-08-15T21:45:00.74Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute: DIs7yQRkHDdMYhurzYz72SFk
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ state: SUCCEEDED
+ tags:
+ order_number: 41BFASJSAKAS
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4
@@ -5173,7 +7150,7 @@ components:
DisputeEvidenceList:
description: List of Evidence objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/DisputeEvidenceList'
examples:
@@ -5181,53 +7158,43 @@ components:
value:
_embedded:
evidences:
- - id: DF47KJ5djC346QuLVaQSSw8H
+ - id: DFcVgoEuDeWn4eSvdZca8Hf
+ created_at: '2022-10-06T20:22:54.93Z'
+ updated_at: '2022-10-06T20:30:00.63Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute: DIs7yQRkHDdMYhurzYz72SFk
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ state: SUCCEEDED
tags:
file-extension: .png
content-type: image/png
file-name: test_file.png
- dispute: DIs7yQRkHDdMYhurzYz72SFk
- state: SUCCEEDED
- created_at: '2022-08-16T18:50:24.16Z'
- updated_at: '2022-08-16T19:00:01.10Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF47KJ5djC346QuLVaQSSw8H
- - id: DFoLbyCxETSX6ScfMgnrZGER
- tags:
- file-extension: .png
- content-type: image/png
- file-name: finix_file.png
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFcVgoEuDeWn4eSvdZca8Hf
+ - id: DFx3tddpTC568GjukRFGZpDp
+ created_at: '2022-09-14T17:36:33.84Z'
+ updated_at: '2022-09-14T17:45:00.51Z'
dispute: DIs7yQRkHDdMYhurzYz72SFk
state: SUCCEEDED
- created_at: '2022-08-15T20:23:04.01Z'
- updated_at: '2022-08-15T20:30:00.54Z'
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFoLbyCxETSX6ScfMgnrZGER
- - id: DFo3KoCCCAhN7iJNmdt4CAqm
tags:
file-extension: .png
content-type: image/png
- file-name: finix_file.png
- dispute: DIs7yQRkHDdMYhurzYz72SFk
- state: SUCCEEDED
- created_at: '2022-08-15T18:48:32.81Z'
- updated_at: '2022-08-15T19:00:00.64Z'
+ file-name: test_file.png
_links:
self:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFo3KoCCCAhN7iJNmdt4CAqm
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFx3tddpTC568GjukRFGZpDp
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=1040&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=1160&limit=20&sort=created_at,desc&sort=id,desc
page:
- offset: 0
- limit: 20
- count: 3
+ limit: 100
+ next_cursor: DFs7yQRkHDdMYhurzYz72SFk
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -5238,7 +7205,7 @@ components:
DisputesList:
description: List of Disputes
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/DisputesList'
examples:
@@ -5247,22 +7214,23 @@ components:
_embedded:
disputes:
- id: DIb72obRhTmPdMG1VxDKFLrb
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- test: sale
- amount: 888888
- state: PENDING
- transfer: TRkhvS4GfMKxaHyBBdkPSx6g
- reason: FRAUD
- message: null
- action: null
- identity: IDuqZpDw28f2KK6YuDk4jNLg
created_at: '2022-07-14T19:40:06.52Z'
updated_at: '2022-07-14T19:40:06.11Z'
- occurred_at: '2022-07-14T19:39:00.77Z'
- respond_by: '2022-07-21T19:40:06.51Z'
+ action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
+ merchant: MUucec6fHeaWo3VHYoSkUySM
+ message: null
+ occurred_at: '2022-07-14T19:39:00.77Z'
+ reason: FRAUD
+ respond_by: '2022-07-21T19:40:06.51Z'
+ state: PENDING
+ tags:
+ test: sale
+ transfer: TRkhvS4GfMKxaHyBBdkPSx6g
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb
@@ -5275,22 +7243,22 @@ components:
adjustment_transfers:
href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers
- id: DIuk8T4ayQdmxewz8EDLHe49
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- order_number: 21DFASJSAKAS
- amount: 888888
- state: PENDING
- transfer: TR27JnLR2pKDXjVVcGBKrjwU
- reason: FRAUD
- message: null
- action: null
- identity: IDpYDM7J9n57q849o9E9yNrG
created_at: '2022-06-15T16:14:03.95Z'
updated_at: '2022-06-15T16:14:03.64Z'
- occurred_at: '2022-06-15T16:13:04.09Z'
- respond_by: '2022-06-22T16:14:03.94Z'
+ action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ message: null
+ occurred_at: '2022-06-15T16:13:04.09Z'
+ reason: FRAUD
+ respond_by: '2022-06-22T16:14:03.94Z'
+ state: PENDING
+ tags:
+ order_number: 21DFASJSAKAS
+ transfer: TR27JnLR2pKDXjVVcGBKrjwU
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49
@@ -5303,22 +7271,22 @@ components:
adjustment_transfers:
href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers
- id: DIs7yQRkHDdMYhurzYz72SFk
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- order_number: 21DFASJSAKAS
- amount: 888888
- state: PENDING
- transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
- reason: FRAUD
- message: null
+ created_at: '2022-01-27T07:43:03.74Z'
+ updated_at: '2022-09-16T22:21:54.75Z'
action: null
+ amount: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ dispute_details:
+ arn: '123'
identity: IDpYDM7J9n57q849o9E9yNrG
- created_at: '2022-01-27T07:43:03.74Z'
- updated_at: '2022-01-27T07:43:03.48Z'
+ message: null
occurred_at: '2022-01-27T07:42:48.56Z'
+ reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
- dispute_details:
- arn: '123'
+ state: WON
+ tags:
+ order_number: 21DFASJSAKAS
+ transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
@@ -5334,9 +7302,8 @@ components:
self:
href: https://finix.sandbox-payments-api.com/disputes/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
- offset: 0
- limit: 20
- count: 3
+ limit: 100
+ next_cursor: DIs7yQRkHDdMYhurzYz72SFk
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -5347,144 +7314,76 @@ components:
Error406NotAcceptable:
description: Not Acceptable
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error406NotAcceptable'
examples: {}
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
Error422InvalidField:
description: Invalid field
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error422InvalidFieldList'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorForbidden403:
description: Forbidden
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error403ForbiddenList'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorMerchantIdentityDisabled:
description: Merchant identity disabled error
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorMethodNotAllowed:
description: 405 - Method not allowed
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorNotFound:
description: Object does not exist
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error404NotFoundList'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorPaymentRequired:
description: Payment Required
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorTransfers402:
description: 402 - Payment required
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error402PaymentRequired'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorUnauthorized:
description: Authentication information is missing or invalid
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Error401Unauthorized'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
ErrorUnprocessableEntity:
description: Error
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
Fee:
description: Single Fee object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Fee'
examples:
Fee:
value:
id: FEtSD9oNjoCtJaN2C1FwhZ29
+ created_at: '2022-08-15T23:14:03.37Z'
+ updated_at: '2022-08-15T23:14:03.37Z'
amount: 100
currency: USD
display_name: null
@@ -5494,8 +7393,6 @@ components:
linked_id: TR7m4FqzubzFvPJf4WEmkEEv
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- created_at: '2022-08-15T23:14:03.37Z'
- updated_at: '2022-08-15T23:14:03.37Z'
tags: {}
_links:
self:
@@ -5514,67 +7411,67 @@ components:
FeeProfile:
description: Fee profile
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/FeeProfile'
examples:
Fee Profile:
value:
id: FPq6PQ9pHsab66fKMmjQ7jb5
- tags: {}
- application: APgPDQrLD52TYvqazjHJJchM
- fixed_fee: 100
+ created_at: '2022-01-27T07:37:38.66Z'
+ updated_at: '2022-01-27T07:37:38.66Z'
+ ach_basis_points: 300
+ ach_credit_return_fixed_fee: null
+ ach_debit_return_fixed_fee: null
+ ach_fixed_fee: 30
+ american_express_assessment_basis_points: null
+ american_express_basis_points: null
+ american_express_charge_interchange: null
+ american_express_externally_funded_basis_points: null
+ american_express_externally_funded_fixed_fee: null
+ american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
+ application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
- externally_funded_basis_points: null
- externally_funded_fixed_fee: null
- ach_basis_points: 300
- ach_fixed_fee: 30
charge_interchange: false
- dispute_inquiry_fixed_fee: null
- dispute_fixed_fee: null
- ach_debit_return_fixed_fee: null
- ach_credit_return_fixed_fee: null
- visa_basis_points: null
- visa_fixed_fee: null
- visa_charge_interchange: null
- visa_assessments_basis_points: null
- visa_acquirer_processing_fixed_fee: null
- visa_credit_voucher_fixed_fee: null
- visa_kilobyte_access_fixed_fee: null
+ diners_club_basis_points: null
+ diners_club_charge_interchange: null
+ diners_club_fixed_fee: null
+ discover_assessments_basis_points: null
discover_basis_points: null
- discover_fixed_fee: null
- discover_externally_funded_basis_points: null
- discover_externally_funded_fixed_fee: null
discover_charge_interchange: null
- discover_assessments_basis_points: null
discover_data_usage_fixed_fee: null
+ discover_externally_funded_basis_points: null
+ discover_externally_funded_fixed_fee: null
+ discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
- diners_club_basis_points: null
- diners_club_fixed_fee: null
- diners_club_charge_interchange: null
- mastercard_basis_points: null
- mastercard_fixed_fee: null
- mastercard_charge_interchange: null
- mastercard_assessments_under1k_basis_points: null
- mastercard_assessments_over1k_basis_points: null
- mastercard_acquirer_fees_basis_points: null
+ dispute_fixed_fee: null
+ dispute_inquiry_fixed_fee: null
+ externally_funded_basis_points: null
+ externally_funded_fixed_fee: null
+ fixed_fee: 100
jcb_basis_points: null
- jcb_fixed_fee: null
jcb_charge_interchange: null
- american_express_basis_points: null
- american_express_fixed_fee: null
- american_express_externally_funded_basis_points: null
- american_express_externally_funded_fixed_fee: null
- american_express_charge_interchange: null
- american_express_assessment_basis_points: null
- rounding_mode: TRANSACTION
+ jcb_fixed_fee: null
+ mastercard_acquirer_fees_basis_points: null
+ mastercard_assessments_over1k_basis_points: null
+ mastercard_assessments_under1k_basis_points: null
+ mastercard_basis_points: null
+ mastercard_charge_interchange: null
+ mastercard_fixed_fee: null
qualified_tiers: null
- created_at: '2022-01-27T07:37:38.66Z'
- updated_at: '2022-01-27T07:37:38.66Z'
- visa_base_II_system_file_transmission_fixed_fee: null
+ rounding_mode: TRANSACTION
+ tags: {}
+ visa_acquirer_processing_fixed_fee: null
+ visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
+ visa_base_II_system_file_transmission_fixed_fee: null
+ visa_basis_points: null
+ visa_charge_interchange: null
+ visa_credit_voucher_fixed_fee: null
+ visa_fixed_fee: null
+ visa_kilobyte_access_fixed_fee: null
_links:
self:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5
@@ -5590,7 +7487,7 @@ components:
FeeProfilesList:
description: List of fee profiles
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/FeeProfilesList'
examples:
@@ -5599,120 +7496,120 @@ components:
_embedded:
fee_profiles:
- id: FPq6PQ9pHsab66fKMmjQ7jb5
- tags: {}
- application: APgPDQrLD52TYvqazjHJJchM
- fixed_fee: 100
+ created_at: '2022-01-27T07:37:38.66Z'
+ updated_at: '2022-01-27T07:37:38.66Z'
+ ach_basis_points: 300
+ ach_credit_return_fixed_fee: null
+ ach_debit_return_fixed_fee: null
+ ach_fixed_fee: 30
+ american_express_assessment_basis_points: null
+ american_express_basis_points: null
+ american_express_charge_interchange: null
+ american_express_externally_funded_basis_points: null
+ american_express_externally_funded_fixed_fee: null
+ american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
+ application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
- externally_funded_basis_points: null
- externally_funded_fixed_fee: null
- ach_basis_points: 300
- ach_fixed_fee: 30
charge_interchange: false
- dispute_inquiry_fixed_fee: null
- dispute_fixed_fee: null
- ach_debit_return_fixed_fee: null
- ach_credit_return_fixed_fee: null
- visa_basis_points: null
- visa_fixed_fee: null
- visa_charge_interchange: null
- visa_assessments_basis_points: null
- visa_acquirer_processing_fixed_fee: null
- visa_credit_voucher_fixed_fee: null
- visa_kilobyte_access_fixed_fee: null
+ diners_club_basis_points: null
+ diners_club_charge_interchange: null
+ diners_club_fixed_fee: null
+ discover_assessments_basis_points: null
discover_basis_points: null
- discover_fixed_fee: null
- discover_externally_funded_basis_points: null
- discover_externally_funded_fixed_fee: null
discover_charge_interchange: null
- discover_assessments_basis_points: null
discover_data_usage_fixed_fee: null
+ discover_externally_funded_basis_points: null
+ discover_externally_funded_fixed_fee: null
+ discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
- diners_club_basis_points: null
- diners_club_fixed_fee: null
- diners_club_charge_interchange: null
- mastercard_basis_points: null
- mastercard_fixed_fee: null
- mastercard_charge_interchange: null
- mastercard_assessments_under1k_basis_points: null
- mastercard_assessments_over1k_basis_points: null
- mastercard_acquirer_fees_basis_points: null
+ dispute_fixed_fee: null
+ dispute_inquiry_fixed_fee: null
+ externally_funded_basis_points: null
+ externally_funded_fixed_fee: null
+ fixed_fee: 100
jcb_basis_points: null
- jcb_fixed_fee: null
jcb_charge_interchange: null
- american_express_basis_points: null
- american_express_fixed_fee: null
- american_express_externally_funded_basis_points: null
- american_express_externally_funded_fixed_fee: null
- american_express_charge_interchange: null
- american_express_assessment_basis_points: null
- rounding_mode: TRANSACTION
+ jcb_fixed_fee: null
+ mastercard_acquirer_fees_basis_points: null
+ mastercard_assessments_over1k_basis_points: null
+ mastercard_assessments_under1k_basis_points: null
+ mastercard_basis_points: null
+ mastercard_charge_interchange: null
+ mastercard_fixed_fee: null
qualified_tiers: null
- created_at: '2022-01-27T07:37:38.66Z'
- updated_at: '2022-01-27T07:37:38.66Z'
- visa_base_II_system_file_transmission_fixed_fee: null
+ rounding_mode: TRANSACTION
+ tags: {}
+ visa_acquirer_processing_fixed_fee: null
+ visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
+ visa_base_II_system_file_transmission_fixed_fee: null
+ visa_basis_points: null
+ visa_charge_interchange: null
+ visa_credit_voucher_fixed_fee: null
+ visa_fixed_fee: null
+ visa_kilobyte_access_fixed_fee: null
_links:
self:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- id: FPvCQUcnsueN3Bc3zR1qCBG8
- tags: {}
- application: APgPDQrLD52TYvqazjHJJchM
- fixed_fee: 100
+ created_at: '2022-01-27T07:37:36.69Z'
+ updated_at: '2022-01-27T07:37:36.69Z'
+ ach_basis_points: 300
+ ach_credit_return_fixed_fee: null
+ ach_debit_return_fixed_fee: null
+ ach_fixed_fee: 30
+ american_express_assessment_basis_points: null
+ american_express_basis_points: null
+ american_express_charge_interchange: null
+ american_express_externally_funded_basis_points: null
+ american_express_externally_funded_fixed_fee: null
+ american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
+ application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
- externally_funded_basis_points: null
- externally_funded_fixed_fee: null
- ach_basis_points: 300
- ach_fixed_fee: 30
charge_interchange: false
- dispute_inquiry_fixed_fee: null
- dispute_fixed_fee: null
- ach_debit_return_fixed_fee: null
- ach_credit_return_fixed_fee: null
- visa_basis_points: null
- visa_fixed_fee: null
- visa_charge_interchange: null
- visa_assessments_basis_points: null
- visa_acquirer_processing_fixed_fee: null
- visa_credit_voucher_fixed_fee: null
- visa_kilobyte_access_fixed_fee: null
+ diners_club_basis_points: null
+ diners_club_charge_interchange: null
+ diners_club_fixed_fee: null
+ discover_assessments_basis_points: null
discover_basis_points: null
- discover_fixed_fee: null
- discover_externally_funded_basis_points: null
- discover_externally_funded_fixed_fee: null
discover_charge_interchange: null
- discover_assessments_basis_points: null
discover_data_usage_fixed_fee: null
+ discover_externally_funded_basis_points: null
+ discover_externally_funded_fixed_fee: null
+ discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
- diners_club_basis_points: null
- diners_club_fixed_fee: null
- diners_club_charge_interchange: null
- mastercard_basis_points: null
- mastercard_fixed_fee: null
- mastercard_charge_interchange: null
- mastercard_assessments_under1k_basis_points: null
- mastercard_assessments_over1k_basis_points: null
- mastercard_acquirer_fees_basis_points: null
+ dispute_fixed_fee: null
+ dispute_inquiry_fixed_fee: null
+ externally_funded_basis_points: null
+ externally_funded_fixed_fee: null
+ fixed_fee: 100
jcb_basis_points: null
- jcb_fixed_fee: null
jcb_charge_interchange: null
- american_express_basis_points: null
- american_express_fixed_fee: null
- american_express_externally_funded_basis_points: null
- american_express_externally_funded_fixed_fee: null
- american_express_charge_interchange: null
- american_express_assessment_basis_points: null
- rounding_mode: TRANSACTION
+ jcb_fixed_fee: null
+ mastercard_acquirer_fees_basis_points: null
+ mastercard_assessments_over1k_basis_points: null
+ mastercard_assessments_under1k_basis_points: null
+ mastercard_basis_points: null
+ mastercard_charge_interchange: null
+ mastercard_fixed_fee: null
qualified_tiers: null
- created_at: '2022-01-27T07:37:36.69Z'
- updated_at: '2022-01-27T07:37:36.69Z'
- visa_base_II_system_file_transmission_fixed_fee: null
+ rounding_mode: TRANSACTION
+ tags: {}
+ visa_acquirer_processing_fixed_fee: null
+ visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
+ visa_base_II_system_file_transmission_fixed_fee: null
+ visa_basis_points: null
+ visa_charge_interchange: null
+ visa_credit_voucher_fixed_fee: null
+ visa_fixed_fee: null
+ visa_kilobyte_access_fixed_fee: null
_links:
self:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
@@ -5735,7 +7632,7 @@ components:
FeesList:
description: List of Fee objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/FeesList'
examples:
@@ -5743,57 +7640,57 @@ components:
value:
_embedded:
fees:
- - id: FEjoBcxx8X3hPVsdzT19SXp9
- amount: 2
+ - id: FEvQN3v5mhA2Ttc78hzjLV3j
+ created_at: '2022-10-11T03:25:04.79Z'
+ updated_at: '2022-10-11T03:25:04.79Z'
+ amount: 13243
currency: USD
display_name: null
fee_subtype: PLATFORM_FEE
fee_type: CARD_BASIS_POINTS
label: null
- linked_id: TRvmcvtpCSj3qNkzz18TLneX
+ linked_id: TR61nQ89c8U5i7uAvwmSuLnv
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- created_at: '2022-08-17T16:37:00.99Z'
- updated_at: '2022-08-17T16:37:00.99Z'
tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/fees/FEjoBcxx8X3hPVsdzT19SXp9
+ href: https://finix.sandbox-payments-api.com/fees/FEvQN3v5mhA2Ttc78hzjLV3j
merchant:
href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TRvmcvtpCSj3qNkzz18TLneX
- - id: FEtSD9oNjoCtJaN2C1FwhZ29
- amount: 100
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv
+ - id: FEkuQHsAipobyobNSizt4ySJ
+ created_at: '2022-10-10T05:27:04.75Z'
+ updated_at: '2022-10-10T05:27:04.75Z'
+ amount: 2
currency: USD
display_name: null
fee_subtype: PLATFORM_FEE
- fee_type: CARD_FIXED
+ fee_type: CARD_BASIS_POINTS
label: null
- linked_id: TR7m4FqzubzFvPJf4WEmkEEv
+ linked_id: TR3s5fgSyEZ1SnweXKxyWJ6R
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
- created_at: '2022-08-15T23:14:03.37Z'
- updated_at: '2022-08-15T23:14:03.37Z'
tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/fees/FEtSD9oNjoCtJaN2C1FwhZ29
+ href: https://finix.sandbox-payments-api.com/fees/FEkuQHsAipobyobNSizt4ySJ
merchant:
href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv
+ href: https://finix.sandbox-payments-api.com/transfers/TR3s5fgSyEZ1SnweXKxyWJ6R
_links:
self:
href: https://finix.sandbox-payments-api.com/fees?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/fees?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/fees?offset=13360&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/fees?offset=15100&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 2
+ count: 15114
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -5804,7 +7701,7 @@ components:
IdentitiesList:
description: List of Identity objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/IdentitiesList'
examples:
@@ -5813,24 +7710,12 @@ components:
_embedded:
identities:
- id: IDrNRsZ2miEQcmGHCpo4rBQr
+ created_at: '2022-08-16T18:44:27.46Z'
+ updated_at: '2022-08-16T18:44:27.46Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
- title: CEO
- first_name: dwayne
- last_name: xbc
- email: user@example.org
- business_name: Petes Coffee
- business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
- doing_business_as: Petes Coffee
- phone: '1234567890'
- business_phone: +1 (408) 756-4497
- personal_address:
- line1: 741 Douglass St
- line2: Apartment 7
- city: San Mateo
- region: CA
- postal_code: '94114'
- country: USA
+ amex_mid: null
+ annual_card_volume: 12000000
business_address:
line1: 741 Douglass St
line2: Apartment 8
@@ -5838,32 +7723,44 @@ components:
region: CA
postal_code: '94114'
country: USA
- mcc: '0742'
+ business_name: Petes Coffee
+ business_phone: +1 (408) 756-4497
+ business_tax_id_provided: true
+ business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
+ default_statement_descriptor: Petes Coffee
+ discover_mid: null
dob:
day: 27
month: 6
year: 1978
- max_transaction_amount: 12000000
- amex_mid: null
- discover_mid: null
- url: www.PetesCoffee.com
- annual_card_volume: 12000000
+ doing_business_as: Petes Coffee
+ email: user@example.org
+ first_name: dwayne
has_accepted_credit_cards_previously: true
incorporation_date:
day: 27
month: 6
year: 1978
+ last_name: xbc
+ max_transaction_amount: 12000000
+ mcc: '4900'
+ ownership_type: PRIVATE
+ personal_address:
+ line1: 741 Douglass St
+ line2: Apartment 7
+ city: San Mateo
+ region: CA
+ postal_code: '94114'
+ country: USA
+ phone: '14158885080'
principal_percentage_ownership: 50
short_business_name: null
- ownership_type: PRIVATE
tax_authority: null
tax_id_provided: true
- business_tax_id_provided: true
- default_statement_descriptor: Petes Coffee
+ title: CEO
+ url: www.PetesCoffee.com
tags:
test_key_103: test_val_103
- created_at: '2022-08-16T18:44:27.46Z'
- updated_at: '2022-08-16T18:44:27.46Z'
_links:
self:
href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr
@@ -5902,24 +7799,74 @@ components:
Identity:
description: Single Identity object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Identity'
examples:
- Identity (Buyer):
+ Identity - Merchant:
value:
- id: IDgWxBhfGYLLdkhxx2ddYf9K
+ id: IDezsbY5qYujV7ecdrn8psrh
+ created_at: '2022-10-11T00:37:03.02Z'
+ updated_at: '2022-10-11T00:37:03.02Z'
+ additional_underwriting_data:
+ annual_ach_volume: 200000
+ average_ach_transfer_amount: 200000
+ average_card_transfer_amount: 200000
+ business_description: SB3 vegan cafe
+ card_volume_distribution:
+ card_present_percentage: 30
+ ecommerce_percentage: 60
+ mail_order_telephone_order_percentage: 10
+ credit_check_allowed: true
+ credit_check_ip_address: 42.1.1.113
+ credit_check_timestamp: '2021-04-28T16:42:55Z'
+ credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10
+ _14_6)
+ merchant_agreement_accepted: true
+ merchant_agreement_ip_address: 42.1.1.113
+ merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
+ merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac
+ OS X 10_14_6)
+ refund_policy: MERCHANDISE_EXCHANGE_ONLY
+ volume_distribution_by_business_type:
+ business_to_business_volume_percentage: 100
+ business_to_consumer_volume_percentage: 0
+ consumer_to_consumer_volume_percentage: 0
+ other_volume_percentage: 0
+ person_to_person_volume_percentage: 0
application: APgPDQrLD52TYvqazjHJJchM
entity:
- title: null
+ amex_mid: null
+ annual_card_volume: 12000000
+ business_address:
+ line1: 741 Douglass St
+ line2: Apartment 8
+ city: San Mateo
+ region: CA
+ postal_code: '94114'
+ country: USA
+ business_name: Finix Flowers
+ business_phone: +1 (408) 756-4497
+ business_tax_id_provided: true
+ business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
+ default_statement_descriptor: Finix Flowers
+ discover_mid: null
+ dob:
+ day: 27
+ month: 6
+ year: 1978
+ doing_business_as: Finix Flowers
+ email: user@example.org
first_name: John
+ has_accepted_credit_cards_previously: true
+ incorporation_date:
+ day: 27
+ month: 6
+ year: 1978
last_name: Smith
- email: user@example.org
- business_name: null
- business_type: null
- doing_business_as: null
- phone: '7145677613'
- business_phone: null
+ max_transaction_amount: 12000000
+ mcc: '4900'
+ ownership_type: PRIVATE
personal_address:
line1: 741 Douglass St
line2: Apartment 7
@@ -5927,62 +7874,62 @@ components:
region: CA
postal_code: '94114'
country: USA
- business_address: null
- mcc: null
- dob: null
- max_transaction_amount: 0
- amex_mid: null
- discover_mid: null
- url: null
- annual_card_volume: 0
- has_accepted_credit_cards_previously: false
- incorporation_date: null
- principal_percentage_ownership: null
+ phone: '14158885080'
+ principal_percentage_ownership: 50
short_business_name: null
- ownership_type: PRIVATE
tax_authority: null
- tax_id_provided: false
- business_tax_id_provided: false
- default_statement_descriptor: null
+ tax_id_provided: true
+ title: CEO
+ url: https://www.finix.com
tags:
- key: value
- created_at: '2022-01-27T07:36:59.91Z'
- updated_at: '2022-01-27T07:36:59.91Z'
+ Studio Rating: '4.7'
_links:
self:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh
verifications:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/verifications
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/verifications
merchants:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/merchants
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/merchants
settlements:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/settlements
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/settlements
authorizations:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/authorizations
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/transfers
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/transfers
payment_instruments:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/payment_instruments
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/payment_instruments
associated_identities:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/associated_identities
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/associated_identities
disputes:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/disputes
+ href: https://finix.sandbox-payments-api.com/identities/IDezsbY5qYujV7ecdrn8psrh/disputes
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- Identity (Merchant):
+ Identity - Buyer:
value:
- id: IDg6KVYcoRJKdEC5HqKxGMhY
+ id: IDpcMZ7ceTy4iinCH7etmg1M
+ created_at: '2022-10-11T00:36:12.34Z'
+ updated_at: '2022-10-11T00:36:12.34Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
- title: CEO
- first_name: Jane
- last_name: Dow
- email: user@example.org
- business_name: Finix Ferry
- business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
- doing_business_as: Finix Ferry
- phone: '1234567890'
- business_phone: +1 (408) 756-4497
+ amex_mid: null
+ annual_card_volume: 0
+ business_address: null
+ business_name: null
+ business_phone: null
+ business_tax_id_provided: false
+ business_type: null
+ default_statement_descriptor: null
+ discover_mid: null
+ dob: null
+ doing_business_as: null
+ email: finix_example@finix.com
+ first_name: John
+ has_accepted_credit_cards_previously: false
+ incorporation_date: null
+ last_name: Smith
+ max_transaction_amount: 0
+ mcc: null
+ ownership_type: null
personal_address:
line1: 741 Douglass St
line2: Apartment 7
@@ -5990,84 +7937,90 @@ components:
region: CA
postal_code: '94114'
country: USA
- business_address:
- line1: 741 Douglass St
- line2: Apartment 8
- city: San Mateo
- region: CA
- postal_code: '94114'
- country: USA
- mcc: '0742'
- dob:
- day: 27
- month: 6
- year: 1978
- max_transaction_amount: 12000000
+ phone: '7145677613'
+ principal_percentage_ownership: null
+ short_business_name: null
+ tax_authority: null
+ tax_id_provided: false
+ title: null
+ url: null
+ tags:
+ key: value
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M
+ verifications:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/verifications
+ merchants:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/merchants
+ settlements:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/settlements
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/transfers
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/payment_instruments
+ associated_identities:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/associated_identities
+ disputes:
+ href: https://finix.sandbox-payments-api.com/identities/IDpcMZ7ceTy4iinCH7etmg1M/disputes
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ Associated Identity:
+ value:
+ id: ID8v1JtSq1mVoQRcaAb3SWHQ
+ created_at: '2023-01-13T07:02:49.68Z'
+ updated_at: '2023-01-13T07:02:49.68Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ entity:
amex_mid: null
+ annual_card_volume: 0
+ business_address: null
+ business_name: null
+ business_phone: null
+ business_tax_id_provided: false
+ business_type: null
+ default_statement_descriptor: null
discover_mid: null
- url: www.FinixFerry.com
- annual_card_volume: 12000000
- has_accepted_credit_cards_previously: true
- incorporation_date:
- day: 27
- month: 6
- year: 1978
- principal_percentage_ownership: 50
+ dob: null
+ doing_business_as: null
+ email: null
+ first_name: null
+ has_accepted_credit_cards_previously: false
+ incorporation_date: null
+ last_name: null
+ max_transaction_amount: 0
+ mcc: null
+ ownership_type: null
+ personal_address: null
+ phone: null
+ principal_percentage_ownership: 25
short_business_name: null
- ownership_type: PRIVATE
tax_authority: null
- tax_id_provided: true
- business_tax_id_provided: true
- default_statement_descriptor: Finix Ferry
- tags:
- test_key_102: test_val_102
- created_at: '2022-08-16T18:44:26.55Z'
- updated_at: '2022-08-16T18:44:26.55Z'
- additional_underwriting_data:
- annual_ach_volume: 200000
- average_ach_transfer_amount: 200000
- average_card_transfer_amount: 200000
- business_description: BCSB3 vegan cafe
- card_volume_distribution:
- card_present_percentage: 30
- ecommerce_percentage: 60
- mail_order_telephone_order_percentage: 10
- credit_check_allowed: true
- credit_check_ip_address: 42.1.1.113
- credit_check_timestamp: '2021-04-28T16:42:55Z'
- credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10
- _14_6)
- merchant_agreement_accepted: true
- merchant_agreement_ip_address: 42.1.1.113
- merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
- merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac
- OS X 10_14_6)
- refund_policy: MERCHANDISE_EXCHANGE_ONLY
- volume_distribution_by_business_type:
- business_to_business_volume_percentage: 100
- business_to_consumer_volume_percentage: 0
- consumer_to_consumer_volume_percentage: 0
- other_volume_percentage: 0
- person_to_person_volume_percentage: 0
+ tax_id_provided: false
+ title: null
+ url: null
+ tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ
verifications:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/verifications
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/verifications
merchants:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/merchants
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/merchants
settlements:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/settlements
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/settlements
authorizations:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/authorizations
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/transfers
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/transfers
payment_instruments:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/payment_instruments
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/payment_instruments
associated_identities:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/associated_identities
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/associated_identities
disputes:
- href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/disputes
+ href: https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/disputes
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
headers:
@@ -6080,94 +8033,108 @@ components:
Merchant:
description: Single Merchant object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Merchant'
examples:
Merchant:
value:
- id: MUmUL7aBsHkxVLQawJxEXw6N
+ id: MUucec6fHeaWo3VHYoSkUySM
+ created_at: '2022-01-27T07:36:58.19Z'
+ updated_at: '2022-10-06T20:25:24.06Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDrH4G2VTfNjn1VFkvhcyMYj
- verification: VIioiAQWmoT6b6p6mqSggKvA
- merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- key_2: value_2
- mcc: null
- mid: FNXeyy4moA2MvW2Ng9yctRyAZ
- merchant_name: John Smith
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
+ card_expiration_date_required: true
+ convenience_charges_enabled: false
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
+ gross_settlement_enabled: false
+ identity: IDpYDM7J9n57q849o9E9yNrG
level_two_level_three_data_enabled: false
- created_at: '2022-08-17T20:33:34.04Z'
- updated_at: '2022-08-17T20:34:01.49Z'
+ mcc: '4900'
+ merchant_name: Bobs Burgers
+ merchant_profile: MPzW2oRPtkLxK3fymcMACFi
+ mid: FNXh6htoPnfwmgGdvaG4L67Q1
onboarding_state: APPROVED
+ processing_enabled: true
+ processor: DUMMY_V1
processor_details:
- mid: FNXeyy4moA2MvW2Ng9yctRyAZ
+ mid: FNXh6htoPnfwmgGdvaG4L67Q1
api_key: secretValue
- convenience_charges_enabled: false
+ ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key_2: value_2
+ verification: VIxfDrRKZZzkCDDbeCT15oDN
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
+ href: https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
+ href: https://finix.sandbox-payments-api.com/identities/IDoZy2xjNQyWCkN5nKZbVp6x
verifications:
- href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications
+ href: https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk/verifications
merchant_profile:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPh4vD8hWCtqHeJ8JgG4Tsva
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
verification:
- href: https://finix.sandbox-payments-api.com/verifications/VIioiAQWmoT6b6p6mqSggKvA
- Merchant Created with Card Present Enabled:
+ href: https://finix.sandbox-payments-api.com/verifications/VIr27e4C5AWxgvLnyGJmdZQe
+ Merchant - Card Present Enabled:
value:
- id: MUnvf2P5BkDjJ3giAAs6LVrM
+ id: MUu56ZGx3Xb6U9gAqKfgNisd
+ created_at: '2019-03-01T01:57:19.95Z'
+ updated_at: '2019-05-15T18:10:03.00Z'
application: APeUbTUjvYb1CdPXvNcwW1wP
- identity: IDaVwMrWz9BLz6RHrV6L8FS3
- verification: VI5PsAheSRY9NEVdkFQ4STBD
- merchant_profile: MPmyXg5r5ckg1EgM9swsJEsG
- processor: VANTIV_V1
- processing_enabled: false
- settlement_enabled: false
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: false
+ card_cvv_required: false
card_expiration_date_required: true
- card_cvv_required: true
- tags:
- key_2: value_2
- mcc: null
- mid: null
- merchant_name: Finix Flowers
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
+ convenience_charges_enabled: false
+ creating_transfer_from_report_enabled: false
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
+ gross_settlement_enabled: false
+ identity: IDsbTBawhnLBAVeinRb84vFR
level_two_level_three_data_enabled: false
- created_at: '2022-06-05T18:13:48.14Z'
- updated_at: '2022-06-05T18:13:48.14Z'
- onboarding_state: PROVISIONING
- processor_details: {}
+ mcc: '4900'
+ merchant_name: Finix Flowers
+ merchant_profile: MPcMKhfF9rhWT2JWeUKzQVy2
+ mid: '4445029863321'
+ onboarding_state: REJECTED
+ processing_enabled: true
+ processor: VANTIV_V1
+ processor_details:
+ acceptor_id: '874767464'
+ default_terminal_id: X6600507601
+ mid: '4445029863321'
+ account_token: 811D0B76DEC8CCD1903D2772B68DA0CACA84BF56B5A6EE61EC05FE126EA63EF1B979A401
+ account_id: '1056772'
+ merchant_ident_string: '4445029863321'
+ id: '193448212'
+ vantiv_merchant_id: '4445029863321'
+ ready_to_settle_upon: RECONCILIATION
+ rent_surcharges_enabled: false
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key_2: value_2
+ verification: VImHURoSqEvAf9haPD6zeHJx
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchants/MUnvf2P5BkDjJ3giAAs6LVrM
+ href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDaVwMrWz9BLz6RHrV6L8FS3
+ href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
verifications:
- href: https://finix.sandbox-payments-api.com/merchants/MUnvf2P5BkDjJ3giAAs6LVrM/verifications
+ href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd/verifications
merchant_profile:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPmyXg5r5ckg1EgM9swsJEsG
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPcMKhfF9rhWT2JWeUKzQVy2
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
verification:
- href: https://finix.sandbox-payments-api.com/verifications/VI5PsAheSRY9NEVdkFQ4STBD
+ href: https://finix.sandbox-payments-api.com/verifications/VImHURoSqEvAf9haPD6zeHJx
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6178,19 +8145,20 @@ components:
MerchantProfile:
description: Single merchant profile object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/MerchantProfile'
examples:
Merchant Profile:
value:
id: MPsdo8WPP5erWzfPwMjYjVy3
- tags: {}
+ created_at: '2022-08-15T21:37:47.26Z'
+ updated_at: '2022-08-15T21:38:24.02Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
+ payout_profile: null
risk_profile: RPwAziDZginXDWuuiDSaA3wr
- created_at: '2022-08-15T21:37:47.26Z'
- updated_at: '2022-08-15T21:38:24.02Z'
+ tags: {}
_links:
self:
href: https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3
@@ -6208,7 +8176,7 @@ components:
MerchantProfilesList:
description: Single merchant profile object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/MerchantProfilesList'
examples:
@@ -6216,70 +8184,51 @@ components:
value:
_embedded:
merchant_profiles:
- - id: MPjBZguwk8oJ9H5ouJo3jaG4
- tags: {}
+ - id: MPnXB4UBGtSUfxwA41z2Hqid
+ created_at: '2022-10-10T05:20:18.12Z'
+ updated_at: '2022-10-10T05:21:01.42Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
- risk_profile: RPnxLQLjV4Rma67zU4m8NnqW
- created_at: '2022-08-17T20:33:34.04Z'
- updated_at: '2022-08-17T20:33:34.04Z'
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
- application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPnxLQLjV4Rma67zU4m8NnqW
- - id: MPhphMCVwQ6ioryNXT9fFdpQ
+ payout_profile: PO8ki51uFGkLYaWyBVJ7oyAt
+ risk_profile: RPqzvQLoHk37r74aE6NZ4aXt
tags: {}
- application: APgPDQrLD52TYvqazjHJJchM
- fee_profile: null
- risk_profile: RPv4BsNuXQYqB6sAyXVaiXvQ
- created_at: '2022-08-16T18:50:51.99Z'
- updated_at: '2022-08-16T18:51:03.18Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPhphMCVwQ6ioryNXT9fFdpQ
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnXB4UBGtSUfxwA41z2Hqid
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPv4BsNuXQYqB6sAyXVaiXvQ
- - id: MPnZBXBVKYHBgYXzx7vhznWc
- tags: {}
+ href: https://finix.sandbox-payments-api.com/risk_profiles/RPqzvQLoHk37r74aE6NZ4aXt
+ - id: MPo85BavSYVrkDn57BLh1JTs
+ created_at: '2022-09-21T17:46:06.29Z'
+ updated_at: '2022-09-21T17:46:07.75Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
- risk_profile: RPpiJkfXqstuuhvX8GbbSCQU
- created_at: '2022-08-15T21:37:45.87Z'
- updated_at: '2022-08-15T21:38:23.63Z'
+ payout_profile: PO9AtdBb4FUQqbMm3SAyoX3z
+ risk_profile: RP5PUJVynFoHibX6eHtfebV3
+ tags: {}
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPo85BavSYVrkDn57BLh1JTs
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
risk_profile:
- href: https://finix.sandbox-payments-api.com/risk_profiles/RPpiJkfXqstuuhvX8GbbSCQU
+ href: https://finix.sandbox-payments-api.com/risk_profiles/RP5PUJVynFoHibX6eHtfebV3
_links:
self:
href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=1500&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/merchant_profiles?offset=1660&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 3
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
+ count: 1671
MerchantsList:
description: List of Merchants objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/MerchantsList'
examples:
@@ -6287,101 +8236,105 @@ components:
value:
_embedded:
merchants:
- - id: MUmUL7aBsHkxVLQawJxEXw6N
+ - id: MUk3936kZweevCrjyHLN1vsu
+ created_at: '2022-10-10T05:20:18.12Z'
+ updated_at: '2022-10-10T05:21:01.42Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDrH4G2VTfNjn1VFkvhcyMYj
- verification: VIioiAQWmoT6b6p6mqSggKvA
- merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- key_2: value_2
- mcc: null
- mid: FNXeyy4moA2MvW2Ng9yctRyAZ
- merchant_name: John Smith
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
+ card_expiration_date_required: true
+ convenience_charges_enabled: false
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
+ gross_settlement_enabled: false
+ identity: IDx2ZETjYiWkbitkYdFt1yLF
level_two_level_three_data_enabled: false
- created_at: '2022-08-17T20:33:34.04Z'
- updated_at: '2022-08-17T20:34:01.49Z'
+ mcc: '4900'
+ merchant_name: Finix Flowers
+ merchant_profile: MPnXB4UBGtSUfxwA41z2Hqid
+ mid: FNXqeJt93ojP2cn1VUYtXANCF
onboarding_state: APPROVED
+ processing_enabled: true
+ processor: DUMMY_V1
processor_details:
- mid: FNXeyy4moA2MvW2Ng9yctRyAZ
+ mid: FNXqeJt93ojP2cn1VUYtXANCF
api_key: secretValue
- convenience_charges_enabled: false
+ ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key_2: value_2
+ verification: VItUgbe9V8vpgSaJAriLDxER
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N
+ href: https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
+ href: https://finix.sandbox-payments-api.com/identities/IDx2ZETjYiWkbitkYdFt1yLF
verifications:
- href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications
+ href: https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu/verifications
merchant_profile:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnXB4UBGtSUfxwA41z2Hqid
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
verification:
- href: https://finix.sandbox-payments-api.com/verifications/VIioiAQWmoT6b6p6mqSggKvA
- - id: MUkobdhdxtCL4tzvJobZ7vBH
+ href: https://finix.sandbox-payments-api.com/verifications/VItUgbe9V8vpgSaJAriLDxER
+ - id: MU951dfkbH7nqVm4G91yb2au
+ created_at: '2022-09-21T17:46:06.29Z'
+ updated_at: '2022-09-21T17:46:09.45Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDx7GYHa4eiZtqCEAB2suaKt
- verification: VIvkSfF4m5B6q3CGwtUGgGRi
- merchant_profile: MPnZBXBVKYHBgYXzx7vhznWc
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- test_key_102: test_val_102
- mcc: '0742'
- mid: FNXdmKNYL1PedUZhopAwg83ZU
- merchant_name: Petes Coffee
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
+ card_expiration_date_required: true
+ convenience_charges_enabled: false
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
+ gross_settlement_enabled: false
+ identity: ID4YPdRriet29ZhaiVa6qhJ5
level_two_level_three_data_enabled: false
- created_at: '2022-08-15T21:37:45.87Z'
- updated_at: '2022-08-15T21:38:23.63Z'
+ mcc: '4900'
+ merchant_name: Petes Coffee
+ merchant_profile: MPo85BavSYVrkDn57BLh1JTs
+ mid: FNXkitpwdmgMJ8Vz9FxKBCSza
onboarding_state: APPROVED
+ processing_enabled: true
+ processor: DUMMY_V1
processor_details:
- mid: FNXdmKNYL1PedUZhopAwg83ZU
+ mid: FNXkitpwdmgMJ8Vz9FxKBCSza
api_key: secretValue
- convenience_charges_enabled: false
+ ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key: value_2
+ verification: VIrjCZHf8v8arhbgPTikKmpp
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH
+ href: https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDx7GYHa4eiZtqCEAB2suaKt
+ href: https://finix.sandbox-payments-api.com/identities/ID4YPdRriet29ZhaiVa6qhJ5
verifications:
- href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH/verifications
+ href: https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au/verifications
merchant_profile:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MPo85BavSYVrkDn57BLh1JTs
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
verification:
- href: https://finix.sandbox-payments-api.com/verifications/VIvkSfF4m5B6q3CGwtUGgGRi
+ href: https://finix.sandbox-payments-api.com/verifications/VIrjCZHf8v8arhbgPTikKmpp
_links:
self:
href: https://finix.sandbox-payments-api.com/merchants?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/merchants?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/merchants?offset=1500&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/merchants?offset=1660&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 2
+ count: 1669
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6391,36 +8344,27 @@ components:
$ref: '#/components/headers/x-request-id'
NoContent:
description: No content
- headers:
- finix-apiuser-role:
- $ref: '#/components/headers/finix-apiuser-role'
- date:
- $ref: '#/components/headers/date'
- x-request-id:
- $ref: '#/components/headers/x-request-id'
PaymentInstrument:
description: Single Payment Instrument object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/PaymentInstrument'
descriminator:
propertyName: type
examples:
- Payment Instrument (Card):
+ Payment Instrument - Card:
value:
- id: PIwWisLuZNwPBoLbCgQVTCoY
+ id: PI8uU6wfi6hqBoWmzm9L4F2b
+ created_at: '2022-10-11T01:42:22.32Z'
+ updated_at: '2022-10-11T01:42:22.32Z'
application: APgPDQrLD52TYvqazjHJJchM
- fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
- tags:
- card_name: Business Card
- expiration_month: 12
- expiration_year: 2029
- bin: '400000'
- last_four: '9979'
- brand: VISA
- card_type: UNKNOWN
- name: Amy White
+ created_via: API
+ currency: USD
+ enabled: true
+ fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
+ identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: null
@@ -6428,135 +8372,342 @@ components:
region: CA
postal_code: '94404'
country: USA
- address_verification: NO_MATCH
- security_code_verification: UNMATCHED
- created_at: '2022-08-15T23:13:06.13Z'
- updated_at: '2022-08-15T23:13:06.88Z'
- instrument_type: PAYMENT_CARD
+ address_verification: UNKNOWN
+ bin: '520082'
+ brand: MASTERCARD
+ card_type: DEBIT
+ expiration_month: 12
+ expiration_year: 2029
+ issuer_country: NON_USA
+ last_four: '8210'
+ name: John Smith
+ security_code_verification: UNKNOWN
+ tags:
+ card_name: Business Card
type: PAYMENT_CARD
- currency: USD
- identity: IDgWxBhfGYLLdkhxx2ddYf9K
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
updates:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
- Payment Instrument (Bank Account):
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/updates
+ Payment Instrument - Bank Account:
value:
- id: PI8sdzepdapDehPWKFTcre1m
+ id: PI3AbkuRR1JbT5kPiGQCXvD9
+ created_at: '2022-10-11T01:42:53.29Z'
+ updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
- tags:
- Bank Account: Company Account
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
- name: Alice
- account_type: SAVINGS
- bank_account_validation_check: NOT_ATTEMPTED
- created_at: '2022-01-27T07:36:57.62Z'
- updated_at: '2022-01-27T07:36:57.62Z'
- instrument_type: BANK_ACCOUNT
+ name: John
+ tags:
+ Bank Account: Company Account
type: BANK_ACCOUNT
- currency: USD
- identity: IDpYDM7J9n57q849o9E9yNrG
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
- Payment Instrument (Token):
+ Payment Instrument - Token:
value:
- id: PIs4ZXrQB1RjbYJSgkfbcrbM
+ id: PImmCg3Po7oNi7jaZcXhfkEu
+ created_at: '2022-10-10T05:32:17.78Z'
+ updated_at: '2022-10-10T05:32:17.78Z'
application: APgPDQrLD52TYvqazjHJJchM
- fingerprint: FPRw9NoorETQgCjFgwKPvcGsV
- tags: {}
- expiration_month: 12
- expiration_year: 2029
- bin: '495703'
- last_four: '0454'
- brand: VISA
- card_type: UNKNOWN
- name: null
+ created_via: API
+ currency: USD
+ enabled: true
+ fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
+ identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ instrument_type: PAYMENT_CARD
address:
- line1: 741 Douglass St
- line2: Apartment 7
- city: San Mateo
+ line1: 900 Metro Center Blv
+ line2: null
+ city: San Francisco
region: CA
- postal_code: '94114'
+ postal_code: '94404'
country: USA
address_verification: UNKNOWN
+ bin: '520082'
+ brand: MASTERCARD
+ card_type: DEBIT
+ expiration_month: 12
+ expiration_year: 2029
+ issuer_country: NON_USA
+ last_four: '8210'
+ name: Amy White
security_code_verification: UNKNOWN
- created_at: '2022-01-27T07:37:27.42Z'
- updated_at: '2022-01-27T07:37:27.42Z'
- instrument_type: PAYMENT_CARD
+ tags:
+ card_name: Business Card
type: PAYMENT_CARD
- currency: USD
- identity: IDpYDM7J9n57q849o9E9yNrG
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
updates:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/updates
- Payment Instrument (Apple Pay Web):
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/updates
+ Payment Instrument - Apple Pay:
value:
- id: PI4gTM3twQ5XyXfM4rTuFvpo
+ id: PImE5ZhGZJNFy14DtX8wX6f6
+ created_at: '2022-10-10T05:36:55.27Z'
+ updated_at: '2022-10-10T05:36:55.27Z'
application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ enabled: true
fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
- tags: {}
- name: John Smith
+ identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ instrument_type: APPLE_PAY
+ bin: '370382'
+ brand: AMERICAN_EXPRESS
+ card_type: UNKNOWN
expiration_month: 11
expiration_year: 2024
- bin: '370382'
+ issuer_country: UNKNOWN
last_four: '8576'
- brand: AMERICAN_EXPRESS
- created_at: '2022-04-01T19:41:16.48Z'
- updated_at: '2022-04-01T19:41:16.51Z'
- instrument_type: APPLE_PAY
+ name: John Smith
+ tags: {}
type: APPLE_PAY
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/transfers
+ verifications:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/verifications
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
+ Payment Instrument - Google Pay:
+ value:
+ id: PIf8dyFFcEGBqPhaG22hPyYs
+ created_at: '2022-10-10T05:36:55.27Z'
+ updated_at: '2022-10-10T05:36:55.27Z'
+ application: APeUfzF5qdNkBCtdgcf3333n
+ created_via: API
+ currency: USD
+ enabled: true
+ fingerprint: FPRrcobjtdU98gr4sjiqYR1Qg
+ identity: ID78Fh8mcnnzukVzbdoyex5y
+ instrument_type: GOOGLE_PAY
+ bin: '411111'
+ brand: VISA
+ card_type: UNKNOWN
+ expiration_month: 12
+ expiration_year: 2027
+ issuer_country: UNKNOWN
+ last_four: '1111'
+ name: Finix Sandbox
+ tags: {}
+ type: GOOGLE_PAY
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/transfers
+ verifications:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/verifications
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APeUfzF5qdNkBCtdgcf3333n
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/ID78Fh8mcnnzukVzbdoyex5y
+ Payment Instrument - Update a Card's Address:
+ value:
+ id: PIwWisLuZNwPBoLbCgQVTCoY
+ created_at: '2022-08-15T23:13:06.13Z'
+ updated_at: '2023-02-28T21:12:29.72Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
currency: USD
+ disabled_code: null
+ disabled_message: null
+ enabled: true
+ fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ instrument_type: PAYMENT_CARD
+ address:
+ line1: 900 Metro Center Blv
+ line2: Suite 200
+ city: Los Angeles
+ region: CA
+ postal_code: '94404'
+ country: USA
+ address_verification: UNKNOWN
+ bin: '400000'
+ brand: VISA
+ card_type: UNKNOWN
+ expiration_month: 12
+ expiration_year: 2029
+ issuer_country: UNKNOWN
+ last_four: '9979'
+ name: Amy White
+ security_code_verification: UNMATCHED
+ tags:
+ card_name: Business Card
+ custom_key: custome value
+ type: PAYMENT_CARD
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI4gTM3twQ5XyXfM4rTuFvpo/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
+ updates:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
+ Payment Instrument - Disable a Payment Instrument:
+ value:
+ id: PIwbvcQGrEP33HShmYM7BR8o
+ created_at: '2023-02-28T19:05:56.24Z'
+ updated_at: '2023-02-28T21:16:18.80Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ disabled_code: USER_INITIATED
+ disabled_message: The card has been disabled by a user.
+ enabled: false
+ fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: NOT_ATTEMPTED
+ bank_code: '123123123'
+ country: USA
+ masked_account_number: XXXXX3123
+ name: null
+ tags:
+ card_name: Personal Card
+ type: BANK_ACCOUNT
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
+ verifications:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ Payment Instrument - Bank Account Validation Check:
+ value:
+ id: PIpU66orYpdrPSs91fqRJd66
+ created_at: '2023-03-13T23:28:34.10Z'
+ updated_at: '2023-03-13T23:28:34.10Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ disabled_code: null
+ disabled_message: null
+ enabled: true
+ fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: VALID
+ bank_code: '123123123'
+ country: USA
+ masked_account_number: XXXXX3123
+ name: null
+ tags: {}
+ type: BANK_ACCOUNT
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/transfers
+ verifications:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/verifications
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ Payment Instrument - Update Payment Instrument Tags:
+ value:
+ id: PIwbvcQGrEP33HShmYM7BR8o
+ created_at: '2023-02-28T19:05:56.24Z'
+ updated_at: '2023-02-28T21:18:24.79Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ disabled_code: null
+ disabled_message: null
+ enabled: true
+ fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: NOT_ATTEMPTED
+ bank_code: '123123123'
+ country: USA
+ masked_account_number: XXXXX3123
+ name: null
+ tags:
+ card_name: Personal Card
+ type: BANK_ACCOUNT
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
+ authorizations:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
+ transfers:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
+ verifications:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6567,7 +8718,7 @@ components:
PaymentInstrumentToken:
description: Token response object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentToken'
headers:
@@ -6580,69 +8731,9 @@ components:
PaymentInstrumentUpdatesList:
description: List of Update objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentUpdatesList'
- examples:
- Payment Instrument Updates:
- value:
- _embedded:
- updates:
- - id: IUgfbYVzbgzZ9hqYCNmqMiXx
- application: APgPDQrLD52TYvqazjHJJchM
- merchant: MUucec6fHeaWo3VHYoSkUySM
- state: SUCCEEDED
- messages: []
- created_at: '2022-01-27T07:37:29.94Z'
- updated_at: '2022-01-27T07:38:02.24Z'
- payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
- trace_id: b576beef-5acf-4fab-aa22-07266523616a
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/updates/IUgfbYVzbgzZ9hqYCNmqMiXx
- payment_instrument:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
- application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- - id: IUaZCvDxBcdSeCvtVMnM6tBk
- application: APgPDQrLD52TYvqazjHJJchM
- merchant: MUucec6fHeaWo3VHYoSkUySM
- state: SUCCEEDED
- messages: []
- created_at: '2022-06-27T16:53:35.84Z'
- updated_at: '2022-06-27T16:54:02.43Z'
- payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
- trace_id: bbe9656f-3c6d-4eef-912b-600f15da3f49
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/updates/IUaZCvDxBcdSeCvtVMnM6tBk
- payment_instrument:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
- application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- - id: IUbnw4ZC5EvQcZp6fCw6S1GS
- application: APgPDQrLD52TYvqazjHJJchM
- merchant: MUucec6fHeaWo3VHYoSkUySM
- state: SUCCEEDED
- messages: []
- created_at: '2022-08-01T01:25:41.63Z'
- updated_at: '2022-08-01T01:26:02.82Z'
- payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137
- trace_id: 11db0d65-78aa-4fe4-a0c8-a7d26c434dce
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/updates/IUbnw4ZC5EvQcZp6fCw6S1GS
- payment_instrument:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
- application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates?offset=0&limit=20&sort=created_at,desc&sort=id,desc
- page:
- offset: 0
- limit: 20
- count: 3
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6653,7 +8744,7 @@ components:
PaymentInstrumentsList:
description: List of Payment Instrument objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentsList'
examples:
@@ -6661,89 +8752,81 @@ components:
value:
_embedded:
payment_instruments:
- - id: PI5peqd4kzQ6LD3hb3vebj5x
+ - id: PI3AbkuRR1JbT5kPiGQCXvD9
+ created_at: '2022-10-11T01:42:53.29Z'
+ updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
+ created_via: API
+ currency: USD
+ enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
- tags:
- Bank Account: Company Account
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
- name: Alice
- account_type: SAVINGS
- bank_account_validation_check: NOT_ATTEMPTED
- created_at: '2022-08-17T20:33:24.57Z'
- updated_at: '2022-08-17T20:33:24.57Z'
- instrument_type: BANK_ACCOUNT
+ name: John
+ tags:
+ Bank Account: Company Account
type: BANK_ACCOUNT
- currency: USD
- identity: IDrH4G2VTfNjn1VFkvhcyMYj
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj
- - id: PIwWisLuZNwPBoLbCgQVTCoY
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ - id: PIrb1DcGz1qjThotDJ5KURpv
+ created_at: '2022-10-06T20:23:38.74Z'
+ updated_at: '2022-10-06T20:23:38.74Z'
application: APgPDQrLD52TYvqazjHJJchM
- fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
- tags:
- card_name: Business Card
- expiration_month: 12
- expiration_year: 2029
- bin: '400000'
- last_four: '9979'
- brand: VISA
- card_type: UNKNOWN
- name: Amy White
- address:
- line1: 900 Metro Center Blv
- line2: null
- city: San Francisco
- region: CA
- postal_code: '94404'
- country: USA
- address_verification: NO_MATCH
- security_code_verification: UNMATCHED
- created_at: '2022-08-15T23:13:06.13Z'
- updated_at: '2022-08-15T23:13:06.88Z'
- instrument_type: PAYMENT_CARD
- type: PAYMENT_CARD
+ created_via: API
currency: USD
- identity: IDgWxBhfGYLLdkhxx2ddYf9K
+ enabled: true
+ fingerprint: FPRtvYkgcwLUdjq7B4AgxKfmr
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ instrument_type: BANK_ACCOUNT
+ account_type: SAVINGS
+ bank_account_validation_check: NOT_ATTEMPTED
+ bank_code: '666666666'
+ country: USA
+ masked_account_number: XXXXX3123
+ name: test_python
+ tags:
+ bank_account: Test Python Account
+ type: BANK_ACCOUNT
_links:
self:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv
authorizations:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/authorizations
transfers:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/transfers
verifications:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
- updates:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/payment_instruments?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/payment_instruments?offset=13100&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/payment_instruments?offset=14660&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 2
+ count: 14679
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6754,30 +8837,41 @@ components:
Processor:
description: Single Processor object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Processor'
examples:
Application Processor:
value:
- id: PRrEnUtBAWMj35r4wkjycncs
- application: APgPDQrLD52TYvqazjHJJchM
- default_merchant_profile: MPukqLdkiojiX2SauizfaRYr
- application_config: null
- system_config: null
- created_at: '2022-01-27T07:36:34.55Z'
- updated_at: '2022-01-27T07:36:34.46Z'
- processor: DUMMY_V1
+ id: PR9DvbgX5uuhqyKuBBD6VmFi
+ created_at: '2022-04-29T18:29:23.07Z'
+ updated_at: '2022-04-29T18:29:22.97Z'
+ application: APdHjTsAPx81go7ekSMJqQdz
+ application_config:
+ key1: value-1
+ key2: value-2
+ can_debit_bank_account: true
+ allow_split_payouts: false
+ ach_immediate_destination_name: null
+ default_currencies:
+ - USD
+ ach_settlement_delay_days: null
+ default_level_two_level_three_data_enabled: false
+ template_countries_available: []
+ alert_on_unknown_merchants: false
config:
key1: value-1
key2: value-2
canDebitBankAccount: true
+ default_merchant_profile: MPpWCidKDfKZARSJKCAW3kex
enabled: true
+ processor: DUMMY_V1
+ system_config: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors/DUMMY_V1
+ href: https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1
application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ href: https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6788,7 +8882,7 @@ components:
ProcessorsList:
description: List of Processor objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ProcessorsList'
examples:
@@ -6796,11 +8890,79 @@ components:
value:
_embedded:
processors:
- - id: PRrH5Cy9ZYFUZDha4cuDgipv
+ - id: PRmr3QooJNFuehWTjsJwkWp8
+ created_at: '2022-09-19T01:27:07.86Z'
+ updated_at: '2022-09-19T01:27:07.65Z'
application: APmuwPBaW8pVcwb4vCTHQH32
+ application_config:
+ can_debit_bank_account: true
+ enable_pin_debit: true
+ ach_settlement_delay_days: null
+ allow_custom_billing: false
+ allow_partial_auth: false
+ allow_split_payouts: false
+ allow_create_credentials: false
+ amex_acquired: false
+ merchant_fraud_enabled: false
+ allow_debit_online: false
+ boarding_id: VGPG
+ business_type: Retail
+ vantiv_sftp_username: VGPGSFTP
+ vantiv_sftp_password: ca7Abrug
+ vantiv_chain_number: '0X6600'
+ vantiv_license: VANTIV license="6ad47..."
+ check_for_duplicate_transactions: 'Yes'
+ username: FINIXNEW
+ password: cert1234
+ chargebacks_username: null
+ chargebacks_password: null
+ payfac_merchant_id: '01185553'
+ payfac_username: FINIXNEWMP
+ payfac_password: cert12mp
+ reports_sftp_username: username
+ reports_sftp_password: password
+ ach_immediate_destination_name: null
+ sftp_username: finixv12txn
+ sftp_password: 4J7Lp9Xq
+ tp_application_name: express.chris
+ tp_application_id: null
+ tp_application_version: '1.0'
+ tp_authorization: Version=2.0
+ tp_base_url: https://triposcert.vantiv.com/
+ ep_transaction_url: null
+ ep_reporting_url: null
+ ep_services_url: null
+ ep_application_id: null
+ ep_application_name: null
+ ep_application_version: null
+ settlement_payment_type: regular
+ card_sale_submission_method: null
+ default_currencies:
+ - USD
+ vantiv_trace_id_option: null
+ acquiring_bin: null
+ default_level_two_level_three_data_enabled: false
+ template_countries_available: []
+ alert_on_unknown_merchants: false
+ config:
+ key1: value-1
+ key2: value-2
+ canDebitBankAccount: true
default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
+ enabled: true
+ processor: VANTIV_V1
+ system_config: null
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/VANTIV_V1
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
+ - id: PRrH5Cy9ZYFUZDha4cuDgipv
+ created_at: '2022-04-01T20:45:28.22Z'
+ updated_at: '2022-04-01T20:45:28.11Z'
+ application: APmuwPBaW8pVcwb4vCTHQH32
application_config:
- default_sender_account_number: '123456789012'
+ default_sender_account_number: '1415888508012'
default_sender_address_line1: 21 Broadway
default_sender_address_line2: null
default_sender_city: OFallon
@@ -6817,24 +8979,24 @@ components:
default_currencies:
- CRC
configuration_templates: null
- default_level_two_level_three_data_enabled: false
ach_settlement_delay_days: null
+ default_level_two_level_three_data_enabled: false
allow_split_payouts: false
alert_on_unknown_merchants: false
- system_config: null
- created_at: '2022-04-01T20:45:28.22Z'
- updated_at: '2022-04-01T20:45:28.11Z'
- processor: MASTERCARD_V1
config: {}
+ default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
enabled: true
+ processor: MASTERCARD_V1
+ system_config: null
_links:
self:
href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/MASTERCARD_V1
application:
href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
- id: PR686aPfkq2cyHGtKfsxtoib
+ created_at: '2021-10-04T17:46:10.09Z'
+ updated_at: '2021-10-04T17:46:10.00Z'
application: APmuwPBaW8pVcwb4vCTHQH32
- default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg
application_config:
key1: value-1
key2: value-2
@@ -6847,15 +9009,14 @@ components:
default_level_two_level_three_data_enabled: false
template_countries_available: []
alert_on_unknown_merchants: false
- system_config: null
- created_at: '2021-10-04T17:46:10.09Z'
- updated_at: '2021-10-04T17:46:10.00Z'
- processor: DUMMY_V1
config:
key1: value-1
key2: value-2
canDebitBankAccount: true
+ default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg
enabled: true
+ processor: DUMMY_V1
+ system_config: null
_links:
self:
href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/DUMMY_V1
@@ -6867,7 +9028,7 @@ components:
page:
offset: 0
limit: 20
- count: 2
+ count: 3
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6878,7 +9039,7 @@ components:
ReversalsList:
description: List of Reversals
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/TransfersList'
examples:
@@ -6886,36 +9047,40 @@ components:
value:
_embedded:
transfers:
- - id: TR6tJC1MuHgr52KC2orx84oh
+ - id: TRtLhSEAHak7isKjZu9x7Gjh
+ created_at: '2022-10-10T04:16:27.47Z'
+ updated_at: '2022-10-10T04:17:05.03Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 100
- tags:
- test: refund
- state: SUCCEEDED
- trace_id: e47cc3b1-f70f-4873-8fc8-4e3863755d89
- currency: USD
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
- ready_to_settle_at: '2022-08-16T04:00:00.00Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*DUNDER MIFFLIN
- type: REVERSAL
- messages: []
- raw: null
- created_at: '2022-08-15T23:12:32.53Z'
- updated_at: '2022-08-15T23:13:13.89Z'
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-10-10T04:17:05.04Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: refund
+ trace_id: e200c5b9-3ac9-4a21-a69e-cd0ffb6c2490
+ type: REVERSAL
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TR6tJC1MuHgr52KC2orx84oh
+ href: https://finix.sandbox-payments-api.com/transfers/TRtLhSEAHak7isKjZu9x7Gjh
parent:
href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
destination:
@@ -6923,39 +9088,43 @@ components:
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TR6tJC1MuHgr52KC2orx84oh/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRtLhSEAHak7isKjZu9x7Gjh/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- - id: TRpjXvjTV4cPwS7KkVJqN753
+ - id: TRrP7CFqBid1C8kYpBMbxz5q
+ created_at: '2022-09-09T12:32:07.42Z'
+ updated_at: '2022-09-09T12:32:16.39Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 100
- tags:
- test: refund
- state: SUCCEEDED
- trace_id: ef1b2012-2ae6-4013-8811-6ec23ead4b8c
- currency: USD
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
- ready_to_settle_at: '2022-08-12T04:00:00.00Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*DUNDER MIFFLIN
- type: REVERSAL
- messages: []
- raw: null
- created_at: '2022-08-12T22:17:51.46Z'
- updated_at: '2022-08-12T22:18:08.58Z'
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-09-09T12:32:16.40Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: refund
+ trace_id: 40087e2c-b65d-4407-a5cc-3259b788f6ac
+ type: REVERSAL
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRpjXvjTV4cPwS7KkVJqN753
+ href: https://finix.sandbox-payments-api.com/transfers/TRrP7CFqBid1C8kYpBMbxz5q
parent:
href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
destination:
@@ -6963,7 +9132,7 @@ components:
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRpjXvjTV4cPwS7KkVJqN753/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRrP7CFqBid1C8kYpBMbxz5q/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
_links:
@@ -6972,14 +9141,14 @@ components:
next:
href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=720&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=820&limit=20&sort=created_at,desc&sort=id,desc
parent:
href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP
page:
offset: 0
limit: 20
- count: 2
- unreversed_amount: 591654
+ count: 827
+ unreversed_amount: 580954
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -6990,51 +9159,92 @@ components:
Settlement:
description: '`Settlement` object.'
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Settlement'
examples:
Settlement:
value:
- id: STimypRqs5TXoCDRq2swMFUY
- application: APgPDQrLD52TYvqazjHJJchM
- tags: {}
- identity: IDgWxBhfGYLLdkhxx2ddYf9K
- currency: USD
- merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
+ id: STvUfBLbCUsun2KFoTuxR2j1
created_at: '2022-08-09T17:06:02.99Z'
updated_at: '2022-08-09T17:15:25.60Z'
- processor: DUMMY_V1
- type: MERCHANT_REVENUE
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
funds_flow: null
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
+ merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
+ net_amount: 2238357
payment_type: null
+ processor: DUMMY_V1
+ status: AWAITING_APPROVAL
+ tags: {}
total_amount: 2287662
- total_fees: 49305
total_fee: 49305
- net_amount: 2238357
- destination: null
- status: AWAITING_APPROVAL
+ total_fees: 49305
+ type: MERCHANT_REVENUE
_links:
self:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
funding_transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/funding_transfers
+ transfers:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers
+ fees:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=fee
+ reversals:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=reverse
+ credits:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=credit
+ debits:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=debit
+ disputes:
+ href: https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=dispute
+ Close Settlements:
+ value:
+ id: STdjQCfwwra8QBVZQhrfqdUt
+ created_at: '2023-06-06T22:35:07.98Z'
+ updated_at: '2023-06-06T22:35:16.69Z'
+ application: AP8Hb3WvAFQ2DUdqKJYszMo5
+ currency: USD
+ destination: null
+ funds_flow: null
+ identity: IDj6kvMbVaeSzxQK6g1eoKKo
+ merchant_id: MUuCjso38AtQoNgfDdmcZ8gx
+ net_amount: 131854
+ payment_type: null
+ processor: DUMMY_V1
+ status: AWAITING_APPROVAL
+ tags: {}
+ total_amount: 131854
+ total_fee: 0
+ total_fees: 0
+ type: MERCHANT_REVENUE
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/AP8Hb3WvAFQ2DUdqKJYszMo5
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDj6kvMbVaeSzxQK6g1eoKKo
+ funding_transfers:
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/funding_transfers
transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers
fees:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=fee
reversals:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=reverse
credits:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=credit
debits:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=debit
disputes:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=dispute
+ href: https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=dispute
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -7045,7 +9255,7 @@ components:
SettlementsList:
description: List of `Settlement` objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SettlementsList'
examples:
@@ -7053,96 +9263,131 @@ components:
value:
_embedded:
settlements:
- - id: STrYmJ27NeLqRfWSXVKJboNy
+ - id: ST7R7mHjHq3ywG4vGa9cYe9b
+ created_at: '2023-07-14T09:10:02.91Z'
+ updated_at: '2023-07-15T07:15:58.36Z'
application: APgPDQrLD52TYvqazjHJJchM
- tags:
- Internal Daily Settlement ID: 21DFASJSAKAS
- identity: IDuqZpDw28f2KK6YuDk4jNLg
currency: USD
- merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
- created_at: '2022-08-17T16:37:02.32Z'
- updated_at: '2022-08-17T16:39:04.98Z'
- processor: DUMMY_V1
- type: MERCHANT_REVENUE
+ destination: null
funds_flow: null
+ identity: IDvHGrfeVmB3i7uL78xjemNk
+ merchant_id: MU7cXuKj2xx41hhZZi6bZ13A
+ net_amount: 8329
payment_type: null
- total_amount: 100
- total_fees: 102
- total_fee: 102
- net_amount: -2
- destination: null
+ processor: DUMMY_V1
status: AWAITING_APPROVAL
+ tags: {}
+ total_amount: 9252
+ total_fee: 923
+ total_fees: 923
+ type: MERCHANT_REVENUE
_links:
self:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ href: https://finix.sandbox-payments-api.com/identities/IDvHGrfeVmB3i7uL78xjemNk
funding_transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/funding_transfers
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/funding_transfers
transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers
fees:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=fee
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=fee
reversals:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=reverse
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=reverse
credits:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=credit
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=credit
debits:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=debit
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=debit
disputes:
- href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=dispute
- - id: STimypRqs5TXoCDRq2swMFUY
+ href: https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=dispute
+ - id: SThN7W7iDZM4mhGXqPDaVojn
+ created_at: '2022-12-21T22:05:08.10Z'
+ updated_at: '2022-12-22T07:15:56.22Z'
application: APgPDQrLD52TYvqazjHJJchM
- tags: {}
- identity: IDuqZpDw28f2KK6YuDk4jNLg
currency: USD
+ destination: null
+ funds_flow: null
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
- created_at: '2022-08-09T17:06:02.99Z'
- updated_at: '2022-08-09T17:15:25.60Z'
+ net_amount: 648211
+ payment_type: null
processor: DUMMY_V1
+ status: AWAITING_APPROVAL
+ tags: {}
+ total_amount: 661854
+ total_fee: 13643
+ total_fees: 13643
type: MERCHANT_REVENUE
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ funding_transfers:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/funding_transfers
+ transfers:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers
+ fees:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=fee
+ reversals:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=reverse
+ credits:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=credit
+ debits:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=debit
+ disputes:
+ href: https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=dispute
+ - id: STsdvwKDyZq3gwZi5upuAETj
+ created_at: '2022-12-21T22:00:06.57Z'
+ updated_at: '2022-12-22T07:15:55.04Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
funds_flow: null
+ identity: IDvHGrfeVmB3i7uL78xjemNk
+ merchant_id: MU7cXuKj2xx41hhZZi6bZ13A
+ net_amount: 648811
payment_type: null
- total_amount: 2287662
- total_fees: 49305
- total_fee: 49305
- net_amount: 2238357
- destination: null
+ processor: DUMMY_V1
status: AWAITING_APPROVAL
+ tags: {}
+ total_amount: 662154
+ total_fee: 13343
+ total_fees: 13343
+ type: MERCHANT_REVENUE
_links:
self:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ href: https://finix.sandbox-payments-api.com/identities/IDvHGrfeVmB3i7uL78xjemNk
funding_transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/funding_transfers
transfers:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers
fees:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=fee
reversals:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=reverse
credits:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=credit
debits:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=debit
disputes:
- href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=dispute
+ href: https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=dispute
_links:
self:
- href: https://finix.sandbox-payments-api.com/settlements/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/settlements/
next:
- href: https://finix.sandbox-payments-api.com/settlements/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
- last:
- href: https://finix.sandbox-payments-api.com/settlements/?offset=460&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/settlements/?after_cursor=STsdvwKDyZq3gwZi5upuAETj
page:
- offset: 0
- limit: 20
- count: 2
+ limit: 100
+ next_cursor: STsdvwKDyZq3gwZi5upuAETj
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -7153,520 +9398,572 @@ components:
Transfer:
description: Single Transfer object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Transfer'
examples:
Transfer:
value:
- id: TRvypRNBeqM597Zi4DcqJ2Vh
+ id: TRhw2BGAqyFZcrjTYXq4qTvY
+ created_at: '2022-10-10T03:49:20.71Z'
+ updated_at: '2022-10-10T03:49:21.62Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 662154
- tags:
- test: sale
- state: PENDING
- trace_id: 61646f46-f3fb-4fba-baae-a875a8bdce72
- currency: USD
+ amount_requested: 662154
application: APgPDQrLD52TYvqazjHJJchM
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-01-27T07:37:09.71Z'
- updated_at: '2022-01-27T07:37:10.01Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: sale
+ trace_id: 9789aa49-23a5-47c5-9ca1-7492a582fcde
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh
+ href: https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRvypRNBeqM597Zi4DcqJ2Vh/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
fee_profile:
- href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
- Transfer (Debits a Bank Account):
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ Transfer - Debit Bank Account:
value:
- id: TRgqNR5Um4foo5Py6mZqNKKM
+ id: TRrfaQBfXkc4wopWK6pcrnoR
+ created_at: '2022-10-10T03:51:19.27Z'
+ updated_at: '2022-10-10T03:51:20.77Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 6031
- tags:
- order_number: 21DFASJSAKAS
- state: PENDING
- trace_id: 4a845f58-2234-4484-ad0c-5b716160cf56
- currency: USD
+ amount_requested: 6031
application: APgPDQrLD52TYvqazjHJJchM
- source: PIk3AG7aUSCyNgYpDwCKkwDC
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 603
- statement_descriptor: FNX*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-06-05T22:26:04.94Z'
- updated_at: '2022-06-05T22:26:05.42Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIr1Ru7ewBkEYVVn7SP1u5FW
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: e7f2e240-f6e5-41ef-a533-ed6c8ccf5222
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM
+ href: https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRgqNR5Um4foo5Py6mZqNKKM/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/disputes
source:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIr1Ru7ewBkEYVVn7SP1u5FW
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- Transfer (with 3D Secure):
+ Transfer - 3D Secure:
value:
- id: TRvRKrrAmWwFeVsnHbyfGiNi
+ id: TR7QJuf7mD6vSAmwHYbhVWem
+ created_at: '2022-10-10T03:47:09.23Z'
+ updated_at: '2022-10-10T03:47:10.06Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 92169
- tags:
- test: sale
- state: PENDING
- trace_id: 313424d6-229c-4d2e-952f-d0ec13786a1b
- currency: USD
+ amount_requested: 92169
application: APgPDQrLD52TYvqazjHJJchM
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-06-07T18:16:26.30Z'
- updated_at: '2022-06-07T18:16:26.90Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: sale
+ trace_id: 9d8052e9-2432-4117-aa57-d5ff0a7acecc
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi
+ href: https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRvRKrrAmWwFeVsnHbyfGiNi/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- Transfer (with Level 2 Processing):
+ Transfer - Level 2 Processing:
value:
- id: TRcSMjyDts3rafZt4BmBFNFU
+ id: TRfnDYRPA5cNN5nup9WWpavy
+ created_at: '2022-10-10T03:27:23.09Z'
+ updated_at: '2022-10-10T03:27:23.74Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 1000
- tags:
- test: sale
- state: PENDING
- trace_id: 68d2c3e1-3b43-4e9f-9dbd-d803c4629b5f
- currency: USD
+ amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-06-05T22:32:26.18Z'
- updated_at: '2022-06-05T22:32:26.56Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: sale
+ trace_id: 8356c796-90ea-43ed-9dba-7a31dd5d1a1c
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU
+ href: https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRcSMjyDts3rafZt4BmBFNFU/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- Transfer (with Level 3 Processing):
+ Transfer - Level 3 Processing:
value:
- id: TRnka9J9CD4cHv814R87C5g3
+ id: TRhNEVxYWDF97SEqBJHykPDH
+ created_at: '2022-10-10T03:42:15.11Z'
+ updated_at: '2022-10-10T03:42:15.68Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 1000
- tags:
- test: sale
- state: PENDING
- trace_id: 80e04d43-49ed-44de-a787-a548266d0503
- currency: USD
+ amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-06-05T22:34:34.64Z'
- updated_at: '2022-06-05T22:34:35.19Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: sale
+ trace_id: ce93f81e-187d-4d2a-b387-bb316f9efa9a
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3
+ href: https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- Refunded Transfer:
+ Refund Transfer:
value:
- id: TR5TXaE65eu2T9MAWDeNAJve
+ id: TRhLCS57STJRfpw2ZoRhSHf2
+ created_at: '2023-09-19T20:19:58.95Z'
+ updated_at: '2023-09-19T20:19:59.01Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ additional_purchase_data: null
+ address_verification: null
amount: 100
- tags:
- test: refund
- state: PENDING
- trace_id: cd753931-3a39-41b3-bacb-259ef78b3eda
- currency: USD
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*FINIX FLOWERS
- type: REVERSAL
- messages: []
- raw: null
- created_at: '2022-06-05T22:46:03.61Z'
- updated_at: '2022-06-05T22:46:03.74Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ parent_transfer: TRr3Rd7Sy7zbrsWAH7Jwo7vt
+ parent_transfer_trace_id: null
+ raw: null
+ ready_to_settle_at: null
+ receipt_last_printed_at: null
+ security_code_verification: null
+ source: null
+ split_transfers: []
+ state: PENDING
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ test: refund
+ trace_id: 4ec8b76b-c615-455d-ba78-c03f0f480b4a
+ type: REVERSAL
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TR5TXaE65eu2T9MAWDeNAJve
+ href: https://finix.sandbox-payments-api.com/transfers/TRhLCS57STJRfpw2ZoRhSHf2
parent:
- href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3
+ href: https://finix.sandbox-payments-api.com/transfers/TRr3Rd7Sy7zbrsWAH7Jwo7vt
destination:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TR5TXaE65eu2T9MAWDeNAJve/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRhLCS57STJRfpw2ZoRhSHf2/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- Transfer (Created with an EMV Card):
+ Card Present Transfer - EMV Card:
value:
- id: TRkLSjfcwbxUUsXhmdxKxhMd
+ id: TRtC5R4pnKkLj8hcLpgFivoS
+ created_at: '2022-10-10T06:07:52.01Z'
+ updated_at: '2022-10-10T06:07:53.01Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 150
- tags:
- order_number: chris123transfer
- state: SUCCEEDED
- trace_id: FNXkKp3o2hRyp82hcjWQt2uJ1
- currency: USD
+ amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
- source: PIi4GW7Grt5PMyAAVWBhShrw
+ card_present_details:
+ emv_data: null
+ masked_account_number: null
+ name: null
+ brand: null
+ entry_mode: null
+ payment_type: NONE
+ approval_code: null
+ currency: USD
destination: null
- ready_to_settle_at: null
+ device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FIN*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- card_present_details:
- emv_data:
- application_identifier: A0000000031010
- application_label: Visa Credit
- application_preferred_name: null
- application_transaction_counter: '004F'
- cryptogram: TC F8C706E8A0368D15
- issuer_code_table_index: null
- pin_verified: false
- masked_account_number: '************7564'
- name: 'AARON/CHRISTOPHER W '
- brand: VISA
- entry_mode: CHIP_ENTRY
- payment_type: CREDIT
- approval_code: '000036'
- created_at: '2022-06-05T22:48:32.44Z'
- updated_at: '2022-06-05T22:48:33.66Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
+ messages: null
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PI64EnboFzoZNFkBUHbgVDa2
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FIN*GOLDS GYM
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ order_number: chris123transfer
+ trace_id: FNXsK76MxJWPkbGqpKymgkzK
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd
+ href: https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRkLSjfcwbxUUsXhmdxKxhMd/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/disputes
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
- Transfer (Created with a Non-EMV Card):
+ Card Present Transfer - Non-EMV Card:
value:
- id: TRhQxafAW3W69mccPi42mFF
+ id: TRhzZurepF7DwpL3REV5jU2T
+ created_at: '2022-10-10T06:12:31.55Z'
+ updated_at: '2022-10-10T06:12:33.09Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 150
- tags:
- order_number: chris123transfer
- state: SUCCEEDED
- trace_id: FNXgKMsxN9Uv5nyPh9YLsjur4
- currency: USD
+ amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
- source: PIGBpNc9u2nLDDqUprwyrgA
+ card_present_details:
+ emv_data: null
+ masked_account_number: null
+ name: null
+ brand: null
+ entry_mode: null
+ payment_type: NONE
+ approval_code: null
+ currency: USD
destination: null
- ready_to_settle_at: null
+ device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FIN*FINIX FLOWERS
- type: DEBIT
- messages:
- - Unable to find PIN pad with laneId 1
- raw: null
- card_present_details:
- emv_data: null
- masked_account_number: '************0011'
- name: TEST/WORLDPAY
- brand: UNKNOWN
- entry_mode: SWIPED
- payment_type: CREDIT
- approval_code: '000004'
- created_at: '2022-06-05T22:51:17.25Z'
- updated_at: '2022-06-05T22:51:18.41Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
+ messages: null
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PI6SBgTQipPQa3ZpDe27Fbym
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FIN*GOLDS GYM
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ order_number: chris123transfer
+ trace_id: FNXkc963gjMZh8eLfgSHWmgHz
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF
+ href: https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRhQxafAW3W69mccPi42mFF/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/disputes
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
- Transfer (Created via Manual Entry):
+ Card Present Transfer - Manual Entry:
value:
- id: TRifUPGv1R74gtM4L9EUzfiB
+ id: TRi5vEeiCojkBCnvq8AD3HGm
+ created_at: '2022-10-10T03:20:50.29Z'
+ updated_at: '2022-10-10T03:20:51.71Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 150
- tags:
- order_number: chris123transfer
- state: SUCCEEDED
- trace_id: FNXhci8o1op8FvZoMmqUQjpAH
- currency: USD
+ amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
- source: PIhE1mNrA6g4FiVpjqC1PT6n
+ card_present_details:
+ emv_data: null
+ masked_account_number: null
+ name: null
+ brand: null
+ entry_mode: null
+ payment_type: NONE
+ approval_code: null
+ currency: USD
destination: null
- ready_to_settle_at: null
+ device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FIN*FINIX FLOWERS
- type: DEBIT
- messages: []
- raw: null
- card_present_details:
- emv_data: null
- masked_account_number: '************0006'
- name: ''
- brand: VISA
- entry_mode: MANUAL_KEY_ENTRY
- payment_type: CREDIT
- approval_code: '000059'
- created_at: '2022-06-05T22:55:07.76Z'
- updated_at: '2022-06-05T22:55:08.89Z'
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
+ messages: null
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PI9D3HHedxWzCaadkGqrX2t1
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FIN*GOLDS GYM
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ order_number: chris123transfer
+ trace_id: FNXbAn8pqY7Pb2238uTFcdAiN
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB
+ href: https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/payment_instruments
reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/reversals
+ href: https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/reversals
fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/fees
+ href: https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/fees
disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/disputes
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
- Card Present Transfer Refunded:
+ Refund Transfer - Card Present:
value:
- id: TRkWoMAdBwfVgYQpL8csYbtH
+ id: TRpc9StVytskqYnWoF2Ho8pK
+ created_at: '2022-10-10T03:17:34.57Z'
+ updated_at: '2022-10-10T03:17:35.83Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 150
- tags: {}
- state: SUCCEEDED
- trace_id: FNXhYDzG8GLyL2gmE77Ygnjai
+ amount_requested: 150
+ application: APeUbTUjvYb1CdPXvNcwW1wP
+ card_present_details:
+ emv_data: null
+ masked_account_number: null
+ name: null
+ brand: null
+ entry_mode: null
+ payment_type: NONE
+ approval_code: null
currency: USD
- application: APuZMfMerci2JuLUs7xWpf5G
- source: null
- destination: PIp89SyE68fV5rxRCZUJz39c
- ready_to_settle_at: null
+ destination: PInUwPXf1MYj7xJ8jfmdksa5
+ device: DVtk6E4eWHsMzgZXvFaaUigM
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNXQA*FINIX FLOWERSS
- type: REVERSAL
- messages: []
- raw: null
- created_at: '2022-06-05T22:55:07.76Z'
- updated_at: '2022-06-05T22:55:08.89Z'
idempotency_id: null
- merchant_identity: ID8W4rxaFN8HsxqugmesLMVo
- device: DVkBqa68V1ZQusodU8o6mB62
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
+ messages: null
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: null
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FIN*GOLDS GYM
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: FNXkYuDrPQxzpNk5xtGhXSyU8
+ type: REVERSAL
_links:
application:
- href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G
+ href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH
+ href: https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK
+ parent:
+ href: https://finix.sandbox-payments-api.com/transfers/TRn9pzzn1NVLdwwBwVrqSwAX
+ destination:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PInUwPXf1MYj7xJ8jfmdksa5
merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo
- device:
- href: https://finix.sandbox-payments-api.com/devices/DVkBqa68V1ZQusodU8o6mB62
+ href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRifUPGv1R74gtM4L9EUzfiB/payment_instruments
- reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/reversals
- fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/fees
- disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRkWoMAdBwfVgYQpL8csYbtH/disputes
+ href: https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
- Swiped Card Transfer Refunded:
+ Refund Transfer - Swiped Card:
value:
id: TR3vLiG6wecEwY3TC3oQiudG
+ created_at: '2019-04-24T19:19:34.11Z'
+ updated_at: '2019-04-24T19:19:48.09Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 100
- tags:
- order_number: testing123
- state: SUCCEEDED
- trace_id: FNXgm7zyjYEmYwUQ3fktSTkaZ
- currency: USD
+ amount_requested: 100
application: APuZMfMerci2JuLUs7xWpf5G
- source: null
- destination: PIiPybsvUSM4fN8sYaMS3qXg
- ready_to_settle_at: null
- externally_funded: UNKNOWN
- fee: 0
- statement_descriptor: FNXQA*FINIX FLOWERS
- type: CREDIT
- messages: []
- raw: null
card_present_details:
emv_data: null
masked_account_number: '************0006'
@@ -7675,68 +9972,310 @@ components:
entry_mode: SWIPED
payment_type: CREDIT
approval_code: '000019'
- created_at: '2022-06-05T22:55:07.76Z'
- updated_at: '2022-06-05T22:55:08.89Z'
+ currency: USD
+ destination: PIiPybsvUSM4fN8sYaMS3qXg
+ device: DVsEanpBtsAVvCHbNXkFaH6f
+ externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
+ fee: 0
idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
+ messages: null
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: null
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNXQA*FINIX FLOWERS
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags:
+ order_number: testing123
+ trace_id: FNXgm7zyjYEmYwUQ3fktSTkaZ
+ type: REVERSAL
_links:
application:
- href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G
+ href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
self:
href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG
- merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo
- device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/payment_instruments
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
+ device:
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
reversals:
href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/reversals
fees:
href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/fees
disputes:
href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/disputes
- fee_profile:
- href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx
- Transfer (with Buyer Charges):
+ destination:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIiPybsvUSM4fN8sYaMS3qXg
+ Transfer - Buyer Charges:
value:
- id: AUpaSunWzKyq73A6DKyZ3g8f
+ id: TRwsaGmWDvcg6sgRACsxoRFa
+ created_at: '2022-10-11T03:22:40.87Z'
+ updated_at: '2022-10-11T03:22:41.54Z'
+ additional_buyer_charges:
+ convenience_amount: 300
+ rent_surcharge_amount: 0
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 10000
+ amount_requested: 10000
application: APgPDQrLD52TYvqazjHJJchM
- amount: 5200
+ currency: USD
+ destination: null
+ externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
+ subtype: API
tags:
test: sale
- state: SUCCEEDED
+ trace_id: fe1337e5-4608-4038-bc5a-675dee6ab0db
+ type: DEBIT
+ _links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TRwsaGmWDvcg6sgRACsxoRFa
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRwsaGmWDvcg6sgRACsxoRFa/payment_instruments
+ reversals:
+ href: https://finix.sandbox-payments-api.com/transfers/TRwsaGmWDvcg6sgRACsxoRFa/reversals
+ fees:
+ href: https://finix.sandbox-payments-api.com/transfers/TRwsaGmWDvcg6sgRACsxoRFa/fees
+ disputes:
+ href: https://finix.sandbox-payments-api.com/transfers/TRwsaGmWDvcg6sgRACsxoRFa/disputes
+ source:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ Transfer - HSA or FSA Cards:
+ value:
+ id: TR8bRJ22SBReMehVQMVAbRpr
+ created_at: '2022-10-10T06:31:52.37Z'
+ updated_at: '2022-10-10T06:31:53.12Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 950
+ amount_requested: 950
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: null
+ destination: null
+ externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-08-01T19:40:17.99Z'
- updated_at: '2022-08-01T19:40:18.16Z'
- trace_id: 767f5042-49ab-48f3-b6ce-5c7c1bbe4b39
+ ready_to_settle_at: null
+ security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
- void_state: UNATTEMPTED
- expires_at: '2022-08-08T19:40:17.99Z'
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
+ subtype: API
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: ea7c2b3e-bef7-45c5-aac3-76c94e25cb65
+ type: DEBIT
+ _links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/payment_instruments
+ reversals:
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/reversals
+ fees:
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/fees
+ disputes:
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/disputes
+ source:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ Transfer - Card Verification Checks:
+ value:
+ id: TR61nQ89c8U5i7uAvwmSuLnv
+ created_at: '2022-10-11T03:24:04.67Z'
+ updated_at: '2022-10-11T03:24:05.47Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 662154
+ amount_requested: 662154
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
+ fee: 0
idempotency_id: null
- additional_buyer_charges:
- convenience_amount: 100
- rent_surcharge_amount: 200
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
+ subtype: API
+ tags: {}
+ trace_id: cc2e9d44-c87d-4cb2-bb2f-b7be2eea9afa
+ type: DEBIT
+ _links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/payment_instruments
+ reversals:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/reversals
+ fees:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/fees
+ disputes:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/disputes
+ source:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ Transfer - Split Transaction:
+ value:
+ id: TRmCUZEnXF3BAr4uUKG5YVcW
+ created_at: '2023-07-25T23:33:26.16Z'
+ updated_at: '2023-07-25T23:33:27.99Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 1000
+ amount_requested: 1000
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: UNKNOWN
failure_code: null
failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ receipt_last_printed_at: null
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ split_transfers:
+ - split_transfer_mDDBJcdfbvZQD5KbfdnECV
+ - split_transfer_mDEEvWVsk3b963EhZha52k
+ - split_transfer_mDEEXLvLihTL24iGdLWwbb
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
+ subtype: API
+ tags:
+ test: sale
+ trace_id: db85490a-7fbe-4e10-9edd-13e39f930ddf
+ type: DEBIT
_links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUpaSunWzKyq73A6DKyZ3g8f
+ href: https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/payment_instruments
+ reversals:
+ href: https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/reversals
+ fees:
+ href: https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/fees
+ disputes:
+ href: https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/disputes
+ source:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ Refund Transfer - Split Transaction:
+ value:
+ id: TRm23kdc4SCxYyva47RyiZv
+ created_at: '2023-07-19T03:02:02.89Z'
+ updated_at: '2023-07-19T03:02:03.01Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 1000
+ amount_requested: 1000
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: PIe2YvpcjvoVJ6PzoRPBK137
+ externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ receipt_last_printed_at: null
+ security_code_verification: null
+ source: null
+ split_transfers:
+ - split_transfer_m7Y8kgx4nunsrVbuMdedDo
+ - split_transfer_m7Yct9DmD5ctdWxDTAZjPc
+ - split_transfer_m7YcD9mGG92oqxPPDhE23U
+ state: PENDING
+ statement_descriptor: FNX*DUNDER MIFFLIN
+ subtype: API
+ tags:
+ test: refund
+ trace_id: d1c14ed9-1945-4cef-b0f8-c1d8ba037a86
+ type: REVERSAL
+ _links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TRm23kdc4SCxYyva47RyiZv
+ parent:
+ href: https://finix.sandbox-payments-api.com/transfers/TR7h8NxhCDHunLFdJ1HCLp4r
+ destination:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRm23kdc4SCxYyva47RyiZv/payment_instruments
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -7747,7 +10286,7 @@ components:
TransfersList:
description: List of Transfer objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/TransfersList'
examples:
@@ -7755,87 +10294,88 @@ components:
value:
_embedded:
transfers:
- - id: TRw4MuMkkAZbRJC7362mF1qY
- amount: 123
- tags: {}
- state: FAILED
- trace_id: 61f0192a-d5e3-4b96-8220-60e63fd45605
- currency: USD
+ - id: TRvQN3v5mhA2Ttc78hzjLV3j
+ created_at: '2022-10-11T03:25:04.79Z'
+ updated_at: '2022-10-11T03:25:04.79Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 13243
+ amount_requested: 13243
application: APgPDQrLD52TYvqazjHJJchM
- source: PIdxgKpYuMX3DtnDk3Pes2JK
+ currency: USD
destination: null
- ready_to_settle_at: null
- externally_funded: UNKNOWN
+ externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*DUNDER MIFFLIN
- type: DEBIT
- messages:
- - RAW MESSAGE
- raw: null
- created_at: '2022-08-17T22:08:21.39Z'
- updated_at: '2022-08-17T22:09:01.30Z'
+ fee_type: CARD_BASIS_POINTS
idempotency_id: null
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- subtype: API
- failure_code: GENERIC_DECLINE
- failure_message: The card was declined for an unknown reason.
- The cardholder needs to contact their issuer for more information.
- additional_buyer_charges: null
+ merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-10-11T03:25:05.32Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: null
+ subtype: PLATFORM_FEE
+ tags: {}
+ trace_id: 611dcc5f-0622-4ec7-8c8b-b08896456d62
+ type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY
+ href: https://finix.sandbox-payments-api.com/transfers/TRvQN3v5mhA2Ttc78hzjLV3j
merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/payment_instruments
- reversals:
- href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/reversals
- fees:
- href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/fees
- disputes:
- href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/disputes
- source:
- href: https://finix.sandbox-payments-api.com/payment_instruments/PIdxgKpYuMX3DtnDk3Pes2JK
+ href: https://finix.sandbox-payments-api.com/transfers/TRvQN3v5mhA2Ttc78hzjLV3j/payment_instruments
+ parent:
+ href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- - id: TR4MCT6kZGm5z7BeZu6HQCeq
- amount: 13
- tags: {}
- state: SUCCEEDED
- trace_id: a4a807fe-dc25-482d-8fc0-bee7535ed4b6
- currency: USD
+ - id: TR34MdY6eagpEqhtTaP8EBCR
+ created_at: '2022-10-10T06:32:04.58Z'
+ updated_at: '2022-10-10T06:32:04.58Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 19
+ amount_requested: 19
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: null
- ready_to_settle_at: '2022-08-16T19:00:01.11Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: null
- type: FEE
fee_type: CARD_BASIS_POINTS
- messages: []
- raw: null
- created_at: '2022-08-16T18:46:04.34Z'
- updated_at: '2022-08-16T18:46:04.34Z'
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-10-10T06:32:05.05Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: null
subtype: PLATFORM_FEE
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: a79105c7-8b93-4c36-8734-83f02ca0686c
+ type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
- href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq
+ href: https://finix.sandbox-payments-api.com/transfers/TR34MdY6eagpEqhtTaP8EBCR
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
- href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq/payment_instruments
+ href: https://finix.sandbox-payments-api.com/transfers/TR34MdY6eagpEqhtTaP8EBCR/payment_instruments
parent:
- href: https://finix.sandbox-payments-api.com/transfers/TRi3agaoYJQoS9wFXenMRgA1
+ href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
_links:
@@ -7844,39 +10384,42 @@ components:
next:
href: https://finix.sandbox-payments-api.com/transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/transfers?offset=21140&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/transfers?offset=23980&limit=20&sort=created_at,desc&sort=id,desc
page:
- offset: 0
- limit: 20
- count: 2
+ limit: 100
+ next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
List of Settlement Funding Transfers:
value:
_embedded:
transfers:
- id: TRkwxPhCf3qChKFEVGhDjr76
- amount: 102
- tags: {}
- state: FAILED
- trace_id: d4a6df17-f581-42d0-ac70-ad6770acd5c4
- currency: USD
+ created_at: '2022-08-12T21:46:12.97Z'
+ updated_at: '2022-08-12T21:47:06.65Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 102
+ amount_requested: 102
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: PIrFpayBAQcqK35HMQgRfaqD
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: null
- type: CREDIT
- messages: []
- raw: null
- created_at: '2022-08-12T21:46:12.97Z'
- updated_at: '2022-08-12T21:47:06.65Z'
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: null
+ state: FAILED
+ statement_descriptor: null
subtype: SETTLEMENT_PLATFORM
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: d4a6df17-f581-42d0-ac70-ad6770acd5c4
+ type: CREDIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -7895,29 +10438,33 @@ components:
destination:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrFpayBAQcqK35HMQgRfaqD
- id: TRxb61dJ6PvGcvyS2L2B9SZE
+ created_at: '2022-08-12T21:46:12.98Z'
+ updated_at: '2022-08-12T21:47:05.26Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 2
- tags: {}
- state: SUCCEEDED
- trace_id: e192bc39-0909-4da9-b4c2-022a84ae3984
- currency: USD
+ amount_requested: 2
application: APgPDQrLD52TYvqazjHJJchM
- source: PIm8mdyYcEnYAZLLyw8g59Pw
+ currency: USD
destination: null
- ready_to_settle_at: null
externally_funded: UNKNOWN
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: null
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-08-12T21:46:12.98Z'
- updated_at: '2022-08-12T21:47:05.26Z'
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: null
+ security_code_verification: null
+ source: PIm8mdyYcEnYAZLLyw8g59Pw
+ state: SUCCEEDED
+ statement_descriptor: null
subtype: SETTLEMENT_MERCHANT
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: e192bc39-0909-4da9-b4c2-022a84ae3984
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -7939,38 +10486,41 @@ components:
self:
href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
- offset: 0
- limit: 20
- count: 2
+ limit: 100
+ next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
List of Settlement Transfers:
value:
_embedded:
transfers:
- id: TR8yiKY6ju988aUZhfqJFjag
+ created_at: '2022-08-12T16:56:01.90Z'
+ updated_at: '2022-08-12T16:56:01.90Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 100
- tags: {}
- state: SUCCEEDED
- trace_id: 272fe816-2dd1-46ed-a7e7-9041d7a8f0ff
- currency: USD
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: null
- ready_to_settle_at: '2022-08-12T22:15:02.69Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: null
- type: FEE
fee_type: CARD_FIXED
- messages: []
- raw: null
- created_at: '2022-08-12T16:56:01.90Z'
- updated_at: '2022-08-12T16:56:01.90Z'
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-08-12T22:15:02.69Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: null
subtype: PLATFORM_FEE
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: 272fe816-2dd1-46ed-a7e7-9041d7a8f0ff
+ type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -7985,29 +10535,33 @@ components:
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- id: TRm9ppvqX43CbwmNzhckf2gb
+ created_at: '2022-08-12T16:55:47.66Z'
+ updated_at: '2022-08-12T16:56:02.19Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 100
- tags: {}
- state: SUCCEEDED
- trace_id: 381f1f6f-492b-4101-9a57-40001a59813a
- currency: USD
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- source: PIe2YvpcjvoVJ6PzoRPBK137
+ currency: USD
destination: null
- ready_to_settle_at: '2022-08-12T04:00:00.00Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: FNX*DUNDER MIFFLIN
- type: DEBIT
- messages: []
- raw: null
- created_at: '2022-08-12T16:55:47.66Z'
- updated_at: '2022-08-12T16:56:02.19Z'
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-08-12T04:00:00.00Z'
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ state: SUCCEEDED
+ statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: 381f1f6f-492b-4101-9a57-40001a59813a
+ type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -8028,30 +10582,34 @@ components:
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- id: TRwgubpxAJWbaDZE1kKP6SSi
+ created_at: '2022-08-12T16:56:01.90Z'
+ updated_at: '2022-08-12T16:56:01.90Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 2
- tags: {}
- state: SUCCEEDED
- trace_id: 5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385
- currency: USD
+ amount_requested: 2
application: APgPDQrLD52TYvqazjHJJchM
- source: null
+ currency: USD
destination: null
- ready_to_settle_at: '2022-08-12T22:15:02.69Z'
externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
fee: 0
- statement_descriptor: null
- type: FEE
fee_type: CARD_BASIS_POINTS
- messages: []
- raw: null
- created_at: '2022-08-12T16:56:01.90Z'
- updated_at: '2022-08-12T16:56:01.90Z'
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-08-12T22:15:02.69Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: null
subtype: PLATFORM_FEE
- failure_code: null
- failure_message: null
- additional_buyer_charges: null
+ tags: {}
+ trace_id: 5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385
+ type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
@@ -8069,9 +10627,108 @@ components:
self:
href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
- offset: 0
- limit: 20
- count: 3
+ limit: 100
+ next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
+ List of Split Transfer Fees:
+ value:
+ _embedded:
+ transfers:
+ - id: TRf75ZVCM1M4eVojmVYGUnuQ
+ created_at: '2023-07-19T02:30:17.43Z'
+ updated_at: '2023-07-19T02:30:17.43Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 30
+ amount_requested: 30
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
+ fee: 0
+ fee_type: CARD_FIXED
+ idempotency_id: null
+ merchant: MU4jpoNGRkAyjBxumZhGa6Hc
+ merchant_identity: IDhCtMvcteDx37eD9m4rmdKd
+ messages: []
+ raw: null
+ ready_to_settle_at: '2023-07-19T07:30:01.27Z'
+ receipt_last_printed_at: null
+ security_code_verification: null
+ source: null
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: null
+ subtype: PLATFORM_FEE
+ tags: {}
+ trace_id: 2c56f4f0-1f48-451c-9498-199daaff2e39
+ type: FEE
+ _links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ
+ parent:
+ href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ/payment_instruments
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
+ - id: TR4AyjeiKwML2rZ6fWyVaQST
+ created_at: '2023-07-19T02:30:17.43Z'
+ updated_at: '2023-07-19T02:30:17.43Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 17
+ amount_requested: 17
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
+ fee: 0
+ fee_type: CARD_BASIS_POINTS
+ idempotency_id: null
+ merchant: MU4jpoNGRkAyjBxumZhGa6Hc
+ merchant_identity: IDhCtMvcteDx37eD9m4rmdKd
+ messages: []
+ raw: null
+ ready_to_settle_at: '2023-07-19T07:30:01.27Z'
+ receipt_last_printed_at: null
+ security_code_verification: null
+ source: null
+ split_transfers: null
+ state: SUCCEEDED
+ statement_descriptor: null
+ subtype: PLATFORM_FEE
+ tags: {}
+ trace_id: 48a6fa39-5639-4e2c-b316-fad2db170954
+ type: FEE
+ _links:
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST
+ parent:
+ href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST/payment_instruments
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q/fees
+ page:
+ limit: 100
+ next_cursor: TR4AyjeiKwML2rZ6fWyVaQST
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -8082,20 +10739,21 @@ components:
User:
description: Single `User` object.
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/User'
examples:
ROLE_PARTNER User:
value:
id: USvVu9MXHz7hVzwDXwbx3UCL
- password: null
- identity: IDpYDM7J9n57q849o9E9yNrG
- enabled: true
- role: ROLE_MERCHANT
- tags: {}
created_at: '2022-01-27T07:37:14.65Z'
updated_at: '2022-01-27T07:37:15.47Z'
+ enabled: true
+ identity: IDpYDM7J9n57q849o9E9yNrG
+ password: null
+ role: ROLE_MERCHANT
+ tags:
+ card_name: New Employee
_links:
self:
href: https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL
@@ -8113,7 +10771,7 @@ components:
UsersList:
description: List of `User` objects.
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/UsersList'
examples:
@@ -8121,58 +10779,43 @@ components:
value:
_embedded:
users:
- - id: USweC2ufdBEYxpvPuF3G3LUE
- password: null
- identity: ID5UsJr9TVJd6cqAA4CCBc9T
+ - id: USsRhsHYZGBPnQw8CByJyEQW
+ created_at: '2022-01-27T07:36:32.91Z'
+ updated_at: '2022-01-27T07:36:33.78Z'
enabled: true
- role: ROLE_PARTNER
- tags: {}
- created_at: '2021-10-04T17:46:08.78Z'
- updated_at: '2021-10-04T17:46:09.44Z'
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/users/USweC2ufdBEYxpvPuF3G3LUE
- applications:
- href: https://finix.sandbox-payments-api.com/applications
- application:
- href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
- - id: USwybTufQYV51Nhbr4qf9qcM
+ identity: IDuquemzE7UkUJioGJfVKBKt
password: null
- identity: ID5UsJr9TVJd6cqAA4CCBc9T
- enabled: true
role: ROLE_PARTNER
tags: {}
- created_at: '2021-10-04T17:46:13.13Z'
- updated_at: '2021-10-04T17:46:13.13Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/users/USwybTufQYV51Nhbr4qf9qcM
+ href: https://finix.sandbox-payments-api.com/users/USsRhsHYZGBPnQw8CByJyEQW
applications:
href: https://finix.sandbox-payments-api.com/applications
application:
- href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
- - id: USNQbJQhBkoH59pYgfrUN2u
- password: null
- identity: ID6tqssazVPSSzEuVCBjQsoL
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ - id: USjDY98nG9tn5n271vwNcNc9
+ created_at: '2022-10-11T04:45:54.56Z'
+ updated_at: '2022-10-11T04:45:54.56Z'
enabled: true
- role: ROLE_MERCHANT
+ identity: IDuquemzE7UkUJioGJfVKBKt
+ password: null
+ role: ROLE_PARTNER
tags: {}
- created_at: '2021-10-04T17:46:38.46Z'
- updated_at: '2021-10-04T17:46:39.04Z'
_links:
self:
- href: https://finix.sandbox-payments-api.com/users/USNQbJQhBkoH59pYgfrUN2u
+ href: https://finix.sandbox-payments-api.com/users/USjDY98nG9tn5n271vwNcNc9
applications:
href: https://finix.sandbox-payments-api.com/applications
application:
- href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
_links:
self:
- href: https://finix.sandbox-payments-api.com/users/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/users?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 3
+ count: 8
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -8183,34 +10826,100 @@ components:
Verification:
description: Single Verification object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Verification'
examples:
- Verification:
+ "Payment Instrument - Verify a Card\u2019s CVV":
value:
- id: VIioiAQWmoT6b6p6mqSggKvA
+ id: VIvZKP8XKzxyJaxJsfAEHbw6
+ created_at: '2022-10-11T00:46:48.68Z'
+ updated_at: '2022-10-11T00:46:48.72Z'
application: APgPDQrLD52TYvqazjHJJchM
- tags:
- key_2: value_2
+ identity: null
+ merchant: MUgWbPVvtKbzjKNNGKqdQYV7
+ merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
messages: []
- raw: RawDummyMerchantUnderwriteResult
+ payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
+ payment_instrument_verification_details:
+ push_to_card_domestic: NOT_SUPPORTED
+ push_to_card_cross_border: NOT_SUPPORTED
+ card_type: CREDIT
+ billing_currency: USD
+ issuer_country: USA
processor: DUMMY_V1
+ raw: RawDummyMerchantUnderwriteResult
state: SUCCEEDED
- created_at: '2022-08-17T20:33:34.25Z'
- updated_at: '2022-08-17T20:34:01.49Z'
- trace_id: 31740c79-7e23-4301-bfa1-fb4f0950b9e4
- payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
- merchant: MUmUL7aBsHkxVLQawJxEXw6N
- identity: null
- merchant_identity: IDrH4G2VTfNjn1VFkvhcyMYj
+ tags:
+ card_name: Personal Card
+ trace_id: a7355d05-95b0-4b44-938d-bf0a99f19c17
_links:
self:
- href: https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4
+ href: https://finix.sandbox-payments-api.com/verifications/VIvZKP8XKzxyJaxJsfAEHbw6
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- identity:
- href: https://finix.sandbox-payments-api.com/identities/IDnDkihVYnsnsuAJDGG7im9t
+ merchant:
+ href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
+ "Payment Instrument - Verify a Card\u2019s Address":
+ value:
+ id: VI46ua15as1tnsWgZCFmdF9F
+ created_at: '2023-02-25T20:00:33.94Z'
+ updated_at: '2023-02-25T20:01:22.34Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ identity: null
+ merchant: MUgWbPVvtKbzjKNNGKqdQYV7
+ merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
+ messages: []
+ payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
+ payment_instrument_verification_details:
+ push_to_card_domestic: NOT_SUPPORTED
+ push_to_card_cross_border: NOT_SUPPORTED
+ card_type: CREDIT
+ billing_currency: USD
+ issuer_country: USA
+ processor: DUMMY_V1
+ raw: RawDummyMerchantUnderwriteResult
+ state: SUCCEEDED
+ tags:
+ card_name: Personal Card
+ trace_id: 3374bc71-d43b-4af4-b1f8-7719a2a9e320
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/verifications/VI46ua15as1tnsWgZCFmdF9F
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ merchant:
+ href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
+ Payment Instrument - Verify Push-to-Card Eligibility:
+ value:
+ id: VI8fgzLc9BnY1A996vPcWnu1
+ created_at: '2023-01-01T10:51:06.18Z'
+ updated_at: '2023-01-01T10:52:15.97Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ identity: null
+ merchant: MUgWbPVvtKbzjKNNGKqdQYV7
+ merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK
+ messages: []
+ payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
+ payment_instrument_verification_details:
+ push_to_card_domestic: FAST_FUNDS
+ push_to_card_cross_border: NOT_SUPPORTED
+ card_type: CREDIT
+ billing_currency: USD
+ issuer_country: USA
+ processor: DUMMY_V1
+ raw: RawDummyMerchantUnderwriteResult
+ state: SUCCEEDED
+ tags:
+ card_name: Personal Card
+ trace_id: '05886388-bcb3-479f-ac31-e5404a92e1ab'
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/verifications/VI8fgzLc9BnY1A996vPcWnu1
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ merchant:
+ href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -8221,7 +10930,7 @@ components:
VerificationsList:
description: List of Verification objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/VerificationsList'
examples:
@@ -8230,19 +10939,19 @@ components:
_embedded:
verifications:
- id: VInHzhoRAnAizVU7jcj2K6bX
+ created_at: '2022-08-15T23:12:56.40Z'
+ updated_at: '2022-08-15T23:12:56.85Z'
application: APgPDQrLD52TYvqazjHJJchM
- tags: {}
+ identity: null
+ merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
+ merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
messages: []
- raw: RawDummyMerchantUnderwriteResult
+ payment_instrument: null
processor: DUMMY_V1
+ raw: RawDummyMerchantUnderwriteResult
state: SUCCEEDED
- created_at: '2022-08-15T23:12:56.40Z'
- updated_at: '2022-08-15T23:12:56.85Z'
+ tags: {}
trace_id: 1c8fb49d-6f1c-40a0-8646-1bcb88047583
- payment_instrument: null
- merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
- identity: null
- merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
_links:
self:
href: https://finix.sandbox-payments-api.com/verifications/VInHzhoRAnAizVU7jcj2K6bX
@@ -8251,20 +10960,20 @@ components:
merchant:
href: https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj
- id: VIdS8qSW3kZbnK9AsFHJZ81U
+ created_at: '2022-08-15T23:12:54.32Z'
+ updated_at: '2022-08-15T23:12:54.65Z'
application: APgPDQrLD52TYvqazjHJJchM
- tags:
- key: value_2
+ identity: null
+ merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
+ merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
messages: []
- raw: RawDummyMerchantUnderwriteResult
+ payment_instrument: null
processor: DUMMY_V1
+ raw: RawDummyMerchantUnderwriteResult
state: SUCCEEDED
- created_at: '2022-08-15T23:12:54.32Z'
- updated_at: '2022-08-15T23:12:54.65Z'
+ tags:
+ key: value_2
trace_id: 4d12cbe6-032d-4e9d-8291-ce16f4add412
- payment_instrument: null
- merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
- identity: null
- merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
_links:
self:
href: https://finix.sandbox-payments-api.com/verifications/VIdS8qSW3kZbnK9AsFHJZ81U
@@ -8284,9 +10993,15 @@ components:
_embedded:
verifications:
- id: VIixxYGRVewLFa3GqSzqKPbw
+ created_at: '2022-02-04T18:33:14.50Z'
+ updated_at: '2022-02-04T18:33:15.69Z'
application: AP83dL8NE1Q7KfQo9onGg76M
- tags: {}
+ identity: null
+ merchant: null
+ merchant_identity: null
messages: []
+ payment_instrument: PImc5nvdnp15atLxEBAGtxJs
+ processor: VISA_V1
raw:
validation_details:
systems_trace_audit_number: '203518208518'
@@ -8310,15 +11025,9 @@ components:
push_funds_block_indicator: C
online_gambing_block_indicator: N
ppgs_network_info: []
- processor: VISA_V1
state: SUCCEEDED
- created_at: '2022-02-04T18:33:14.50Z'
- updated_at: '2022-02-04T18:33:15.69Z'
+ tags: {}
trace_id: '203518208518'
- payment_instrument: PImc5nvdnp15atLxEBAGtxJs
- merchant: null
- identity: null
- merchant_identity: null
_links:
self:
href: https://finix.sandbox-payments-api.com/verifications/VIixxYGRVewLFa3GqSzqKPbw
@@ -8343,24 +11052,50 @@ components:
Webhook:
description: Single Webhook object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Webhook'
examples:
Webhook:
value:
- id: WHN6HuqRqTV3mDCxoFLrRvP
- url: https://example.com
+ id: WHg3ocwoCz9PgF4ncZTyArFJ
+ created_at: '2022-10-10T03:56:10.15Z'
+ updated_at: '2022-10-10T03:56:10.15Z'
application: APgPDQrLD52TYvqazjHJJchM
- enabled: false
authentication:
type: NONE
+ enabled: true
enabled_events: []
- created_at: '2022-08-15T21:41:30.94Z'
- updated_at: '2022-08-15T21:41:31.01Z'
+ previous_secret_expires_at: null
+ secret_signing_key: 3afb49c98ac08a67a58efa5580b24e5984bc36d7ebd404e875234f107deed108
+ url: https://eohzjuj2prziycz.m.pipedream.net
+ _links:
+ self:
+ href: http://finix.sandbox-payments-api.com/webhooks/WHg3ocwoCz9PgF4ncZTyArFJ
+ application:
+ href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ Filter Webhook Events:
+ value:
+ id: WHtPXJnAjmusyobzpmQZeHvJ
+ created_at: '2022-06-05T23:29:07.99Z'
+ updated_at: '2022-10-10T04:36:45.88Z'
+ application: APgPDQrLD52TYvqazjHJJchM
+ authentication:
+ type: NONE
+ enabled: false
+ enabled_events:
+ - entity: merchant
+ types:
+ - created
+ - underwritten
+ - entity: transfer
+ types:
+ - created
+ previous_secret_expires_at: null
+ url: https://eohzjuj2prziycz.m.pipedream.net
_links:
self:
- href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP
+ href: http://finix.sandbox-payments-api.com/webhooks/WHtPXJnAjmusyobzpmQZeHvJ
application:
href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
headers:
@@ -8373,7 +11108,7 @@ components:
WebhooksList:
description: List of Webhook objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/WebhooksList'
examples:
@@ -8381,32 +11116,34 @@ components:
value:
_embedded:
webhooks:
- - id: WHdocT8FUQGu73LqByAQ8qyT
- url: https://webhook.site/dc0ac9f4-a423-4797-a4dc-3acecb39414e
+ - id: WHtbmULb3Y68oGfKWc9TLJnJ
+ created_at: '2022-09-27T18:40:29.20Z'
+ updated_at: '2022-09-27T18:40:29.39Z'
application: APgPDQrLD52TYvqazjHJJchM
- enabled: true
authentication:
type: NONE
+ enabled: false
enabled_events: []
- created_at: '2022-08-17T16:33:57.71Z'
- updated_at: '2022-08-17T16:33:57.71Z'
+ previous_secret_expires_at: null
+ url: https://example.com/
_links:
self:
- href: http://finix.sandbox-payments-api.com/webhooks/WHdocT8FUQGu73LqByAQ8qyT
+ href: http://finix.sandbox-payments-api.com/webhooks/WHtbmULb3Y68oGfKWc9TLJnJ
application:
href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- - id: WHN6HuqRqTV3mDCxoFLrRvP
- url: https://example.com
+ - id: WHmnVdiaimgD8aRTVvwuTZaj
+ created_at: '2022-09-27T18:38:56.81Z'
+ updated_at: '2022-09-27T18:38:57.03Z'
application: APgPDQrLD52TYvqazjHJJchM
- enabled: false
authentication:
type: NONE
+ enabled: false
enabled_events: []
- created_at: '2022-08-15T21:41:30.94Z'
- updated_at: '2022-08-15T21:41:31.01Z'
+ previous_secret_expires_at: null
+ url: https://example.com/
_links:
self:
- href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP
+ href: http://finix.sandbox-payments-api.com/webhooks/WHmnVdiaimgD8aRTVvwuTZaj
application:
href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
_links:
@@ -8415,7 +11152,7 @@ components:
next:
href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=1180&limit=20&sort=created_at,desc&sort=id,desc
+ href: http://finix.sandbox-payments-api.com/notification/webhooks?offset=1360&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
@@ -8430,7 +11167,7 @@ components:
SubscriptionEnrollment:
description: Single subscription_enrollment resource
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionEnrollment'
examples:
@@ -8456,10 +11193,17 @@ components:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
amounts:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_amounts
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
SubscriptionEnrollmentsList:
description: List of subscription_enrollment objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionEnrollmentList'
examples:
@@ -8517,10 +11261,17 @@ components:
offset: 0
limit: 20
count: 2
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
SubscriptionAmount:
description: Single subscription_amount object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionAmount'
examples:
@@ -8543,10 +11294,17 @@ components:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
schedule:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
SubscriptionAmountsList:
description: List of subscription_amount objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionAmountList'
examples:
@@ -8599,14 +11357,21 @@ components:
offset: 0
limit: 20
count: 2
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
SubscriptionSchedule:
description: Example response
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionSchedule'
examples:
- Subscription Schedule (FIXED_TIME_INTERVAL):
+ Subscription Schedule - FIXED_TIME_INTERVAL:
value:
id: SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV
created_at: '2022-08-01T17:53:54.63Z'
@@ -8625,7 +11390,7 @@ components:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV
amounts:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts
- Subscription Schedule (PERIODIC_MONTHLY):
+ Subscription Schedule - PERIODIC_MONTHLY:
value:
id: SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8
created_at: '2022-01-27T07:44:06.18Z'
@@ -8644,7 +11409,7 @@ components:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8
amounts:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8/subscription_amounts
- Subscription Schedule (PERIODIC_YEARLY):
+ Subscription Schedule - PERIODIC_YEARLY:
value:
id: SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru
created_at: '2022-01-27T07:44:05.81Z'
@@ -8663,10 +11428,17 @@ components:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru
amounts:
href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru/subscription_amounts
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
SubscriptionSchedulesList:
description: List of subscription_schedule objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/SubscriptionSchedulesList'
examples:
@@ -8719,10 +11491,17 @@ components:
offset: 0
limit: 20
count: 2
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
BalanceTransfer:
description: Single balance_transfer object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/BalanceTransfer'
examples:
@@ -8755,67 +11534,59 @@ components:
BalanceTransferList:
description: List of balance_transfer objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/BalanceTransferList'
examples:
List of Balance Transfers:
value:
_embedded:
- devices:
- - id: DVtQV22Ezh7TAYazXFxYFHpb
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix triPOS #1'
- model: MX915
- description: Mike Jones
- serial_number: null
- idle_message: null
- enabled: true
- tags: {}
- created_at: '2022-08-15T20:22:26.339930Z'
- updated_at: '2022-08-15T20:22:26.339930Z'
- configuration_details: null
+ balance_transfers:
+ - id: BT_jXhKj7AcdQXvCANFfuowWa
+ created_at: '2022-10-10T08:07:35.69Z'
+ updated_at: '2022-10-10T08:07:35.92Z'
+ amount: 22725
+ currency: USD
+ description: Test Balance Transfer
+ destination: FOR_BENEFIT_OF_ACCOUNT
+ external_reference_id: '84078027639024193'
+ processor_type: LITLE_V1
+ reference_id: FNXBHeZiCJ4C4HcgpVGT5sdb
+ source: OPERATING_ACCOUNT
+ state: SUCCEEDED
+ tags: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/devices/DVtQV22Ezh7TAYazXFxYFHpb
- merchant:
- href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
- transfers:
- href: https://finix.sandbox-payments-api.com/transfers
- authorizations:
- href: https://finix.sandbox-payments-api.com/authorizations
- - id: DVmcB1MTxnebU3VoqnfuatS7
- merchant: MUu56ZGx3Xb6U9gAqKfgNisd
- name: 'Finix triPOS #1'
- model: MX915
- description: Mike Jones
- serial_number: null
- idle_message: null
- enabled: true
- tags: {}
- created_at: '2022-08-15T18:47:55.354154Z'
- updated_at: '2022-08-15T18:47:55.354154Z'
- configuration_details: null
+ href: https://finix.sandbox-payments-api.com/balance_transfers/BT_jXhKj7AcdQXvCANFfuowWa
+ - id: BT_qk8PK15fMsoXjZ1dP9YSwf
+ created_at: '2022-09-28T18:10:01.36Z'
+ updated_at: '2022-09-28T18:10:01.77Z'
+ amount: 4000
+ currency: USD
+ description: Need to increase buffer given the high number of
+ NSFs on merchant fee debits
+ destination: FOR_BENEFIT_OF_ACCOUNT
+ external_reference_id: '83989994584237171'
+ processor_type: LITLE_V1
+ reference_id: FNXbECrND95wKrBh61D3Lrq7n
+ source: OPERATING_ACCOUNT
+ state: SUCCEEDED
+ tags:
+ example: documentation tag
_links:
self:
- href: https://finix.sandbox-payments-api.com/devices/DVmcB1MTxnebU3VoqnfuatS7
- merchant:
- href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd
- transfers:
- href: https://finix.sandbox-payments-api.com/transfers
- authorizations:
- href: https://finix.sandbox-payments-api.com/authorizations
+ href: https://finix.sandbox-payments-api.com/balance_transfers/BT_qk8PK15fMsoXjZ1dP9YSwf
_links:
self:
- href: https://finix.sandbox-payments-api.com/devices/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/balance_transfers/?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
- href: https://finix.sandbox-payments-api.com/devices/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/balance_transfers/?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
- href: https://finix.sandbox-payments-api.com/devices/?offset=8100&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/balance_transfers/?offset=1280&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 2
+ count: 1286
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -8826,7 +11597,7 @@ components:
InstrumentUpdate:
description: Single instrument_update object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/InstrumentUpdate'
examples:
@@ -8851,58 +11622,58 @@ components:
File:
description: Single File object
content:
- application/vnd.api+json:
+ application/json:
schema:
$ref: '#/components/schemas/File'
examples:
- File (Created):
+ File - Created:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
- status: REQUIRES_UPLOAD
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
- linked_type: MERCHANT
- linked_to: MU2n7BSovtwYsWYZF6rBnnzk
- extension: null
+ application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
- type: DRIVERS_LICENSE_FRONT
+ extension: null
+ identity_id: null
+ linked_to: MU2n7BSovtwYsWYZF6rBnnzk
+ linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
- application_id: APgPDQrLD52TYvqazjHJJchM
+ status: REQUIRES_UPLOAD
tags:
test_key_100: test_val_100
- identity_id: null
- File (Uploading):
+ type: DRIVERS_LICENSE_FRONT
+ File - Uploading:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
- status: PENDING
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
- linked_type: MERCHANT
- linked_to: MU2n7BSovtwYsWYZF6rBnnzk
- extension: png
+ application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
- type: DRIVERS_LICENSE_FRONT
+ extension: png
+ identity_id: null
+ linked_to: MU2n7BSovtwYsWYZF6rBnnzk
+ linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
- application_id: APgPDQrLD52TYvqazjHJJchM
+ status: PENDING
tags:
test_key_100: test_val_100
- identity_id: null
- File (Uploaded):
+ type: DRIVERS_LICENSE_FRONT
+ File - Uploaded:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
- status: UPLOADED
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
- linked_type: MERCHANT
- linked_to: MU2n7BSovtwYsWYZF6rBnnzk
- extension: png
+ application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
- type: DRIVERS_LICENSE_FRONT
+ extension: png
+ identity_id: null
+ linked_to: MU2n7BSovtwYsWYZF6rBnnzk
+ linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
- application_id: APgPDQrLD52TYvqazjHJJchM
+ status: UPLOADED
tags:
test_key_100: test_val_100
- identity_id: null
+ type: DRIVERS_LICENSE_FRONT
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -8913,7 +11684,7 @@ components:
FilesList:
description: List of File objects
content:
- application/vnd.api+json:
+ application/json:
schema:
$ref: '#/components/schemas/FilesList'
examples:
@@ -8921,34 +11692,34 @@ components:
value:
_embedded:
files:
- - id: FILE_aBDz8kr36yeuwmVvgn9VU9
- status: UPLOADED
- created_at: '2022-08-18T06:38:00.719761Z'
- updated_at: '2022-08-18T06:38:52.223894Z'
- linked_type: MERCHANT
- linked_to: MU2n7BSovtwYsWYZF6rBnnzk
- extension: png
- display_name: pytest_file
- type: DRIVERS_LICENSE_FRONT
- platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
- application_id: APgPDQrLD52TYvqazjHJJchM
- tags:
- test_key_100: test_val_100
- identity_id: null
- id: FILE_abki8bFEjq51eZ5w2pYFik
- status: REQUIRES_UPLOAD
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
- linked_type: MERCHANT
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ display_name: license_file
+ extension: png
+ identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
- extension: null
- display_name: pytest_file
- type: DRIVERS_LICENSE_FRONT
+ linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
- application_id: APgPDQrLD52TYvqazjHJJchM
+ status: UPLOADED
tags:
test_key_100: test_val_100
+ type: DRIVERS_LICENSE_FRONT
+ - id: FILE_eCecW4LCMMfY7nfnBrKpX8
+ created_at: '2022-10-11T21:19:46.273063Z'
+ updated_at: '2022-10-11T21:19:46.296136Z'
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ display_name: My Drivers License
+ extension: null
identity_id: null
+ linked_to: MU2n7BSovtwYsWYZF6rBnnzk
+ linked_type: MERCHANT
+ platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
+ status: REQUIRES_UPLOAD
+ tags:
+ key_1: value_1
+ type: DRIVERS_LICENSE_FRONT
page:
limit: 10
next_cursor: FILE_abki8bFEjq51eZ5w2pYFik
@@ -8962,7 +11733,7 @@ components:
ExternalLink:
description: Single external_link object
content:
- application/vnd.api+json:
+ application/json:
schema:
$ref: '#/components/schemas/ExternalLink'
examples:
@@ -8970,20 +11741,27 @@ components:
value:
id: EL_dh5YS66GePpkeSVyL4VdBL
created_at: '2022-03-22T01:07:05.074313Z'
- url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
- type: UPLOAD
+ duration: null
+ expired: true
expires_at: '2022-03-22T01:22:05.070415Z'
- user_id: USsRhsHYZGBPnQw8CByJyEQW
file_id: FILE_bJecqoRPasStEPVpvKHtgA
- duration: null
tags: {}
- expired: true
- ExternalLinksList:
- description: List of external_link objects
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/ExternalLinksList'
+ type: UPLOAD
+ url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
+ user_id: USsRhsHYZGBPnQw8CByJyEQW
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
+ ExternalLinksList:
+ description: List of external_link objects
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExternalLinksList'
examples:
List of External Links:
value:
@@ -8991,107 +11769,120 @@ components:
external_links:
- id: EL_sVv61JP93htzDFTtNhbsdd
created_at: '2022-05-24T06:50:51.94704Z'
- url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCRwhQF2A0kHmtOUShU8uI2g1JRbA0fxx%2Bkl5IGtZ6ygwIhAPSKP6KEEHYHhMqD54bqT%2Fzb495zGacrdZBEcGciNfZaKtMECHAQAhoMMzc1NjM1NTcwMDcwIgyA5j6IswvJUsAaiAoqsASHRDILId%2BbaQZiUOu29lOE9FmgXlw8uxpV3IiLMWmn2l4Iq8rTdANxXRVCM%2BWrT53DiBACQrUOSrmokWHfJ0DiizxD%2Fky06kDSbiVrD%2BK9DckqiBlg84N%2F7JKqyNeQUJKrUHtDKoH%2BSM%2FYNTgur%2BaGR07as8NG8qnhO8sJela5yWugYJjw4iJoZp%2BmOn%2BVL0Ry9OjEcoKxXCBDJF8W1ppa%2BRa1zfwpufJGWZYYZUiv31pVleRuCDyVef4p8MejnzRiEHFE4TNgcPYZW%2F97KRjQ9OYWbh7ygDuki9ejVdMICywCHEGLEtP%2Fr5EIU1IjWJUt6pwkjud2hHJ18f8j5U5j%2FFQF7wiTl3FlqqnXrLSHJaVA6fyJWbCTcfR%2B3Hr%2FbTSZWZWctXHO%2ByBYR1D9z9KhD%2FwaO87k0KRBRSggiMjVsgILguTdOeggcg3XyfUg2zRj6GPQF7HfBN%2FtGYoTO7l2IR6NBB7FBiusXzJMQd7IFC8fW%2BbiFlFmZk0IlGIUJcB2cetDEGL3k7McHOx9P7ywsy0f7wGdMTS01JgSOAt9Ic0nlljKj0dItwz1f%2FCIcm1%2FWvCZ2W6g0PbtM9dDEL04j3rIBm7spqqtx8KIj2hZs3cEkp8yr%2Bx%2B%2BZRXbMUnT7zNsEGShQGDVwxKP1sA834ZhF9KkC0RdRZFqvgXnC7Sk02tqSGVIUTzcymCl2jYfgiBfolPVW7cwEoIPOv%2FNEp%2BEHWZ7eJMP%2BiAnyMnXDkaGTCL97GUBjqoAQS5iN2Njmu0X6N5249v6JJ3HaoDqIE3p3A6IjwMK%2Byyx81LLYDkZTLVjo2t9DzPLjUy5TiTGd0mNt0Gp5fJ4vo4V5T2BnRWLTxS3tCrG69lTVWBEZfg9NniNhRwRsRrwW%2B%2BeJGIdt7E7CSciDB6fknhtALrh%2FtNKgqF4ofP8QxZedsz9FICsjt1On3r1BUqBLM9gZKdDvapil9PWDJeiRr24dbivHZfYg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220524T065051Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLGNOGWHOG%2F20220524%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8d360d38a6752dba12fbebb2a83ad5c129b5fc475bf323f169fa826c6bca1b68
- type: UPLOAD
+ duration: null
+ expired: true
expires_at: '2022-05-24T07:05:51.934426Z'
- user_id: USsRhsHYZGBPnQw8CByJyEQW
file_id: FILE_bJecqoRPasStEPVpvKHtgA
- duration: null
tags: {}
- expired: true
+ type: UPLOAD
+ url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCRwhQF2A0kHmtOUShU8uI2g1JRbA0fxx%2Bkl5IGtZ6ygwIhAPSKP6KEEHYHhMqD54bqT%2Fzb495zGacrdZBEcGciNfZaKtMECHAQAhoMMzc1NjM1NTcwMDcwIgyA5j6IswvJUsAaiAoqsASHRDILId%2BbaQZiUOu29lOE9FmgXlw8uxpV3IiLMWmn2l4Iq8rTdANxXRVCM%2BWrT53DiBACQrUOSrmokWHfJ0DiizxD%2Fky06kDSbiVrD%2BK9DckqiBlg84N%2F7JKqyNeQUJKrUHtDKoH%2BSM%2FYNTgur%2BaGR07as8NG8qnhO8sJela5yWugYJjw4iJoZp%2BmOn%2BVL0Ry9OjEcoKxXCBDJF8W1ppa%2BRa1zfwpufJGWZYYZUiv31pVleRuCDyVef4p8MejnzRiEHFE4TNgcPYZW%2F97KRjQ9OYWbh7ygDuki9ejVdMICywCHEGLEtP%2Fr5EIU1IjWJUt6pwkjud2hHJ18f8j5U5j%2FFQF7wiTl3FlqqnXrLSHJaVA6fyJWbCTcfR%2B3Hr%2FbTSZWZWctXHO%2ByBYR1D9z9KhD%2FwaO87k0KRBRSggiMjVsgILguTdOeggcg3XyfUg2zRj6GPQF7HfBN%2FtGYoTO7l2IR6NBB7FBiusXzJMQd7IFC8fW%2BbiFlFmZk0IlGIUJcB2cetDEGL3k7McHOx9P7ywsy0f7wGdMTS01JgSOAt9Ic0nlljKj0dItwz1f%2FCIcm1%2FWvCZ2W6g0PbtM9dDEL04j3rIBm7spqqtx8KIj2hZs3cEkp8yr%2Bx%2B%2BZRXbMUnT7zNsEGShQGDVwxKP1sA834ZhF9KkC0RdRZFqvgXnC7Sk02tqSGVIUTzcymCl2jYfgiBfolPVW7cwEoIPOv%2FNEp%2BEHWZ7eJMP%2BiAnyMnXDkaGTCL97GUBjqoAQS5iN2Njmu0X6N5249v6JJ3HaoDqIE3p3A6IjwMK%2Byyx81LLYDkZTLVjo2t9DzPLjUy5TiTGd0mNt0Gp5fJ4vo4V5T2BnRWLTxS3tCrG69lTVWBEZfg9NniNhRwRsRrwW%2B%2BeJGIdt7E7CSciDB6fknhtALrh%2FtNKgqF4ofP8QxZedsz9FICsjt1On3r1BUqBLM9gZKdDvapil9PWDJeiRr24dbivHZfYg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220524T065051Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLGNOGWHOG%2F20220524%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8d360d38a6752dba12fbebb2a83ad5c129b5fc475bf323f169fa826c6bca1b68
+ user_id: USsRhsHYZGBPnQw8CByJyEQW
- id: EL_dh5YS66GePpkeSVyL4VdBL
created_at: '2022-03-22T01:07:05.074313Z'
- url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
- type: UPLOAD
+ duration: null
+ expired: true
expires_at: '2022-03-22T01:22:05.070415Z'
- user_id: USsRhsHYZGBPnQw8CByJyEQW
file_id: FILE_bJecqoRPasStEPVpvKHtgA
- duration: null
tags: {}
- expired: true
+ type: UPLOAD
+ url: https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971
+ user_id: USsRhsHYZGBPnQw8CByJyEQW
page:
limit: 10
next_cursor: EL_dh5YS66GePpkeSVyL4VdBL
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
MerchantUpdated:
description: Single Merchant object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/Merchant'
examples:
- Merchant Name Updated:
+ Merchant - Level 2/3 Processing:
value:
- id: MUucec6fHeaWo3VHYoSkUySM
+ id: MUeDVrf2ahuKc9Eg5TeZugvs
+ created_at: '2022-01-27T07:37:04.03Z'
+ updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDpYDM7J9n57q849o9E9yNrG
- verification: VIdikDHXv7x8nWyJg8JZemGx
- merchant_profile: MPzW2oRPtkLxK3fymcMACFi
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- key_2: value_2
- mcc: '0742'
- mid: FNX7CwmebftudY7i5mA4qF6XT
+ card_expiration_date_required: true
+ convenience_charges_enabled: true
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
+ fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ gross_settlement_enabled: false
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
+ level_two_level_three_data_enabled: true
+ mcc: '4900'
merchant_name: Finix Flowers
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: RECONCILIATION
- fee_ready_to_settle_upon: RECONCILIATION
- level_two_level_three_data_enabled: false
- created_at: '2022-01-27T07:36:58.19Z'
- updated_at: '2022-01-27T07:36:58.46Z'
+ merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
+ mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
+ processing_enabled: true
+ processor: DUMMY_V1
processor_details:
- mid: FNX7CwmebftudY7i5mA4qF6XT
+ mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
+ ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ rent_surcharges_enabled: false
+ settlement_enabled: false
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key_2: value_2
+ verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
- href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM
+ href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
identity:
- href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
verifications:
- href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications
+ href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications
merchant_profile:
- href: https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi
+ href: https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
verification:
- href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx
- Merchant Updated to Enable Level 2/Level 3 Processing:
+ href: https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d
+ Merchant - Buyer Charges:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
+ created_at: '2022-01-27T07:37:04.03Z'
+ updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDuqZpDw28f2KK6YuDk4jNLg
- verification: VI5DBvVQ3ye5PcnUCSSvj84d
- merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- key_2: value_2
- mcc: '0742'
- mid: FNXw5a7pBKHsCSgCAyQvU2soL
- merchant_name: Finxi Flowers
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ card_expiration_date_required: true
+ convenience_charges_enabled: true
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ gross_settlement_enabled: false
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
- created_at: '2022-01-27T07:37:04.03Z'
- updated_at: '2022-01-27T07:37:06.12Z'
+ mcc: '4900'
+ merchant_name: Finix Flowers
+ merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
+ mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
+ processing_enabled: true
+ processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
- convenience_charges_enabled: true
+ ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: true
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: true
+ tags:
+ key_2: value_2
+ verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
@@ -9105,37 +11896,40 @@ components:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
verification:
href: https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d
- Merchant Updated to Enable Buyer Charges:
+ Merchant - Disable a Merchant:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
+ created_at: '2022-01-27T07:37:04.03Z'
+ updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
- identity: IDuqZpDw28f2KK6YuDk4jNLg
- verification: VI5DBvVQ3ye5PcnUCSSvj84d
- merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
- processor: DUMMY_V1
- processing_enabled: true
- settlement_enabled: true
- gross_settlement_enabled: false
- creating_transfer_from_report_enabled: true
- card_expiration_date_required: true
card_cvv_required: false
- tags:
- key_2: value_2
- mcc: '0742'
- mid: FNXw5a7pBKHsCSgCAyQvU2soL
- merchant_name: Finix Flowers
- settlement_funding_identifier: UNSET
- ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ card_expiration_date_required: true
+ convenience_charges_enabled: true
+ creating_transfer_from_report_enabled: true
+ default_partial_authorization_enabled: false
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
+ gateway: null
+ gross_settlement_enabled: false
+ identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
- created_at: '2022-01-27T07:37:04.03Z'
- updated_at: '2022-01-27T07:37:06.12Z'
+ mcc: '4900'
+ merchant_name: Finix Flowers
+ merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
+ mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
+ processing_enabled: false
+ processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
- convenience_charges_enabled: true
+ ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: true
+ settlement_enabled: true
+ settlement_funding_identifier: UNSET
+ surcharges_enabled: false
+ tags:
+ key_2: value_2
+ verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs
@@ -9159,7 +11953,7 @@ components:
ApplePaySession:
description: Single apple_pay_session object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/ApplePaySession'
examples:
@@ -9184,111 +11978,128 @@ components:
AdjustmentTransfersList:
description: List of adjustment_transfer objects
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/AdjustmentTransfersList'
examples:
List of Adjustment Transfers in a Dispute:
value:
_embedded:
- disputes:
- - id: DIb72obRhTmPdMG1VxDKFLrb
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- test: sale
+ transfers:
+ - id: TRrqiR7x5zwUPV5SpPSbKH8B
+ created_at: '2022-01-27T07:43:03.94Z'
+ updated_at: '2022-01-27T07:43:03.48Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 888888
- state: PENDING
- transfer: TRkhvS4GfMKxaHyBBdkPSx6g
- reason: FRAUD
- message: null
- action: null
- identity: IDuqZpDw28f2KK6YuDk4jNLg
- created_at: '2022-07-14T19:40:06.52Z'
- updated_at: '2022-07-14T19:40:06.11Z'
- occurred_at: '2022-07-14T19:39:00.77Z'
- respond_by: '2022-07-21T19:40:06.51Z'
- dispute_details:
- arn: '123'
+ amount_requested: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-01-27T07:43:03.91Z'
+ security_code_verification: null
+ source: null
+ state: SUCCEEDED
+ statement_descriptor: null
+ subtype: PLATFORM_CREDIT
+ tags: {}
+ trace_id: c14d481c-60eb-4338-8331-9f34b3445710
+ type: DISPUTE
_links:
- self:
- href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TRkhvS4GfMKxaHyBBdkPSx6g
- evidence:
- href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/evidence
- adjustment_transfers:
- href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers
- - id: DIuk8T4ayQdmxewz8EDLHe49
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- order_number: 21DFASJSAKAS
+ self:
+ href: https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/payment_instruments
+ disputed_transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/disputed_transfer
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
+ - id: TRw6U5auHfgKfgT4APKgkh4f
+ created_at: '2022-09-16T22:21:54.66Z'
+ updated_at: '2022-09-16T22:21:54.66Z'
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
amount: 888888
- state: PENDING
- transfer: TR27JnLR2pKDXjVVcGBKrjwU
- reason: FRAUD
- message: null
- action: null
- identity: IDpYDM7J9n57q849o9E9yNrG
- created_at: '2022-06-15T16:14:03.95Z'
- updated_at: '2022-06-15T16:14:03.64Z'
- occurred_at: '2022-06-15T16:13:04.09Z'
- respond_by: '2022-06-22T16:14:03.94Z'
- dispute_details:
- arn: '123'
+ amount_requested: 888888
+ application: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ destination: null
+ externally_funded: 'FALSE'
+ failure_code: null
+ failure_message: null
+ fee: 0
+ idempotency_id: null
+ merchant_identity: IDpYDM7J9n57q849o9E9yNrG
+ messages: []
+ raw: null
+ ready_to_settle_at: '2022-09-16T22:21:54.81Z'
+ security_code_verification: null
+ source: PIe2YvpcjvoVJ6PzoRPBK137
+ state: SUCCEEDED
+ statement_descriptor: null
+ subtype: MERCHANT_CREDIT
+ tags: {}
+ trace_id: d5416d16-df58-4c9a-9759-076cb28800d5
+ type: DISPUTE
_links:
- self:
- href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TR27JnLR2pKDXjVVcGBKrjwU
- evidence:
- href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/evidence
- adjustment_transfers:
- href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers
- - id: DIs7yQRkHDdMYhurzYz72SFk
- application: APgPDQrLD52TYvqazjHJJchM
- tags:
- order_number: 21DFASJSAKAS
- amount: 888888
- state: PENDING
- transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
- reason: FRAUD
- message: null
- action: null
- identity: IDpYDM7J9n57q849o9E9yNrG
- created_at: '2022-01-27T07:43:03.74Z'
- updated_at: '2022-01-27T07:43:03.48Z'
- occurred_at: '2022-01-27T07:42:48.56Z'
- respond_by: '2022-02-03T07:43:03.73Z'
- dispute_details:
- arn: '123'
- _links:
self:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk
- application:
- href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
- transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky
- evidence:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence
- adjustment_transfers:
- href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers
+ href: https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f
+ merchant_identity:
+ href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
+ payment_instruments:
+ href: https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f/payment_instruments
+ disputed_transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f/disputed_transfer
+ source:
+ href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
+ fee_profile:
+ href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5
_links:
self:
- href: https://finix.sandbox-payments-api.com/disputes?offset=0&limit=20&sort=created_at,desc&sort=id,desc
+ href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
- count: 3
+ count: 4
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
FileDownload:
description: Example response
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/FileDownload'
+ examples:
+ Download Begins:
+ value: {}
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
ComplianceForm:
description: Example response
content:
@@ -9301,51 +12112,60 @@ components:
id: cf_fEojUGLjwUiqNTBp68JWq8
created_at: '2022-06-22T01:20:12.439149Z'
updated_at: '2022-07-06T17:32:00.328699Z'
+ application_id: APdoThHn4jjYUSxQf76txAgg
+ compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
+ due_at: '2022-09-20T01:20:12.430835Z'
+ files:
+ signed_file: null
+ unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
linked_to: MUfnskvHiiDgP7x3TVL2LkG3
linked_type: MERCHANT
- type: PCI_SAQ_A
- version: '2018.5'
- valid_from: '2022-06-22T01:20:12.978825Z'
- valid_until: '2023-06-22T01:20:12.97883Z'
- tags: {}
pci_saq_a:
- name: null
- signed_at: null
- user_agent: null
ip_address: null
is_accepted: false
+ name: null
+ signed_at: null
title: null
- due_at: '2022-09-20T01:20:12.430835Z'
- compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
- files:
- unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
- signed_file: null
+ user_agent: null
state: INCOMPLETE
+ tags: {}
+ type: PCI_SAQ_A
+ valid_from: '2022-06-22T01:20:12.978825Z'
+ valid_until: '2023-06-22T01:20:12.97883Z'
+ version: '2018.5'
Complete Compliance Form:
value:
- id: cf_fEojUGLjwUiqNTBp68JWq8
- created_at: '2022-06-22T01:20:12.439149Z'
- updated_at: '2022-07-06T17:32:00.328699Z'
- linked_to: MUfnskvHiiDgP7x3TVL2LkG3
+ id: cf_pqJFvPD3DXAnut1w6iNFK
+ created_at: '2023-07-06T22:18:19.806288Z'
+ updated_at: '2023-07-06T22:26:41.003926Z'
+ linked_to: MUqXc76t2KiqtikLni1zrMmW
linked_type: MERCHANT
+ application: APgix2NcQ9ETSPpVoqwSYUHx
type: PCI_SAQ_A
- version: '2018.5'
- valid_from: '2022-06-22T01:20:12.978825Z'
- valid_until: '2023-06-22T01:20:12.97883Z'
+ version: '2018.10'
+ valid_from: '2023-07-06T22:18:25.775726Z'
+ valid_until: '2024-07-05T22:18:25.77573Z'
tags: {}
pci_saq_a:
- name: John Booker
+ name: John Smith
signed_at: '2022-03-18T16:42:55Z'
user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
ip_address: 42.1.1.113
is_accepted: true
title: CTO
- due_at: '2022-09-20T01:20:12.430835Z'
- compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
+ due_at: '2023-10-04T22:18:19.790434Z'
+ compliance_form_template: cft_k6o6W33fdwnMXNxNhe4nfN
files:
- unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
- signed_file: null
- state: INCOMPLETE
+ unsigned_file: FILE_AwHMYuDX7w2d8hobjkxKD
+ signed_file: FILE_6E9ZpgGZJGmLcj2PiZzXHB
+ state: COMPLETE
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
InstrumentUpdateDownload:
description: "The updated `Payment Instruments` will be returned in the following\
\ comma seperated format:\n\npayment\\_instrument\\_original,\t| payment\\\
@@ -9360,184 +12180,206 @@ components:
application/json:
schema:
$ref: '#/components/schemas/FileDownload'
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
AuthorizationUpdated:
description: Single captured Authorization object
content:
- application/hal+json:
+ application/json:
schema:
$ref: '#/components/schemas/AuthorizationCaptured'
examples:
- Captured Authorization:
+ Capture Authorization:
value:
- id: AUcP43nwPk6VBjPQBDRBTH5n
+ id: AUbrumLihwhdLixtbU1mfMiF
+ created_at: '2022-10-06T20:22:42.25Z'
+ updated_at: '2022-10-07T17:09:22.85Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 118
+ amount_requested: 118
application: APgPDQrLD52TYvqazjHJJchM
- amount: 108
- tags:
- test_key_100: test_auth
- state: SUCCEEDED
currency: USD
- transfer: TRhPwUByCNHQjhNiLdNgveuA
+ expires_at: '2022-10-13T20:22:42.25Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-07-20T22:12:02.96Z'
- updated_at: '2022-07-20T22:12:03.76Z'
- trace_id: ab1bebd8-f6a4-4d86-9640-5eebf68c574f
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ test_key_101: test_val_101
+ trace_id: 2724719e-6cc4-4cba-a859-2e6ac0bffb9b
+ transfer: TRs6APHuUAvSYq2FfTDkb5d8
void_state: UNATTEMPTED
- expires_at: '2022-07-27T22:12:02.96Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUcP43nwPk6VBjPQBDRBTH5n
+ href: https://finix.sandbox-payments-api.com/authorizations/AUbrumLihwhdLixtbU1mfMiF
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TRhPwUByCNHQjhNiLdNgveuA
+ href: https://finix.sandbox-payments-api.com/transfers/TRs6APHuUAvSYq2FfTDkb5d8
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
- Captured Authorization (with Level 2 Processing):
+ Capture Authorization - Level 2 Processing:
value:
- id: AU4AHPn4k7YTQ8YjK3QajeL2
+ id: AUj9xCyjoNMxcJjaQw2GW7GZ
+ created_at: '2022-10-06T20:22:43.39Z'
+ updated_at: '2022-10-07T17:07:46.24Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 108
+ amount_requested: 108
application: APgPDQrLD52TYvqazjHJJchM
- amount: 1000
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
currency: USD
- transfer: TRbew5P8bkL3yxz6a6FzfVia
+ expires_at: '2022-10-13T20:22:43.39Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:20.68Z'
- updated_at: '2022-01-27T07:37:20.86Z'
- trace_id: ab81e66c-dd65-438b-a1dc-6d580b36233c
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ test_key_100: test_val_100
+ trace_id: 20fb8474-1b04-433e-9573-d58e6fcc1586
+ transfer: TRmGcgUgKxqpTVC2UVKngFsv
void_state: UNATTEMPTED
- expires_at: '2022-02-03T07:37:20.68Z'
- idempotency_id: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUq2Xz5VS46U4hzzhX9WJCxx
+ href: https://finix.sandbox-payments-api.com/authorizations/AUj9xCyjoNMxcJjaQw2GW7GZ
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRmGcgUgKxqpTVC2UVKngFsv
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
- Captured Authorization (with Level 3 Processing):
+ Capture Authorization - Level 3 Processing:
value:
- id: AUczPEgnHSSMJ79n9dvp6HHJ
+ id: AUxgS2JLMnicqNYBpsViNQUp
+ created_at: '2022-09-28T19:07:52.44Z'
+ updated_at: '2022-10-10T06:43:53.74Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
+ amount: 100
+ amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
- amount: 108
- tags:
- order_number: test_auth
- state: SUCCEEDED
currency: USD
- transfer: TReDoizZYZyyyTrcPzMboz84
+ expires_at: '2022-10-05T19:07:52.44Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-07-20T20:52:11.63Z'
- updated_at: '2022-07-20T20:52:12.37Z'
- trace_id: 46a36f58-b496-4b6b-9357-6bb3c340de87
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 99df414c-7afb-4d97-b3cd-3592a37eefa8
+ transfer: TRskeVxUegfhhffGLFX4TEUa
void_state: UNATTEMPTED
- expires_at: '2022-07-27T20:52:11.63Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUsQsCLRp9ENxrh563w1zZHi
+ href: https://finix.sandbox-payments-api.com/authorizations/AUxgS2JLMnicqNYBpsViNQUp
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRskeVxUegfhhffGLFX4TEUa
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
- Voided Authorization:
+ Void Authorization:
value:
- id: AU2UkcVZU94rNqonfcLGZRSJ
- application: APgPDQrLD52TYvqazjHJJchM
+ id: AUeYYckKJTrBVu1j8FYLzJ3W
+ created_at: '2022-10-07T18:25:23.30Z'
+ updated_at: '2022-10-07T18:29:59.38Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
- tags:
- order_number: 21DFASJSAKAS
- state: SUCCEEDED
+ amount_requested: 100
+ application: APgPDQrLD52TYvqazjHJJchM
currency: USD
- transfer: null
+ expires_at: '2022-10-14T18:25:23.30Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: true
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
- created_at: '2022-01-27T07:37:28.10Z'
- updated_at: '2022-01-27T07:37:29.15Z'
- trace_id: 710b6745-c424-4101-84e5-4a49cf317dc7
+ security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
- merchant_identity: IDpYDM7J9n57q849o9E9yNrG
- 3ds_redirect_url: null
- is_void: true
- void_state: PENDING
- expires_at: '2022-02-03T07:37:28.10Z'
- idempotency_id: null
- failure_code: null
- failure_message: null
+ state: SUCCEEDED
+ tags:
+ order_number: 21DFASJSAKAS
+ trace_id: 560e44af-5d22-4af2-801e-03d2dad69dc7
+ transfer: null
+ void_state: SUCCEEDED
_links:
self:
- href: https://finix.sandbox-payments-api.com/authorizations/AU2UkcVZU94rNqonfcLGZRSJ
+ href: https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
merchant_identity:
- href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
- Captured Card Present Authorization (with an EMV Card):
+ href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
+ Capture Card Present Authorization - EMV Card:
value:
id: AUuCfRve8QG6G1wnPCReiLma
- application: APeUbTUjvYb1CdPXvNcwW1wP
+ created_at: '2022-10-06T20:22:42.25Z'
+ updated_at: '2022-10-07T17:09:22.85Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 150
- tags:
- test_key_100: test_auth
- state: SUCCEEDED
+ amount_requested: 118
+ application: APeUbTUjvYb1CdPXvNcwW1wP
+ card_present_details: null
currency: USD
- transfer: TRjiUo5CXLmaJp4k9PL7iP8z
+ device: DVsEanpBtsAVvCHbNXkFaH6f
+ expires_at: '2022-10-13T20:22:42.25Z'
+ failure_code: null
+ failure_message: null
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: []
raw: null
- card_present_details:
- emv_data:
- application_identifier: A0000000031010
- application_label: Visa Credit
- application_preferred_name: ''
- application_transaction_counter: '0047'
- cryptogram: TC 4ACED247416CD824
- issuer_code_table_index: ''
- pin_verified: false
- tags: {}
- masked_account_number: '************7564'
- name: 'AARON/CHRISTOPHER W '
- brand: VISA
- entry_mode: CHIP_ENTRY
- payment_type: CREDIT
- approval_code: '000042'
- capture_amount: 150
- created_at: '2019-03-01T03:42:13.59Z'
- updated_at: '2019-03-01T03:49:28.67Z'
- trace_id: 957ce193-b4e4-4a39-88e2-d88a019982d2
+ security_code_verification: MATCHED
source: PIjnHHLBZvRu6GPEZdFt7E2q
- merchant_identity: IDsbTBawhnLBAVeinRb84vFR
- device: DVf2H8sh4LZZC52GTUrwCPPf
- 3ds_redirect_url: null
- is_void: false
+ state: SUCCEEDED
+ tags:
+ order_number: chris123transfer
+ trace_id: 957ce193-b4e4-4a39-88e2-d88a019982d2
+ transfer: TRjiUo5CXLmaJp4k9PL7iP8z
void_state: UNATTEMPTED
- expires_at: '2019-03-08T03:42:13.59Z'
- idempotency_id: null
- additional_buyer_charges: null
- failure_code: null
- failure_message: null
_links:
self:
href: https://finix.sandbox-payments-api.com/authorizations/AUuCfRve8QG6G1wnPCReiLma
@@ -9546,55 +12388,75 @@ components:
transfer:
href: https://finix.sandbox-payments-api.com/transfers/TRjiUo5CXLmaJp4k9PL7iP8z
device:
- href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf
+ href: https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
- Captured Card Present Authorization (with a Non-EMV Card):
+ Capture Card Present Authorization - Non-EMV Card:
value:
- id: AUiQyUYxQzhAF5ACAsxdUvYb
+ id: AUarp7Pz21Low4u2Urw5Ub4W
+ created_at: '2019-04-29T20:44:00.13Z'
+ updated_at: '2022-10-10T05:59:17.59Z'
+ 3ds_redirect_url: null
+ additional_buyer_charges: null
+ additional_healthcare_data: null
+ address_verification: null
+ amount: 3138
+ amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
- amount: 2500
- tags:
- ticketNumber: '2348'
- state: SUCCEEDED
- currency: USD
- transfer: TR6eEeW2Fr7hVgfTKgeeG3gy
- messages: []
- raw: null
+ capture_amount: 150
card_present_details:
- emv_data: null
- masked_account_number: '************0006'
- name: TEST/WORLDPAY
- brand: VISA
- entry_mode: SWIPED
+ emv_data:
+ application_identifier: A0000001523010
+ application_label: DISCOVER
+ application_preferred_name: null
+ application_transaction_counter: '0005'
+ cryptogram: ARCQ F666F8891F870D33
+ issuer_code_table_index: null
+ pin_verified: false
+ tags: null
+ masked_account_number: '************0059'
+ name: Test Card 05
+ brand: DISCOVER
+ entry_mode: CHIP_ENTRY
payment_type: CREDIT
- approval_code: '050473'
- capture_amount: 3000
- created_at: '2019-05-01T17:18:54.41Z'
- updated_at: '2019-05-01T17:19:42.46Z'
- trace_id: FNXwyFm3UyQEyAL9cdabYBGWa
- source: PImKxRXq5wQ2r5fK6qQtXady
- merchant_identity: IDsbTBawhnLBAVeinRb84vFR
+ approval_code: '004839'
+ currency: USD
device: DVfKLD9GZtsjcJxLtc2yCcfd
- 3ds_redirect_url: null
- is_void: false
- void_state: UNATTEMPTED
- expires_at: '2019-05-08T17:18:54.41Z'
- idempotency_id: null
- additional_buyer_charges: null
+ expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
- _links:
- self:
- href: https://finix.sandbox-payments-api.com/authorizations/AUiQyUYxQzhAF5ACAsxdUvYb
- application:
- href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
- transfer:
- href: https://finix.sandbox-payments-api.com/transfers/TR6eEeW2Fr7hVgfTKgeeG3gy
- device:
- href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
- merchant_identity:
+ idempotency_id: null
+ is_void: false
+ merchant: MUeDVrf2ahuKc9Eg5TeZugvs
+ merchant_identity: IDsbTBawhnLBAVeinRb84vFR
+ messages: []
+ raw: null
+ security_code_verification: null
+ source: PImTHaz7XVPx4M7mhu9x8gkU
+ state: SUCCEEDED
+ tags:
+ TicketNumber: '45878'
+ trace_id: FNX35FSuraeKKJr65wkGVFJni
+ transfer: TRqQCAX7nYHUnkE5YPFTknqd
+ void_state: UNATTEMPTED
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W
+ application:
+ href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP
+ transfer:
+ href: https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd
+ device:
+ href: https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd
+ merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
OnboardingForm:
description: A single `onboarding_from` objext.
content:
@@ -9604,21 +12466,105 @@ components:
examples:
Onboarding Form:
value:
- id: obf_bXQj8iSgYwXf432yJcWbKv
+ id: obf_cJUfiz97L8de54EwkC3Hiu
onboarding_data:
- entity: {}
- associated_entities: []
- payment_instruments: {}
- additional_underwriting_data: {}
+ entity:
+ title: CEO
+ first_name: John
+ last_name: Smith
+ email: john.smith@finix.com
+ business_name: Finix Flowers
+ business_type: CORPORATION
+ doing_business_as: Finix Flowers
+ phone: '14158885080'
+ business_phone: '14158885080'
+ mcc: '4900'
+ url: https://www.finix.com
+ ownership_type: PRIVATE
+ default_statement_descriptor: DEMOCOMPANY
+ max_transaction_amount: 100000
+ annual_card_volume: '1000000'
+ principal_percentage_ownership: '75'
+ tax_id: '*****6789'
+ business_tax_id: '*****6789'
+ has_accepted_credit_cards_previously: false
+ personal_address:
+ line1: 123 Boren Ave
+ city: Seattle
+ region: WA
+ postal_code: '98040'
+ country: USA
+ business_address:
+ line1: 123 Bellevue Way
+ city: Bellevue
+ region: WA
+ postal_code: '98039'
+ country: USA
+ dob:
+ day: 13
+ month: 4
+ year: 1982
+ incorporation_date:
+ day: 9
+ month: 3
+ year: 2018
+ associated_entities:
+ - title: CFO
+ first_name: Alex
+ last_name: Smith
+ email: alex.smith@finix.com
+ phone: '14158885080'
+ personal_address:
+ line1: 4848 84th St
+ city: Bellevue
+ region: WA
+ postal_code: '98032'
+ country: USA
+ dob:
+ day: 13
+ month: 4
+ year: 1985
+ principal_percentage_ownership: 25
+ tax_id: '*****6789'
+ payment_instruments:
+ name: SARAH BANKER
+ bank_code: '123456789'
+ account_number: '*****6789'
+ account_type: CHECKING
+ type: BANK_ACCOUNT
+ additional_underwriting_data:
+ refund_policy: NO_REFUNDS
+ average_ach_transfer_amount: 2000000
+ average_card_transfer_amount: 20000
+ annual_ach_volume: 2000000
+ business_description: CONSUMER
+ volume_distribution_by_business_type:
+ other_volume_percentage: 0
+ person_to_person_volume_percentage: 0
+ business_to_business_volume_percentage: 90
+ business_to_consumer_volume_percentage: 10
+ consumer_to_consumer_volume_percentage: 0
+ card_volume_distribution:
+ ecommerce_percentage: 100
+ card_present_percentage: 0
+ mail_order_telephone_order_percentage: 0
max_transaction_amount: 100000
merchant_processors:
- processor: LITLE_V1
+ onboarding_link_details:
+ return_url: https://www.finixflowers.com/
+ expired_session_url: https://www.finixflowers.com/login
+ fee_details_url: https://www.finixflowers.com/fee_details
+ terms_of_service_url: https://www.finixflowers.com/ToS
+ expiration_in_minutes: 10080
onboarding_link:
- expires_at: '2022-07-11T22:19:32.123Z'
- link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1Nzc5NzIsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc2MTcyLCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.A_ItGe4ORB-vnUJ2_mrqz6mI1Hu4nSauvBzo5Utk_aQePfuAPL8ZLBWR5JGRyAB8waV6UyTsbEnxPK22s3cGMg
+ expires_at: '2023-04-06T19:16:28.387Z'
+ link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_cJUfiz97L8de54EwkC3Hiu&applicationId=APgPDQrLD52TYvqazjHJJchM...
status: IN_PROGRESS
- created_at: '2022-07-11T21:49:32.11832Z'
- updated_at: '2022-07-11T21:49:32.11832Z'
+ identity_id: null
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ created_at: '2023-03-30T19:16:28.377022Z'
+ updated_at: '2023-03-30T19:16:28.377022Z'
tags: {}
OnboardingFormLink:
description: A link for users to return to their `onboarding_form` at any time.
@@ -9631,6 +12577,199 @@ components:
value:
expires_at: '2022-07-11T22:39:55.469Z'
link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g
+ PayoutProfile:
+ description: ''
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PayoutProfile'
+ examples:
+ Payout Profile - Gross:
+ value:
+ id: POmhJeq1AsfwetG8LwhA4S9U
+ created_at: '2022-10-25T16:54:08.20Z'
+ updated_at: '2022-10-25T16:54:08.20Z'
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ fees:
+ frequency: MONTHLY
+ day_of_month: 1
+ submission_delay_days: 3
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ tags: {}
+ type: GROSS
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POmhJeq1AsfwetG8LwhA4S9U
+ Payout Profile - Net:
+ value:
+ id: POhiPobG6PoUteNVKpUauWVP
+ created_at: '2022-10-25T07:20:34.37Z'
+ updated_at: '2022-10-25T07:20:34.37Z'
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ net:
+ frequency: CONTINUOUS
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ tags: {}
+ type: NET
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POhiPobG6PoUteNVKpUauWVP
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
+ PayoutProfilesList:
+ description: ''
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PayoutProfilesList'
+ examples:
+ List of Payout Profiles:
+ value:
+ _embedded:
+ payout_profiles:
+ - id: PO6UbajkQrbFd5nAvs57dwyn
+ created_at: '2022-10-24T21:38:23.72Z'
+ updated_at: '2022-10-24T21:38:23.72Z'
+ tags: {}
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ type: GROSS
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: SAME_DAY_ACH
+ fees:
+ frequency: MONTHLY
+ day_of_month: 1
+ submission_delay_days: 3
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: NEXT_DAY_ACH
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
+ - id: POf5rP3c3XyRX7M6PuCvmgxf
+ created_at: '2022-10-20T19:43:18.02Z'
+ updated_at: '2022-10-20T19:43:18.02Z'
+ tags: {}
+ linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
+ linked_type: MERCHANT
+ type: CUSTOM
+ custom: {}
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles
+ next:
+ href: https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
+ page:
+ limit: 100
+ next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
+ headers:
+ finix-apiuser-role:
+ $ref: '#/components/headers/finix-apiuser-role'
+ date:
+ $ref: '#/components/headers/date'
+ x-request-id:
+ $ref: '#/components/headers/x-request-id'
+ ComplianceFormList:
+ description: List of `Compliance Form` objects.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ComplianceFormList'
+ examples:
+ List of Compliance Forms:
+ value:
+ _embedded:
+ compliance_forms:
+ - id: cf_pqJFvPD3DXAnut1w6iNFK
+ created_at: '2023-07-06T22:18:19.806288Z'
+ updated_at: '2023-07-06T22:26:41.003926Z'
+ linked_to: MUqXc76t2KiqtikLni1zrMmW
+ linked_type: MERCHANT
+ application: APgix2NcQ9ETSPpVoqwSYUHx
+ type: PCI_SAQ_A
+ version: '2018.10'
+ valid_from: '2023-07-06T22:18:25.775726Z'
+ valid_until: '2024-07-05T22:18:25.77573Z'
+ tags: {}
+ pci_saq_a:
+ name: John Smith
+ signed_at: '2022-03-18T16:42:55Z'
+ user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
+ ip_address: 42.1.1.113
+ is_accepted: true
+ title: CTO
+ due_at: '2023-10-04T22:18:19.790434Z'
+ compliance_form_template: cft_k6o6W33fdwnMXNxNhe4nfN
+ files:
+ unsigned_file: FILE_AwHMYuDX7w2d8hobjkxKD
+ signed_file: FILE_6E9ZpgGZJGmLcj2PiZzXHB
+ state: COMPLETE
+ page:
+ next_cursor: null
+ limit: 10
+ SplitTransfer:
+ description: The `split_transfer` resource that was created from a split transacion.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SplitTransfer'
+ examples:
+ Split Transfer:
+ value:
+ id: split_transfer_7i2gxncPcfkN5rJwuhrb3q
+ created_at: '2023-07-19T02:30:17.10Z'
+ updated_at: '2023-07-19T02:30:17.10Z'
+ amount: 600
+ fee: 0
+ currency: USD
+ parent_transfer_id: TR7h8NxhCDHunLFdJ1HCLp4r
+ ready_to_settle_at: '2023-07-19T02:30:18.04Z'
+ type: DEBIT
+ merchant_id: MU4jpoNGRkAyjBxumZhGa6Hc
+ identity_id: IDhCtMvcteDx37eD9m4rmdKd
+ fee_profile_id: FPbDSnEPtaT8Nttxj9NJk7eC
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ tags:
+ key: value
+ Split Transfer - Refund:
+ value:
+ id: split_transfer_m7Y8kgx4nunsrVbuMdedDo
+ created_at: '2023-07-19T03:02:03.11Z'
+ updated_at: '2023-07-19T03:02:03.11Z'
+ amount: 600
+ fee: 0
+ currency: USD
+ parent_transfer_id: TRm23kdc4SCxYyva47RyiZv
+ ready_to_settle_at: '2023-07-19T03:03:03.21Z'
+ type: CREDIT
+ merchant_id: MU4jpoNGRkAyjBxumZhGa6Hc
+ identity_id: IDhCtMvcteDx37eD9m4rmdKd
+ fee_profile_id: FPbDSnEPtaT8Nttxj9NJk7eC
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ tags:
+ key: value
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
@@ -9638,11 +12777,64 @@ components:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
+ SplitTransfersList:
+ description: List of `split_transfers` created for a split `Transfer`.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SplitTransfersList'
+ examples:
+ List of Split Transfers:
+ value:
+ _embedded:
+ split_transfers:
+ - id: split_transfer_DQrLD52TYvqazjHJJchM
+ created_at: '2022-10-11T03:25:04.79Z'
+ updated_at: '2022-10-11T03:25:04.79Z'
+ amount: 600
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ identity_id: IDxxx"
+ merchant_id: MUxxxx1
+ parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
+ ready_to_settle_at: '2022-10-11T03:25:05.32Z'
+ type: DEBIT
+ fee: null
+ - id: split_transfer_4MdY6eagpEqhtTaP8EBCR
+ created_at: '2022-10-11T03:25:04.79Z'
+ updated_at: '2022-10-11T03:25:04.79Z'
+ amount: 300
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ identity_id: IDxxx"
+ merchant_id: MUxxxx1
+ parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
+ ready_to_settle_at: '2022-10-11T03:25:05.32Z'
+ type: DEBIT
+ fee: null
+ - id: split_transfer_4MdY6eagpEqhtTaP8EBCR
+ created_at: '2022-10-11T03:25:04.79Z'
+ updated_at: '2022-10-11T03:25:04.79Z'
+ amount: 100
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ currency: USD
+ identity_id: IDxxx"
+ merchant_id: MUxxxx1
+ parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
+ ready_to_settle_at: '2022-10-11T03:25:05.32Z'
+ type: DEBIT
+ fee: null
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j
+ next:
+ href: https://finix.sandbox-payments-api.com/transfers?limit=3&after_cursor=split_transfer_xxx
+ page:
+ limit: 3
+ next_cursor: split_transfer_xxx
schemas:
Application:
type: object
- description: ''
- title: ''
properties:
id:
type: string
@@ -9694,7 +12886,7 @@ components:
enum:
- RECONCILIATION
- SUCCESSFUL_CAPTURE
- description: Details when `Authroizations` submitted under the `Application`
+ description: Details when transactions submitted under the `Application`
will be ready to settle.
nullable: true
settlement_enabled:
@@ -9704,7 +12896,23 @@ components:
type: string
enum:
- UNSET
- nullable: true
+ - MID_AND_DATE
+ - MID_AND_MERCHANT_NAME
+ default: UNSET
+ description: 'Includes additional information (like the MID or `Merchant`
+ name) when submitting funding `Transfers` to processors.
+
+ - **UNSET**: No additional details get provided to the processor.
+
+ - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding
+ `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
+
+ - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name`
+ (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
+
+
+ These details appear alongside the seller''s payout in their bank account
+ as a description of the deposit.'
tags:
$ref: '#/components/schemas/Tags'
_links:
@@ -9713,12 +12921,12 @@ components:
which link to resources relevant to the request. You can use these `_links`
to make your follow-up requests and quickly access relevant IDs.
properties:
- application_profile:
+ authorizations:
type: object
properties:
href:
type: string
- authorizations:
+ application_profile:
type: object
properties:
href:
@@ -9806,7 +13014,7 @@ components:
type: integer
format: int64
description: Approximate annual credit card sales expected to be processed
- in cents by this merchant (max 19 characters).
+ in cents by this seller (max 19 characters).
business_address:
type: object
description: Primary address for the legal entity.
@@ -10136,17 +13344,17 @@ components:
dob:
type: object
format: date
- description: Principal's date of birth.
+ description: The principal control owner's date of birth.
properties:
- year:
- type: integer
- description: Year of birth (4-digit).
day:
type: integer
description: Day of birth (between 1 and 31).
month:
type: integer
description: Month of birth (between 1 and 12).
+ year:
+ type: integer
+ description: Year of birth (4-digit).
doing_business_as:
type: string
maxLength: 60
@@ -10165,18 +13373,18 @@ components:
description: Defaults to **false** if not passed.
incorporation_date:
type: object
- format: date
- description: Date company was founded.
+ description: The date the company was founded and registered.
+ nullable: true
properties:
- year:
- type: integer
- description: Year business was incorporated (4-digit).
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
last_name:
type: string
description: Full legal last name of the merchant's principal representative
@@ -10188,10 +13396,12 @@ components:
in cents (max 12 characters).
mcc:
type: string
- description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf))
- the merchant is classified under.
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
ownership_type:
type: string
+ nullable: true
enum:
- PRIVATE
- PUBLIC
@@ -10323,9 +13533,11 @@ components:
type: object
properties:
fee_profile:
- $ref: '#/components/schemas/Id'
+ type: object
+ description: The ID of the `Fee Profile` associated with the `Application`.
risk_profile:
- $ref: '#/components/schemas/Id'
+ type: object
+ description: The ID of the `Risk Profile` associated with the `Application`.
tags:
$ref: '#/components/schemas/Tags'
ApplicationProfilesList:
@@ -10345,37 +13557,7 @@ components:
items:
$ref: '#/components/schemas/ApplicationProfile'
_links:
- type: object
- description: For your convenience, every response includes several URLs
- which link to resources relevant to the request. You can use these `_links`
- to make your follow-up requests and quickly access relevant IDs.
- properties:
- first:
- type: object
- properties:
- href:
- type: string
- last:
- type: object
- properties:
- href:
- type: string
- next:
- type: object
- properties:
- href:
- type: string
- prev:
- type: object
- properties:
- href:
- type: string
- self:
- type: object
- description: Link to the resource that was used in the request.
- properties:
- href:
- type: string
+ $ref: '#/components/schemas/ListLinks'
ApplicationsList:
type: object
description: ''
@@ -10398,7 +13580,6 @@ components:
$ref: '#/components/schemas/ListLinks'
CreateAuthorizationRequest:
type: object
- description: Create an `Authorization` resource.
properties:
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
@@ -10412,24 +13593,37 @@ components:
currency:
$ref: '#/components/schemas/Currency'
device:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Device` that the `Authorization` was created
+ under.
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
+ hsa_fsa_payment:
+ $ref: '#/components/schemas/HSAFSAPayment'
idempotency_id:
type: string
- description: A randomly generated value that'll be associated with the request.
+ description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Merchant` that the `Authorization` was created
+ under.
operation_key:
$ref: '#/components/schemas/OperationKey'
+ security_code:
+ type: string
+ description: The 3-4 digit security code for the card (i.e. CVV code). Include
+ the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/)
+ with the created `Authorization`.
source:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Payment Instrument` that will be debited and
+ performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
3d_secure_authentication:
type: object
- description: The information required to create a 3D secure `Authorization`.
+ description: The 3D secure information required to create a 3D secure `Authorization.`
nullable: true
properties:
cardholder_authentication:
@@ -10439,17 +13633,21 @@ components:
each authentication transaction.
cardholder_ip_address:
type: string
- description: Only required for American Express cards. Format is nnn.nnn.nnn.nnn
+ description: Only required for **American Express** cards.
+ example: 189.1.126.240
electronic_commerce_indicator:
type: string
- description: 'AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED:
- Issuer or cardholder does not support 3D Secure'
+ description: '- **AUTHENTICATED**: Approved by 3D Secure Vendor.
+
+ - **ATTEMPTED**: Issuer or cardholder doesn''t support 3D Secure.'
transaction_id:
type: string
- description: Only valid for Visa transactions
- required:
- - amount
- - currency
+ description: Only required for **Visa** cards.
+ required:
+ - cardholder_authentication
+ - electronic_commerce_indicator
+ 'additional_purchase_data ':
+ $ref: '#/components/schemas/L3AdditionalPurchaseData'
Authorization:
type: object
title: Authorization
@@ -10468,8 +13666,16 @@ components:
description: The redirect URL used for 3DS transactions (if supported by
the processor).
nullable: true
+ address_verification:
+ type: string
+ description: Details the results of the Address Verification checks.
+ nullable: true
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
+ additional_healthcare_data:
+ $ref: '#/components/schemas/AdditionalHealthcareData'
+ additional_purchase_data:
+ $ref: '#/components/schemas/AdditionalPurchaseData'
amount:
type: integer
minimum: 0
@@ -10501,23 +13707,36 @@ components:
$ref: '#/components/schemas/FailureCode'
failure_message:
$ref: '#/components/schemas/FailureMessage'
- idempotency_id:
+ security_code_checks:
type: string
- description: A randomly generated value that'll be associated with the request.
+ description: Details the results of the Security Code Verification checks.
nullable: true
is_void:
type: boolean
description: Details if the `Authorization` is void.
+ merchant:
+ type: string
+ example: MUxxxxxxxxxxxxxxxxxxxxxx
+ description: The ID of the `Merchant` resource the `Authorization` was created
+ under.
merchant_identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ example: IDxxxxxxxxxxxxxxxxxxxxxx
+ description: The ID of the `Identity` resource used by the `Merchant` the
+ `Authorization` was processed under.
messages:
type: array
description: Message field that provides additional details. This field
is typically **null**.
+ nullable: true
items:
type: string
raw:
$ref: '#/components/schemas/Raw'
+ security_code_verification:
+ type: string
+ description: Details the results of the Security Code Verification che
+ nullable: true
source:
type: string
example: PIxxxxxxxxxxxxxxxxxx
@@ -10646,13 +13865,21 @@ components:
$ref: '#/components/schemas/FailureMessage'
idempotency_id:
type: string
- description: A randomly generated value that'll be associated with the request.
+ description: A randomly generated value that gets tied with the request.
nullable: true
is_void:
type: boolean
description: Details if the `Authorization` is void.
+ merchant:
+ type: string
+ description: The ID of the `Merchant` resource the `Authorization` was created
+ under.
+ example: MUxxxxxxxxxxxxxxxxx
merchant_identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of `Identity` resource used by the `Merchant` the `Authorization`
+ was created under.
+ example: IDxxxxxxxxxxxxxxxxx
messages:
type: array
description: Message field that provides additional details. This field
@@ -10758,16 +13985,29 @@ components:
type: string
enum:
- BBPOS
- - MX915
- - MX925
+ - DESK_3500
+ - DESK_5000
- IPP320
- IPP350
- ISC250
- ISC480
- ISMP4
- - ANDROID
- LANE_3000
+ - LANE_5000
+ - LANE_7000
+ - LANE_8000
- LINK_2500
+ - MOVE_5000
+ - MX915
+ - MX925
+ - PAX_A30
+ - PAX_A35
+ - PAX_A60
+ - PAX_A77
+ - PAX_A920PRO
+ - PAX_ARIES6
+ - PAX_ARIES8
+ - PAX_IM30
description: The model type of the device.
name:
type: string
@@ -10975,7 +14215,8 @@ components:
description: '`Device` resource.'
properties:
id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the activated `Device`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
@@ -11021,6 +14262,9 @@ components:
type: string
description: Details if the `Device` is connected and online. Only returned
when `include_connection parameter` provided.
+ enum:
+ - OPEN
+ - CLOSED
description:
type: string
description: Additional information about device (e.g. self serving terminal).
@@ -11100,17 +14344,48 @@ components:
nullable: true
application:
type: string
- description: The ID of the `Application` resource the `Dispute` was created
- under.
- currency:
- $ref: '#/components/schemas/Currency'
+ description: The ID of the `Application` resource that the `Dispute` was
+ created under.
dispute_details:
+ description: Details about the `Dispute` received by the `Processor`. Any
+ data from the processor can get included.
type: object
- additionalProperties: true
- description: Details about the `Dispute` recieved by the `Processor`. May
- be any type of data.
+ properties:
+ case_id:
+ type: string
+ description: The case number the `Processor` has given the dispute in
+ their internal database.
+ nullable: true
+ pin_debit_adjustment_number:
+ type: string
+ description: Used by the processor to identify the funds that are getting
+ disputed.
+ nullable: true
+ reason_code:
+ type: string
+ description: Used by the processor and card networks to identify why
+ the dispute got filed.
+ nullable: true
+ evidence_submitted:
+ type: string
+ enum:
+ - CHARGEBACK
+ - NOT_SUPPORTED
+ - NONE
+ - UNKNOWN
+ - INQUIRY
+ description: The status of the uploaded evidence. [See `Dispute#response_details`
+ for the next steps to move the `Dispute` forward](/api/tag/Disputes/#tag/Disputes/operation/getDispute!c=200&path=response_state&t=response).
identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: '- The ID of the seller''s `Identity` resource.
+
+ - This is the `Identity` resource that was used to create the seller''s
+ `Merchant`.'
+ merchant:
+ type: string
+ description: "- The ID of the seller's `Merchant` resource. \n- This is\
+ \ the `Merchant` account the `Dispute` was filed against."
message:
type: string
description: Message field that provides additional details. This field
@@ -11118,7 +14393,8 @@ components:
nullable: true
occurred_at:
type: string
- description: Point in time when dispute occurred.
+ description: Point in time when the `Transfer` that's getting disputed got
+ created.
format: date-time
nullable: true
reason:
@@ -11133,10 +14409,38 @@ components:
include:- **INQUIRY**
- **QUALITY**
- **FRAUD**
respond_by:
type: string
- description: Point in time when dispute has to be resolved and the `Merchant`
- needs to respond by.
format: date-time
+ description: Point in time, the `Merchant` needs to respond to the dispute
+ by.
nullable: true
+ response_state:
+ type: string
+ enum:
+ - NEEDS_RESPONSE
+ - RESPONDED
+ - ACCEPTED
+ - NO_RESPONSE_ALLOWED
+ - UNKNOWN
+ description: 'Details the state of the `Dispute` and what action the `Merchant`
+ needs to take.
+
+ - **NEEDS_RESPONSE**: The `Merchant` needs to respond to the `Dispute`
+ by `Dispute#respond_by`. For details on how to respond to a `Dispute`,
+ see [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/).
+
+ - **RESPONDED**: The issuing bank has received the evidence and actively
+ reviewing it. No action needed from the `Merchant`.
+
+ - **ACCEPTED**: The `Merchant` has accepted the `Dispute`. When a `Dispute`
+ is accepted, you concede that the dispute is not worth challenging or
+ representing. For details on how to accept a `Dispute`, see [Accepting
+ a Dispute](/guides/after-the-payment/disputes/accepting-disputes/).
+
+ - **NO_RESPONSE_ALLOWED**: The final `Dispute#response_state` when a `Dispute`
+ is either **WON** or **LOST**.
+
+ - **UNKNOWN**: `Dispute` details couldn''t be submitted to the processor.
+ Comes up when testing `Disputes` in sandbox or on the **DUMMY_V1** processor.'
state:
type: string
enum:
@@ -11144,14 +14448,13 @@ components:
- PENDING
- WON
- LOST
- - ARBITRATION
description: The current state of the `Dispute`.
tags:
$ref: '#/components/schemas/Tags'
transfer:
type: string
- example: TRxxxxxxxxxxxxxxxxxx
description: ID of the `Transfer` resource.
+ example: TRxxxxxxxxxxxxxxxxxx
_links:
type: object
description: For your convenience, every response includes several URLs
@@ -11197,9 +14500,14 @@ components:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
+ application:
+ type: string
+ example: APgPDQrLD52TYvqazjHJJchM
+ description: The ID of the `Application` resource that the `Dispute` was
+ created under.
dispute:
type: string
- description: The ID of the resource.
+ description: The ID of the `Dispute` associated with the evidence.
state:
type: string
enum:
@@ -11217,6 +14525,16 @@ components:
\ should retry uploading their evidence file.\n - There is an issue with\
\ the file and the user should retry uploading a different file.\n -\
\ There is an issue and the user should contact Support."
+ identity:
+ type: string
+ example: IDpYDM7J9n57q849o9E9yNrG
+ description: "- The ID of the seller's `Identity` resource. \n- This is\
+ \ the `Identity` resource that was used to create the seller's `Merchant`."
+ merchant:
+ type: string
+ example: MUucec6fHeaWo3VHYoSkUySM
+ description: "- The ID of the seller's `Merchant` resource. \n- This is\
+ \ the `Merchant` account the `Dispute` was filed against."
tags:
$ref: '#/components/schemas/Tags'
_links:
@@ -11669,10 +14987,12 @@ components:
- TRANSFER
description: The type of entity the fee is linked to (**null** by default).
merchant_id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Merchant` resource used to create the `Fee`.
settlement_delay_days:
type: integer
- description: Delays in days, when the fee will be submitted for settlement.
+ description: Delays in days, when the `Transfer` the `Fee` creates will
+ be submitted for settlement.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
@@ -11688,6 +15008,7 @@ components:
id:
type: string
example: FPxxxxxxxxxxxxxxxxxx
+ description: The ID of the `Fee Profile` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
@@ -11699,12 +15020,12 @@ components:
percent (1 basis point = .0001 or .01%)
ach_credit_return_fixed_fee:
type: integer
- description: A fixed amount in cents that will be charged to the merchant
+ description: A fixed amount in cents that will be charged to the seller
for processing an echeck (also called ACH payments) credit return.
nullable: true
ach_debit_return_fixed_fee:
type: integer
- description: A fixed amount in cents that will be charged to the merchant
+ description: A fixed amount in cents that will be charged to the seller
for processing an echeck (also called ACH payment) debit return.
nullable: true
ach_fixed_fee:
@@ -11725,11 +15046,6 @@ components:
description: Set to **True** to incur interchange fees for American Express
`Transfers`.
nullable: true
- american_express_fixed_fee:
- type: integer
- description: Fee in cents incurred for each individual American Express
- `Transfer`.
- nullable: true
american_express_externally_funded_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each
@@ -11741,6 +15057,11 @@ components:
description: Fee in cents incurred for each individual American Express
externally funded `Transfer`.
nullable: true
+ american_express_fixed_fee:
+ type: integer
+ description: Fee in cents incurred for each individual American Express
+ `Transfer`.
+ nullable: true
ancillary_fixed_fee_primary:
type: integer
description: An additional fixed fee that can be charged per `Transfer`.
@@ -11752,12 +15073,23 @@ components:
nullable: true
application:
type: string
- description: The ID of the resource.
+ description: The ID of the `Application` associated with the `Fee Profile`.
basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each
card-based `Transfer`. Calculated as one hundredth of one percent (1 basis
point = .0001 or .01%)
+ card_cross_border_basis_points:
+ type: integer
+ description: Percentage-based fee charged against the full amount of every
+ `Transfer` that includes non-US cards. Calculated as one hundredth of
+ one percent (1 basis point = .0001 or .01%).
+ nullable: true
+ card_cross_border_fixed_fee:
+ type: integer
+ description: Fee in cents charged against every `Transfer` that includes
+ non-US cards.
+ nullable: true
charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for card-based `Transfers`.
@@ -11793,10 +15125,6 @@ components:
type: integer
description: Applies to all U.S.-based `authorization` transactions.
nullable: true
- discover_fixed_fee:
- type: integer
- description: Fee in cents incurred for each individual Discover `Transfer`.
- nullable: true
discover_externally_funded_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each
@@ -11808,6 +15136,10 @@ components:
description: Fee in cents incurred for each individual Discover externally
funded `Transfer`.
nullable: true
+ discover_fixed_fee:
+ type: integer
+ description: Fee in cents incurred for each individual Discover `Transfer`.
+ nullable: true
discover_network_authorization_fixed_fee:
type: integer
description: This fee applies to all Discover network `authorizations` and
@@ -11896,8 +15228,6 @@ components:
description:
- Include AGGREGATE if you want to round
after the settlement calculation.
- By default, rounding happens before
the sum of the settlement calculation (i.e. round each fee transfer)
- tags:
- $ref: '#/components/schemas/Tags'
visa_acquirer_processing_fixed_fee:
type: integer
description: Applied to all U.S.-based credit card authorizations acquired
@@ -12051,7 +15381,7 @@ components:
business_name: Petes Coffee
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
doing_business_as: Petes Coffee
- phone: '1234567890'
+ phone: '14158885080'
business_phone: +1 (408) 756-4497
personal_address:
line1: 741 Douglass St
@@ -12067,7 +15397,7 @@ components:
region: CA
postal_code: '94114'
country: USA
- mcc: '0742'
+ mcc: '4900'
dob:
day: 27
month: 6
@@ -12159,15 +15489,15 @@ components:
annual_ach_volume:
type: integer
description: The approximate annual ACH sales expected to be processed
- (in cents) by this merchant (max 10 characters).
+ (in cents) by this seller (max 10 characters).
average_ach_transfer_amount:
type: integer
description: The approximate average ACH sale amount (in cents) for
- this merchant.
+ this seller.
average_card_transfer_amount:
type: integer
description: The average credit card sale amount (in cents) for this
- merchant.
+ seller.
business_description:
type: string
minLength: 1
@@ -12233,7 +15563,7 @@ components:
refund_policy:
type: string
minLength: 1
- description: Include the value that best applies to the merchant's refund
+ description: Include the value that best applies to the seller's refund
policy.
enum:
- NO_REFUNDS
@@ -12274,6 +15604,11 @@ components:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
+ amex_mid:
+ type: integer
+ description: Assigned amexMid value. If a value is passed, it must be
+ 10 or 11 digits.
+ nullable: true
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be
@@ -12385,8 +15720,7 @@ components:
description: Defaults to **false** if not passed.
incorporation_date:
type: object
- description: The date the company was founded and registered with the
- US.
+ description: The date the company was founded and registered.
nullable: true
properties:
day:
@@ -12413,7 +15747,8 @@ components:
type: string
minLength: 1
description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
- that this merchant will be classified under.
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
nullable: true
ownership_type:
type: string
@@ -12588,7 +15923,7 @@ components:
business_name: Petes Coffee
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
doing_business_as: Petes Coffee
- phone: '1234567890'
+ phone: '14158885080'
business_phone: +1 (408) 756-4497
personal_address:
line1: 741 Douglass St
@@ -12604,7 +15939,7 @@ components:
region: CA
postal_code: '94114'
country: USA
- mcc: '0742'
+ mcc: '4900'
dob:
day: 27
month: 6
@@ -12695,16 +16030,6 @@ components:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
- amex_mid:
- type: integer
- description: Assigned amexMid value. If a value is passed, it must be
- 10 or 11 digits.
- nullable: true
- annual_card_volume:
- type: integer
- description: The annual credit card sales (in cents) expected to be
- processed by this merchant (max 19 characters).
- nullable: true
business_address:
type: object
description: The primary address for the legal entity.
@@ -12811,8 +16136,7 @@ components:
description: Defaults to **false** if not passed.
incorporation_date:
type: object
- description: The date the company was founded and registered with the
- US.
+ description: The date the company was founded and registered.
nullable: true
properties:
day:
@@ -12839,7 +16163,8 @@ components:
type: string
minLength: 1
description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
- that this merchant will be classified under.
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
nullable: true
ownership_type:
type: string
@@ -12922,6 +16247,16 @@ components:
minLength: 1
description: The URL of the merchant's public website.
nullable: true
+ amex_mid:
+ type: integer
+ description: Assigned amexMid value. If a value is passed, it must be
+ 10 or 11 digits.
+ nullable: true
+ annual_card_volume:
+ type: integer
+ description: The annual credit card sales (in cents) expected to be
+ processed by this merchant (max 19 characters).
+ nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
@@ -13001,83 +16336,13 @@ components:
type: string
minLength: 1
CreateIdentityRequest:
- description: ''
- x-examples:
- example-1:
- additional_underwriting_data:
- merchant_agreement_accepted: true
- merchant_agreement_ip_address: 42.1.1.113
- volume_distribution_by_business_type:
- other_volume_percentage: 0
- consumer_to_consumer_volume_percentage: 0
- business_to_consumer_volume_percentage: 0
- business_to_business_volume_percentage: 100
- person_to_person_volume_percentage: 0
- average_ach_transfer_amount: 200000
- annual_ach_volume: 200000
- credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
- refund_policy: MERCHANDISE_EXCHANGE_ONLY
- credit_check_timestamp: '2021-04-28T16:42:55Z'
- credit_check_allowed: true
- merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
- business_description: SB3 vegan cafe
- average_card_transfer_amount: 200000
- credit_check_ip_address: 42.1.1.113
- merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X
- 10_14_6)
- card_volume_distribution:
- card_present_percentage: 30
- mail_order_telephone_order_percentage: 10
- ecommerce_percentage: 60
- tags:
- Studio Rating: '4.7'
- entity:
- last_name: Sunkhronos
- max_transaction_amount: 12000000
- has_accepted_credit_cards_previously: true
- default_statement_descriptor: Petes Coffee
- personal_address:
- city: San Mateo
- country: USA
- region: CA
- line2: Apartment 7
- line1: 741 Douglass St
- postal_code: '94114'
- incorporation_date:
- year: 1978
- day: 27
- month: 6
- business_address:
- city: San Mateo
- country: USA
- region: CA
- line2: Apartment 8
- line1: 741 Douglass St
- postal_code: '94114'
- ownership_type: PRIVATE
- first_name: dwayne
- title: CEO
- business_tax_id: '123456789'
- doing_business_as: Petes Coffee
- principal_percentage_ownership: 50
- email: user@example.org
- mcc: '0742'
- phone: '1234567890'
- business_name: Petes Coffee
- tax_id: '123456789'
- business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
- business_phone: +1 (408) 756-4497
- dob:
- year: 1978
- day: 27
- month: 6
- url: www.PetesCoffee.com
- annual_card_volume: 12000000
type: object
properties:
additional_underwriting_data:
type: object
- description: Addition underwriting details required to verify `Identities`.
+ description: "- Additional underwriting details required to verify `Identities`.\
+ \ \n- Required for any `Merchants` onboarded by Finix Flex customers.\
+ \ If you have any questions, please contact [Finix Support](/guides/business/support-at-finix/)."
nullable: true
properties:
annual_ach_volume:
@@ -13095,6 +16360,23 @@ components:
business_description:
type: string
description: Description of this merchant's business (max 200 characters).
+ card_volume_distribution:
+ type: object
+ description: The distribution of the merchant's credit card volume The
+ sum of `card_volume_distribution` must be 100.
+ properties:
+ card_present_percentage:
+ type: integer
+ description: The percentage of the merchant's volume that's card
+ present (between 0 and 100).
+ mail_order_telephone_order_percentage:
+ type: integer
+ description: The percentage of the merchant's business that is a
+ mail order or telephone order (between 0 and 100).
+ ecommerce_percentage:
+ type: integer
+ description: The percentage of the merchant's business that is eCommerce
+ (between 0 and 100).
credit_check_allowed:
type: boolean
description: Sets if this merchant has consented and accepted to a credit
@@ -13115,23 +16397,6 @@ components:
description: The details of the browser that was used when this merchant
consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac
OS X 10 _14_6)).
- card_volume_distribution:
- type: object
- description: The distribution of the merchant's credit card volume The
- sum of `card_volume_distribution` must be 100.
- properties:
- card_present_percentage:
- type: integer
- description: The percentage of the merchant's volume that's card
- present (between 0 and 100).
- mail_order_telephone_order_percentage:
- type: integer
- description: The percentage of the merchant's business that is a
- mail order or telephone order (between 0 and 100).
- ecommerce_percentage:
- type: integer
- description: The percentage of the merchant's business that is eCommerce
- (between 0 and 100).
merchant_agreement_accepted:
type: boolean
description: Sets whether this merchant has accepted the terms and conditions
@@ -13161,6 +16426,7 @@ components:
- NO_REFUNDS
- MERCHANDISE_EXCHANGE_ONLY
- 30_DAYS
+ - OTHER
volume_distribution_by_business_type:
type: object
description: IP address of the merchant when this merchant accepted
@@ -13190,74 +16456,260 @@ components:
type: object
description: The underwriting details required to verify `Identities`.
properties:
- email:
- type: string
- description: The email address of the buyer where they can be reached
- (max 100 characters).
- first_name:
- type: string
- description: The legal first name of the buyer (max 20 characters).
- last_name:
- type: string
- description: The legal last name of the buyer (max 20 characters).
- personal_address:
+ annual_card_volume:
+ type: integer
+ description: The annual credit card sales (in cents) expected to be
+ processed (max 19 characters).
+ business_address:
type: object
- description: The billing address of the buyer. This field is used for
- identity verification purposes.
+ description: The primary address for the legal entity.
+ required:
+ - city
+ - country
+ - region
+ - line1
+ - postal_code
+ nullable: true
properties:
city:
type: string
+ minLength: 1
description: City (max 20 characters).
country:
type: string
- description: 3-Letter country code (e.g. USA).
- line1:
+ minLength: 1
+ description: 3-Letter Country code (e.g. USA).
+ region:
type: string
- description: First line of the address (max 35 characters).
+ minLength: 1
+ description: 2-letter state code.
line2:
type: string
+ minLength: 1
description: Second line of the address (max 35 characters).
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
postal_code:
type: string
+ minLength: 1
description: Zip or Postal code (max 7 characters).
- region:
- type: string
- description: 2-letter State code.
- phone:
+ business_name:
type: string
- description: Phone number where the buyer can be reached.
- tags:
- $ref: '#/components/schemas/Tags'
- UpdateIdentityRequest:
- x-examples: {}
- type: object
- properties:
- additional_underwriting_data:
- type: object
- description: Additional underwriting data that's required to verify the
- `Identity` of merchants.
- properties:
- annual_ach_volume:
- type: integer
- description: The approximate annual ACH sales expected to be processed
- (in cents) by this merchant (max 10 characters).
- average_ach_transfer_amount:
- type: integer
- description: The approximate average ACH sale amount (in cents) for
- this merchant.
- average_card_transfer_amount:
- type: integer
- description: The average credit card sale amount (in cents) for this
- merchant.
- business_description:
+ description: The merchant's legal business name (max 120 characters).- If
+ **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner's legal first name,
+ last name and middle initial.
- Special characters (e.g.,
.,_-?+*
+ or /.) are not allowed.
+ nullable: true
+ business_phone:
type: string
- minLength: 1
- description: Description of this merchant's business (max 200 characters).
- credit_check_allowed:
- type: boolean
- description: Sets if this merchant has consented and accepted to a credit
- check.
- credit_check_ip_address:
+ description: Customer service phone number where the merchant can be
+ reached (max 10 characters).
+ business_tax_id:
+ type: string
+ description: Nine digit Tax Identification Number (TIN), Employer Identification
+ Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**
+ and they do not have an EIN, use the sole proprietor's Social Security
+ Number (SSN).
+ business_type:
+ type: string
+ description: The business entity type of the Merchant.
+ enum:
+ - INDIVIDUAL_SOLE_PROPRIETORSHIP
+ - CORPORATION
+ - LIMITED_LIABILITY_COMPANY
+ - PARTNERSHIP
+ - ASSOCIATION_ESTATE_TRUST
+ - TAX_EXEMPT_ORGANIZATION
+ - INTERNATIONAL_ORGANIZATION
+ - GOVERNMENT_AGENCY
+ default_statement_descriptor:
+ type: string
+ description: The description of the merchant that appears on the buyer's
+ bank or card statement.
+ dob:
+ type: object
+ description: The control owner's date of birth.
+ required:
+ - day
+ - month
+ - year
+ properties:
+ day:
+ type: integer
+ description: Day of birth (between 1 and 31).
+ month:
+ type: integer
+ description: Month of birth (between 1 and 12).
+ year:
+ type: integer
+ description: Year of birth (4-digit). Year must be greater than
+ 1900
+ doing_business_as:
+ type: string
+ description: Alternate names of the business. If there are no other
+ names, pass the same value used for `business_name` (max 60 characters).
+ email:
+ type: string
+ description: The email address of the buyer where they can be reached
+ (max 100 characters).
+ first_name:
+ type: string
+ description: The legal first name of the buyer (max 20 characters).
+ has_accepted_credit_cards_previously:
+ type: boolean
+ description: Defaults to **false** if not passed.
+ incorporation_date:
+ type: object
+ description: The date the company was founded and registered.
+ required:
+ - day
+ - month
+ - year
+ nullable: true
+ properties:
+ day:
+ type: integer
+ description: Day business was incorporated (between 1 and 31).
+ month:
+ type: integer
+ description: Month business was incorporated (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
+ last_name:
+ type: string
+ description: The legal last name of the buyer (max 20 characters).
+ max_transaction_amount:
+ type: integer
+ description: The maximum amount (in cents) that can be charged for a
+ single transaction (max 12 characters).
+ ach_max_transaction_amount:
+ type: integer
+ description: The maximum amount (in cents) that can be charged for a
+ single ACH transaction (max 12 characters).
+ mcc:
+ type: string
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ ownership_type:
+ type: string
+ description: "Avalible values include: - PUBLIC\
+ \ to indicate a publicly-traded company.
- PRIVATE\
+ \ for privately-held businesses.\n\nFor `business_type` of **GOVERNMENT_AGENCY**\
+ \ and **TAX_EXEMPT_ORGANIZATION** the `ownership_type` should be set\
+ \ to **PUBLIC**. \nFor `business_type` **INDIVIDUAL_SOLE_PROPRIETORSHIP**,\
+ \ the `ownership_type` should be set to **PRIVATE**."
+ enum:
+ - PUBLIC
+ - PRIVATE
+ nullable: true
+ personal_address:
+ type: object
+ description: The billing address of the buyer. This field is used for
+ identity verification purposes.
+ required:
+ - city
+ - country
+ - line1
+ - postal_code
+ - region
+ properties:
+ city:
+ type: string
+ description: City (max 20 characters).
+ country:
+ type: string
+ description: 3-Letter country code (e.g. USA).
+ line1:
+ type: string
+ description: First line of the address (max 35 characters).
+ line2:
+ type: string
+ description: Second line of the address (max 35 characters).
+ postal_code:
+ type: string
+ description: Zip or Postal code (max 7 characters).
+ region:
+ type: string
+ description: 2-letter State code.
+ phone:
+ type: string
+ description: Phone number where the buyer can be reached.
+ principal_percentage_ownership:
+ type: integer
+ description: Percentage of the company owned by the principal control
+ owner (min 0; max 100).
+ tax_id:
+ type: string
+ description: Pass one of the following values (nine digits):
- Social
+ Security Number (SSN)
- Tax Identification Number (TIN)
- Individual
+ Taxpayer Identification Number (ITIN)
+ title:
+ type: string
+ description: The corporate title of the control owner (e.g. Chief Executive
+ Officer, CFO, etc. Max 60 characters).
+ url:
+ type: string
+ description: The URL of the merchant's public website.
+ required:
+ - annual_card_volume
+ - business_address
+ - business_name
+ - business_phone
+ - business_tax_id
+ - business_type
+ - default_statement_descriptor
+ - dob
+ - doing_business_as
+ - email
+ - first_name
+ - has_accepted_credit_cards_previously
+ - incorporation_date
+ - last_name
+ - max_transaction_amount
+ - ach_max_transaction_amount
+ - mcc
+ - ownership_type
+ - personal_address
+ - phone
+ - principal_percentage_ownership
+ - tax_id
+ - title
+ - url
+ tags:
+ $ref: '#/components/schemas/Tags'
+ UpdateIdentityRequest:
+ type: object
+ properties:
+ additional_underwriting_data:
+ type: object
+ description: Additional underwriting data that's required to verify the
+ `Identity` of merchants.
+ properties:
+ annual_ach_volume:
+ type: integer
+ description: The approximate annual ACH sales expected to be processed
+ (in cents) by this merchant (max 10 characters).
+ average_ach_transfer_amount:
+ type: integer
+ description: The approximate average ACH sale amount (in cents) for
+ this merchant.
+ average_card_transfer_amount:
+ type: integer
+ description: The average credit card sale amount (in cents) for this
+ merchant.
+ business_description:
+ type: string
+ minLength: 1
+ description: Description of this merchant's business (max 200 characters).
+ credit_check_allowed:
+ type: boolean
+ description: Sets if this merchant has consented and accepted to a credit
+ check.
+ credit_check_ip_address:
type: string
minLength: 1
description: The IP address of the merchant when they consented to a
@@ -13347,48 +16799,6 @@ components:
entity:
type: object
description: Identifying information about the buyer.
- properties:
- email:
- type: string
- description: The email address of the buyer (max 100 characters).
- first_name:
- type: string
- description: The legal first name of the buyer (max 20 characters).
- last_name:
- type: string
- description: The legal last name of the buyer (max 20 characters).
- personal_address:
- type: object
- description: The billing address of the buyer. This field is used for
- identity verification purposes.
- properties:
- city:
- type: string
- description: City (max 20 characters).
- country:
- type: string
- description: 3-Letter country code (e.g. USA).
- line1:
- type: string
- description: First line of the address (max 35 characters).
- line2:
- type: string
- description: Second line of the address (max 35 characters).
- postal_code:
- type: string
- description: Zip or Postal code (max 7 characters).
- phone:
- type: string
- description: Phone number where the buyer can be reached.
- tags:
- $ref: '#/components/schemas/Tags'
- CreateAssociatedIdentityRequest:
- x-examples: {}
- type: object
- properties:
- entity:
- type: object
- description: Underwriting data that's required to verify the `Identity`.
properties:
annual_card_volume:
type: integer
@@ -13436,7 +16846,10 @@ components:
business_tax_id:
type: string
minLength: 1
- description: Details if the `business_tax_id` was provided.
+ description: Nine digit Tax Identification Number (TIN), Employer Identification
+ Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**
+ and they do not have an EIN, use the sole proprietor's Social Security
+ Number (SSN).
business_type:
type: string
minLength: 1
@@ -13457,16 +16870,19 @@ components:
bank or card statement.
dob:
type: object
- description: 'The control owner''s date of birth.
+ description: 'The principal control owner''s date of birth.
'
properties:
- year:
- type: integer
day:
type: integer
+ description: Day of birth (between 1 and 31).
month:
type: integer
+ description: Month of birth (between 1 and 12).
+ year:
+ type: integer
+ description: Year of birth (4-digits).
doing_business_as:
type: string
minLength: 1
@@ -13475,30 +16891,32 @@ components:
email:
type: string
minLength: 1
- description: The email address of the principal control owner where
- they can be reached (max 100 characters).
+ description: The email address of the buyer (max 100 characters).
first_name:
type: string
minLength: 1
- description: The legal first name of the control owner (max 20 characters).
+ description: The legal first name of the buyer (max 20 characters).
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
- description: The date the company was founded and registered with the
- US.
+ description: The date the company was founded and registered.
+ nullable: true
properties:
- year:
- type: integer
day:
type: integer
+ description: Day business was incorporated (between 1 and 31).
month:
type: integer
+ description: Month business was incorporated (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
- description: The `Identity` owner's legal last name.
+ description: The legal last name of the buyer (max 20 characters).
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a
@@ -13506,8 +16924,9 @@ components:
mcc:
type: string
minLength: 1
- description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf))
- that this merchant will be classified under.
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
ownership_type:
type: string
minLength: 1
@@ -13516,10 +16935,11 @@ components:
- PUBLIC to indicate a publicly-traded company.
- PRIVATE for privately-held businesses.'
+ nullable: true
personal_address:
type: object
- description: The home address of the principal control owner. This field
- is used for identity verification purposes.
+ description: The billing address of the buyer. This field is used for
+ identity verification purposes.
properties:
city:
type: string
@@ -13548,7 +16968,7 @@ components:
phone:
type: string
minLength: 1
- description: The principal control owner's phone number (max 10 characters).
+ description: Phone number where the buyer can be reached.
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control
@@ -13568,12 +16988,206 @@ components:
description: The URL of the `Identity` owner's public website.
tags:
$ref: '#/components/schemas/Tags'
- Merchant:
+ CreateAssociatedIdentityRequest:
+ x-examples: {}
type: object
- x-examples:
- example-1:
- id: MUucec6fHeaWo3VHYoSkUySM
- application: APgPDQrLD52TYvqazjHJJchM
+ properties:
+ entity:
+ type: object
+ description: Underwriting data that's required to verify the `Identity`.
+ properties:
+ annual_card_volume:
+ type: integer
+ description: The annual credit card sales (in cents) expected to be
+ processed (max 19 characters).
+ business_address:
+ type: object
+ description: The primary address for the legal entity.
+ nullable: true
+ properties:
+ city:
+ type: string
+ description: City (max 20 characters).
+ minLength: 1
+ country:
+ type: string
+ minLength: 1
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter state code.
+ business_name:
+ type: string
+ minLength: 1
+ description: Abbreviated names of the business. If there are no abbreviated
+ name, leave this field blank.
+ nullable: true
+ business_phone:
+ type: string
+ minLength: 1
+ description: Customer service phone number where the merchant can be
+ reached (max 10 characters).
+ business_tax_id:
+ type: string
+ minLength: 1
+ description: Nine digit Tax Identification Number (TIN), Employer Identification
+ Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**
+ and they do not have an EIN, use the sole proprietor's Social Security
+ Number (SSN).
+ business_type:
+ type: string
+ minLength: 1
+ description: Include the value that best applies to the merchant.
+ enum:
+ - INDIVIDUAL_SOLE_PROPRIETORSHIP
+ - CORPORATION
+ - LIMITED_LIABILITY_COMPANY
+ - PARTNERSHIP
+ - ASSOCIATION_ESTATE_TRUST
+ - TAX_EXEMPT_ORGANIZATION
+ - INTERNATIONAL_ORGANIZATION
+ - GOVERNMENT_AGENCY
+ default_statement_descriptor:
+ type: string
+ minLength: 1
+ description: The description of the merchant that appears on the buyer's
+ bank or card statement.
+ dob:
+ type: object
+ description: 'The control owner''s date of birth.
+
+ '
+ properties:
+ day:
+ type: integer
+ month:
+ type: integer
+ year:
+ type: integer
+ doing_business_as:
+ type: string
+ minLength: 1
+ description: Alternate names of the business. If there are no other
+ names, pass the same value used for `business_name` (max 60 characters).
+ email:
+ type: string
+ minLength: 1
+ description: The email address of the principal control owner where
+ they can be reached (max 100 characters).
+ first_name:
+ type: string
+ minLength: 1
+ description: The legal first name of the control owner (max 20 characters).
+ has_accepted_credit_cards_previously:
+ type: boolean
+ description: Defaults to **false** if not passed.
+ incorporation_date:
+ type: object
+ description: The date the company was founded and registered.
+ nullable: true
+ properties:
+ day:
+ type: integer
+ description: Day business was incorporated (between 1 and 31).
+ month:
+ type: integer
+ description: Month business was incorporated (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
+ last_name:
+ type: string
+ minLength: 1
+ description: The `Identity` owner's legal last name.
+ max_transaction_amount:
+ type: integer
+ description: The maximum amount (in cents) that can be charged for a
+ single transaction (max 12 characters).
+ mcc:
+ type: string
+ minLength: 1
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ ownership_type:
+ type: string
+ minLength: 1
+ nullable: true
+ description: 'Values can be either:
+
+
- PUBLIC to indicate a publicly-traded company.
+
+
- PRIVATE for privately-held businesses.'
+ personal_address:
+ type: object
+ description: The home address of the principal control owner. This field
+ is used for identity verification purposes.
+ properties:
+ city:
+ type: string
+ minLength: 1
+ description: City (max 20 characters).
+ country:
+ type: string
+ minLength: 1
+ description: 3-Letter country code (e.g. USA).
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter State code.
+ phone:
+ type: string
+ minLength: 1
+ description: The principal control owner's phone number (max 10 characters).
+ principal_percentage_ownership:
+ type: integer
+ description: Percentage of the company owned by the principal control
+ owner (min 0; max 100).
+ tax_id:
+ type: string
+ minLength: 1
+ description: Details if the `tax_id` was provided.
+ title:
+ type: string
+ minLength: 1
+ description: The corporate title of the control owner (e.g. Chief Executive
+ Officer, CFO, etc. Max 60 characters).
+ url:
+ type: string
+ minLength: 1
+ description: The URL of the `Identity` owner's public website.
+ tags:
+ $ref: '#/components/schemas/Tags'
+ Merchant:
+ type: object
+ x-examples:
+ example-1:
+ id: MUucec6fHeaWo3VHYoSkUySM
+ application: APgPDQrLD52TYvqazjHJJchM
identity: IDpYDM7J9n57q849o9E9yNrG
verification: VIdikDHXv7x8nWyJg8JZemGx
merchant_profile: MPzW2oRPtkLxK3fymcMACFi
@@ -13586,7 +17200,7 @@ components:
card_cvv_required: false
tags:
key_2: value_2
- mcc: '0742'
+ mcc: '4900'
mid: FNX7CwmebftudY7i5mA4qF6XT
merchant_name: Petes Coffee
settlement_funding_identifier: UNSET
@@ -13616,7 +17230,7 @@ components:
properties:
id:
type: string
- description: The ID of the resource.
+ description: The ID of the `Merchant` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
@@ -13641,6 +17255,15 @@ components:
fee_ready_to_settle_upon:
type: string
description: Details how the `Merchant` settles fees.
+ gateway:
+ type: string
+ description: Name of the gateway that routes the `Merchant's` transactions
+ to the processor.
+ enum:
+ - TRIPOS_MOBILE_V1
+ - TRIPOS_CLOUD_V1
+ - DATACAP_V1
+ nullable: true
gross_settlement_enabled:
type: boolean
description: Set to **true** to enable gross settlements.
@@ -13653,8 +17276,9 @@ components:
3 processing. Default value is **false**.
mcc:
type: string
- description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf))
- that this merchant will be classified under.
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved MCCs,
+ see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
nullable: true
merchant_name:
type: string
@@ -13690,8 +17314,11 @@ components:
description: Details if transaction processing is enabled for the `Merchant`.
ready_to_settle_upon:
type: string
- description: Details how `Authorizations` captured by the `Merchant` are
- settled.
+ description: Details how transactions captured by the `Merchant` are settled.
+ enum:
+ - RECONCILIATION
+ - SUCCESSFUL_CAPTURE
+ - PROCESSOR_WINDOW
rent_surcharges_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept
@@ -13701,8 +17328,30 @@ components:
description: Details if settlement processing is enabled for the `Merchant`.
settlement_funding_identifier:
type: string
- description: Include addtional information (like the MID) when submitting
- funding `Tranfers` to processors.
+ description: 'Includes additional information (like the MID or `Merchant`
+ name) when submitting funding `Transfers` to processors.
+
+ - **UNSET**: No additional details get provided to the processor.
+
+ - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding
+ `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
+
+ - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name`
+ (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
+
+
+ These details appear alongside the seller''s payout in their bank account
+ as a description of the deposit.'
+ enum:
+ - UNSET
+ - MID_AND_DATE
+ - MID_AND_MERCHANT_NAME
+ default: UNSET
+ surcharges_enabled:
+ type: boolean
+ default: false
+ description: Set to **true** if you want to enable a `Merchant` to accept
+ surcharge fees. For more details, see [Buyer Charges](/guides/payments/modify/buyer-charges/).
tags:
$ref: '#/components/schemas/Tags'
verification:
@@ -13757,18 +17406,31 @@ components:
description: ''
properties:
id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Merchant Profile` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
- description: The ID of the resource.
+ description: The ID of the `Application` associated with the `Merchant
+ Profile`.
fee_profile:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Fee Profile` associated with the `Merchant Profile`
+ resource.
+ nullable: true
+ payout_profile:
+ type: string
+ description: The ID of the `Payout Profile` associated with the `Merchant
+ Profile` resource.
+ nullable: true
risk_profile:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Risk Profile` associated with the `Merchant
+ Profile` resource.
+ nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
@@ -13844,9 +17506,9 @@ components:
enum:
- TRIPOS_CLOUD_V1
- TRIPOS_MOBILE_V1
- - EXPRESS_V1
+ - DATACAP_V1
description: Name of the gateway that processes the `Merchant's` card present
- transactions. Use `gateway` only to enable a merchantto accept card present
+ transactions. Use `gateway` only to enable a merchant to accept card present
transactions.
processor:
$ref: '#/components/schemas/ProcessorRequest'
@@ -13856,8 +17518,6 @@ components:
- processor
UpdateMerchantRequest:
type: object
- title: MerchantUpdate
- x-examples: {}
properties:
card_cvv_required:
type: boolean
@@ -13891,8 +17551,7 @@ components:
description: Details if transaction processing is enabled for the `Merchant`.
ready_to_settle_upon:
type: string
- description: Details how `Authorizations` captured by the `Merchant` are
- settled.
+ description: Details how transactions captured by the `Merchant` are settled.
rent_surcharges_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept
@@ -13902,10 +17561,31 @@ components:
description: Details if settlement processing is enabled for the `Merchant`.
settlement_funding_identifier:
type: string
- description: Include addtional information (like the MID) when submitting
- funding `Tranfers` to processors.
+ enum:
+ - MID_AND_DATE
+ - MID_AND_MERCHANT_NAME
+ - UNSET
+ default: UNSET
+ description: 'Includes additional information (like the MID or `Merchant`
+ name) when submitting funding `Transfers` to processors.
+
+ - **UNSET**: No additional details get provided to the processor.
+
+ - **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding
+ `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
+
+ - **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name`
+ (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
+
+
+ These details appear alongside the seller''s payout in their bank account
+ as a description of the deposit.'
tags:
$ref: '#/components/schemas/Tags'
+ surcharge_fees_enabled:
+ type: boolean
+ description: Set to **true** if you want to enable a `Merchant` to accept
+ surcharge fees.
MerchantsList:
type: object
properties:
@@ -13925,11 +17605,11 @@ components:
_links:
$ref: '#/components/schemas/ListLinks'
PaymentInstrument:
- description: ''
type: object
properties:
id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
@@ -13938,24 +17618,46 @@ components:
$ref: '#/components/schemas/Address'
address_verification:
type: string
- description: "Additional address information that\u2019s required to verify\
- \ the identity of the merchant."
enum:
- - POSTAL_CODE_AND_STREET_MATCH
- - STREET_MATCH
- - POSTAL_CODE_MATCH
+ - NOT_SUPPORTED
- NO_ADDRESS
- NO_MATCH
- - NOT_SUPPORTED
+ - POSTAL_CODE_AND_STREET_MATCH
+ - POSTAL_CODE_MATCH
+ - STREET_MATCH
- UNKNOWN
+ description: "Additional address information that\u2019s required to verify\
+ \ the identity of the merchant."
application:
type: string
- description: The ID of the resource.
+ description: The ID of the `Application` resource the `Payment Instrument`
+ was created under.
bin:
type: string
description: Bank Identification number for the `Payment Instrument`.
brand:
type: string
+ enum:
+ - AMERICAN_EXPRESS
+ - CHINA_T_UNION
+ - CHINA_UNION_PAY
+ - DANKORT
+ - DINERS_CLUB
+ - DINERS_CLUB_INTERNATIONAL
+ - DISCOVER
+ - INSTAPAYMENT
+ - INTERPAYMENT
+ - JCB
+ - LANKAPAY
+ - MAESTRO
+ - MASTERCARD
+ - MIR
+ - RUPAY
+ - TROY
+ - UATP
+ - UNKNOWN
+ - VERVE
+ - VISA
description: The `brand` of the card saved in the `Payment Instrument`.
card_name:
type: string
@@ -13964,18 +17666,29 @@ components:
nullable: true
card_type:
type: string
+ enum:
+ - CREDIT
+ - DEBIT
+ - HSA_FSA
+ - NON_RELOADABLE_PREPAID
+ - RELOADABLE_PREPAID
+ - UNKNOWN
description: The type of payment card saved in the `Payment Instrument`.
currency:
$ref: '#/components/schemas/Currency'
+ enabled:
+ type: boolean
+ description: Details if the `Payment Instrument` resource is enabled. Default
+ value is **true**; set to **false** to disable the `Payment Instrument`.
expiration_month:
type: integer
- description: Expiration month (e.g. 12 for December).
- minimum: 1
maximum: 12
+ minimum: 1
+ description: Expiration month (e.g. 12 for December).
expiration_year:
type: integer
- description: 4-digit expiration year.
minimum: 1
+ description: 4-digit expiration year.
fast_funds_indicator:
type: string
description: Details if Fast Funds is enabled for the card.
@@ -13984,20 +17697,32 @@ components:
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Identity` used to create the `Payment Instrument`
+ resource.
instrument_type:
type: string
enum:
- - BANK_ACCOUNT
- - TOKEN
- APPLE_PAY
- - VIRTUAL
- - PAYMENT_CARD_PRESENT
+ - BANK_ACCOUNT
- GOOGLE_PAY
- - VANTIV_OMNI_TOKEN
- - SWIPED_PAYMENT_CARD
- PAYMENT_CARD
+ - PAYMENT_CARD_PRESENT
+ - SWIPED_PAYMENT_CARD
+ - TOKEN
+ - VANTIV_OMNI_TOKEN
+ - VIRTUAL
description: The type of `Payment Instrument`.
+ issuer_country:
+ type: string
+ enum:
+ - NON_USA
+ - UNKNOWN
+ - USA
+ description: 'Details what country the card was issued in:
- USA:
+ The card was issued inside the United States.
- NON_USA:
+ The card was issued outside of the United States.
- UNKNOWN:
+ Processor did not return an issuer country for this particular BIN.'
last_four:
type: string
description: Last four digits of the card or bank account number.
@@ -14012,32 +17737,32 @@ components:
payload_type:
type: string
enum:
- - SOURCE
- DESTINATION
+ - SOURCE
push_funds_block_indicator:
type: string
description: Details if the card is enabled to receive push-to-card disbursements.
security_code_verification:
type: string
- description: Details the results of the Card Verification Code check.
enum:
- MATCHED
- UNKNOWN
- UNMATCHED
+ description: Details the results of the Card Verification Code check.
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- - BANK_ACCOUNT
- - TOKEN
- APPLE_PAY
- - VIRTUAL
- - PAYMENT_CARD_PRESENT
+ - BANK_ACCOUNT
- GOOGLE_PAY
- - VANTIV_OMNI_TOKEN
- - SWIPED_PAYMENT_CARD
- PAYMENT_CARD
+ - PAYMENT_CARD_PRESENT
+ - SWIPED_PAYMENT_CARD
+ - TOKEN
+ - VANTIV_OMNI_TOKEN
+ - VIRTUAL
description: Type of `Payment Instrument`.
_links:
type: object
@@ -14045,9 +17770,9 @@ components:
which link to resources relevant to the request. You can use these `_links`
to make your follow-up requests and quickly access relevant IDs.
properties:
- self:
+ application:
type: object
- description: Link to the resource that was used in the request.
+ description: Link to the `Application` the request was made under.
properties:
href:
type: string
@@ -14057,28 +17782,34 @@ components:
properties:
href:
type: string
- transfers:
+ identity:
type: object
- description: Link to the `Transfers` created under the resource.
+ description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- verifications:
+ self:
type: object
- description: Link to the `Verification` that was used to verify the
- `Merchant` that the request was made under.
+ description: Link to the resource that was used in the request.
properties:
href:
type: string
- application:
+ transfers:
type: object
- description: Link to the `Application` the request was made under.
+ description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
- identity:
+ updates:
type: object
- description: Link to the `Identity` the request was made under.
+ description: Link to the `Updates` created under the resource.
+ properties:
+ href:
+ type: string
+ verifications:
+ type: object
+ description: Link to the `Verification` that was used to verify the
+ `Merchant` that the request was made under.
properties:
href:
type: string
@@ -14087,19 +17818,31 @@ components:
enum:
- CHECKING
- SAVINGS
- - CORPORATE
- - CORP_SAVINGS
description: Details what kind of **BANK_ACCOUNT** is being used.
bank_account_validation_check:
type: string
enum:
- - NOT_ATTEMPTED
- INCONCLUSIVE
- INVALID
+ - NOT_ATTEMPTED
- VALID
default: NOT_ATTEMPTED
- description: Details the results of the bank account validation check if
- `attempt_bank_account_validation_check` is set to **true**.
+ description: "Details the results of the bank account validation check if\
+ \ `attempt_bank_account_validation_check` is set to **true** or the `Payment\
+ \ Instrument` gets used to create a `Transfer`.\n- **INCONCLUSIVE**: A\
+ \ verification check was performed, but the bank account couldn't be found\
+ \ or verified with the issuing bank. Reach out to the buyer to verify\
+ \ the details collected or request another method of payment, \n- **INVALID**:\
+ \ The `Payment Instrument` was used in transactions that returned one\
+ \ of the following ACH errors:
- **Account Does Not Allow ACH Transactions**
- **Account\
+ \ is Closed**
- **Account Funds are Frozen**
- **Deceased\
+ \ Account Holder**
- **Invalid Account Number**
- **Invalid\
+ \ Routing Number**
- **No Account on File**
. For more\
+ \ details on the different ACH failure codes, see [ACH Direct Debit.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)\n\
+ - **NOT_ATTEMPTED**: A verification check wasn't performed and the `Payment\
+ \ Instrument` hasn't been used to create a `Transfer` or `Authorization`.\n\
+ - **VALID**: The bank account was verified. The `Payment Instrument` can\
+ \ be used to create [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)"
bank_code:
type: string
description: The routing number of the bank account.
@@ -14111,13 +17854,15 @@ components:
`Payment Instrument`.
nullable: true
CreatePaymentInstrumentRequest:
- x-examples: {}
- title: ''
type: object
properties:
address:
type: object
- description: The address of the bank account or card owner.
+ description: 'The address of the card owner.
+
+
+ **Note**: Including a postal or zip code when creating a `Payment Instrument`
+ can lower the interchange on credit card transactions.'
properties:
city:
type: string
@@ -14141,10 +17886,13 @@ components:
type: integer
description: The 4-digit expiration year of the card.
identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Identity` used to create the `Payment Instrument`
+ resource.
name:
type: string
- description: The name of the bank account or card owner.
+ description: The name of the bank account or card owner. This value can
+ get truncated to comply with processor requirements.
number:
type: string
description: The card or bank account number (no dashes in between numbers).
@@ -14155,13 +17903,13 @@ components:
$ref: '#/components/schemas/Tags'
type:
type: string
+ description: Type of `Payment Instrument`.
enum:
- - BANK_ACCOUNT
- - TOKEN
- APPLE_PAY
+ - BANK_ACCOUNT
- GOOGLE_PAY
- PAYMENT_CARD
- description: Type of `Payment Instrument`.
+ - TOKEN
third_party_token:
type: string
description: Stringified token provided by Google. Required to process Google
@@ -14169,25 +17917,35 @@ components:
account_number:
type: string
description: The bank account number (no dashes in between numbers).
+ minLength: 5
+ maxLength: 17
account_type:
type: string
- description: The type of bank account.
enum:
- - CHECKING
- - SAVINGS
- - CORPORATE
- - CORP_SAVINGS
+ - BUSINESS_CHECKING
+ - BUSINESS_SAVINGS
+ - PERSONAL_CHECKING
+ - PERSONAL_SAVINGS
+ description: 'The type of bank account. Use the following respective enum
+ when creating a `Payment Instrument` for:- PERSONAL_CHECKING:
+ A personal checking account.
- PERSONAL_SAVINGS:
+ A personal savings account.
- BUSINESS_CHECKING:
+ A business checking account.
- BUSINESS_SAVINGS:
+ A business savings account.
'
attempt_bank_account_validation_check:
type: boolean
- description: Set to **true** if you want to request a bank account validation.
- Default value is **false**.
+ description: "Verify and validate the `Payment Instrument` to confirm it\
+ \ can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/)\n\
+ - Set to **True** to verify the `Payment Instrument` can be used for ACH\
+ \ payments. \n- Only `Payment Instruments` created from bank accounts\
+ \ can be used for ACH payments."
default: false
bank_code:
type: string
description: The routing number of the bank account.
- country:
- type: string
- description: 3 Letter country code (e.g. USA).
+ minLength: 9
+ maxLength: 9
+ example: '123456789'
token:
type: string
description: ID of the `Token` that was returned from the tokenization client
@@ -14197,39 +17955,76 @@ components:
description: The `id` of the identity used when registering the business
with Google Pay through our registration API.
UpdatePaymentInstrumentRequest:
- x-examples: {}
- title: ''
- description: ''
type: object
properties:
+ address:
+ $ref: '#/components/schemas/Address'
+ merchant:
+ default: false
+ type: string
+ description: The ID of the `Merchant` that the `Payment Instrument` will
+ be created under.
+ verify_payment_card:
+ type: boolean
+ description: '- Set to **true** to verify card details with the card issuer.
+
+ - Must be set to **true** to update the CVV or security code of a card.
+
+ - When set to **true**, `merchant` must also be included with your request.'
+ default: false
tags:
$ref: '#/components/schemas/Tags'
+ enabled:
+ type: boolean
+ description: Details if the `Payment Instrument` resource is enabled. Default
+ value is **true**; set to **false** to disable the `Payment Instrument`.
+ name:
+ type: string
+ default: false
+ description: The name of the bank account or card owner. This value can
+ get truncated to comply with processor requirements.
+ attempt_bank_account_validation_check:
+ type: boolean
+ default: false
+ description: "Verify and validate the `Payment Instrument` to confirm it\
+ \ can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/)\n\
+ - Set to **True** to verify the `Payment Instrument` can be used for ACH\
+ \ payments. \n- Only `Payment Instruments` created from bank accounts\
+ \ can be used for ACH payments."
PaymentInstrumentToken:
type: object
title: Payment instrument
properties:
tags:
$ref: '#/components/schemas/Tags'
+ enabled:
+ type: boolean
+ description: Details if the `Payment Instrument` resource is enabled. Set
+ to `false` to disable the `Payment Instrument`.
type:
type: string
enum:
- TOKEN
id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
- description: The ID of the resource.
+ description: The ID of the `Application` resource the `Payment Instrument`
+ was created under.
currency:
$ref: '#/components/schemas/Currency'
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Identity` used to create the `Payment Instrument`
+ resource.
instrument_type:
type: string
enum:
@@ -15468,8 +19263,20 @@ components:
- property2
description: Contains a code identifying transaction conditions at the
point of sale or point of service (only applies to card-present transactions).
+ config:
+ type: object
+ description: Configure how the `Processor` handles transaction details,
+ specifc to the processor.
+ nullable: true
+ properties:
+ canDebitBankAccount:
+ type: boolean
+ description: Details if the `Application` can debit bank accounts using
+ the `Processor`.
default_merchant_profile:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Merchant Profile` resource used to create the
+ `Processor`.
enabled:
type: boolean
description: Details if the `Processor` resource is enabled. Set to **false**
@@ -15750,7 +19557,8 @@ components:
items:
$ref: '#/components/schemas/Country'
business_application_id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Application` linked to the `Processor`.
class_key_identifier:
type: string
enum:
@@ -15918,7 +19726,8 @@ components:
description: ''
properties:
id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Settlement` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
@@ -15940,9 +19749,11 @@ components:
(usually **null**).
nullable: true
identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Identity` used to create the `Settlement` resource.
merchant_id:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Merchant` used to create the `Settlement` resource.
net_amount:
type: integer
description: The amount in cents that will be deposited into the merchant's
@@ -15960,11 +19771,10 @@ components:
enum:
- APPROVED
- AWAITING_APPROVAL
- - CANCELLED
- PENDING
description: The status of the `Settlement`. Available values include:- **PENDING**
- **AWAITING_APPROVAL**
- **APPROVED**.
Merchants only receive payouts when `Settlements` are **APPROVED** and
- receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/payouts/).
+ receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/).
tags:
$ref: '#/components/schemas/Tags'
total_amount:
@@ -16067,7 +19877,6 @@ components:
$ref: '#/components/schemas/ListLinks'
Transfer:
type: object
- description: ''
x-examples: {}
properties:
id:
@@ -16079,10 +19888,23 @@ components:
$ref: '#/components/schemas/UpdatedAt'
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
+ additional_healthcare_data:
+ $ref: '#/components/schemas/AdditionalHealthcareData'
+ additional_purchase_data:
+ $ref: '#/components/schemas/AdditionalPurchaseData'
+ address_verification:
+ type: string
+ description: Details the results of the Address Verification checks.
+ nullable: true
amount:
$ref: '#/components/schemas/Amount'
+ amount_requested:
+ type: integer
+ description: Details the `amount` that was requested to get debited from
+ the `source` when the transaction was created.
application:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Application` the `Transfer` was created under.
card_present_details:
$ref: '#/components/schemas/CardPresentDetails'
currency:
@@ -16092,7 +19914,9 @@ components:
description: The ID of the destination.
nullable: true
device:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Device` resource the `Transfer` was created
+ under.
externally_funded:
type: string
description: Details if the `Transfer` will be settled externally by card
@@ -16104,14 +19928,43 @@ components:
fee:
type: integer
format: int64
- description: The amount of the `Transfer` you'd like to collect as your
- fee in cents. Defaults to zero (must be less than or equal to the `amount`).
+ description: "The minimum amount of the `Transfer` you'd like to collect\
+ \ as your fee in cents. Defaults to zero (must be less than or equal to\
+ \ the `amount`).\n- If the fees applied by the 'Fee Profile' are ***higher***\
+ \ than the value passed in 'fee', 'fee' will not be applied and have no\
+ \ effect.\n- If the fees applied by the 'Fee Profile' are ***lower***\
+ \ than the value passed in 'fee', an additional fee is be applied, in\
+ \ addition to the fees generated by the `Fee Profile`.\n - The additional\
+ \ fee is equal to the difference between the value passed in 'fee' and\
+ \ the fees generated by the `Fee Profile`.\nfraud_session_id:"
fee_type:
$ref: '#/components/schemas/FeeType'
idempotency_id:
$ref: '#/components/schemas/IdempotencyId'
+ merchant:
+ type: string
+ description: The ID of the `Merchant` resource the `Transfer` was created
+ under.
+ example: MUxxxxxxxxxxxxxxxxxxxxxxx
merchant_identity:
- $ref: '#/components/schemas/Id'
+ type: string
+ example: IDxxxxxxxxxxxxxxxxxxxxxxxx
+ description: The ID of `Identity` resource used by the `Merchant` the `Transfer`
+ was created under.
+ parent_transfer:
+ type: string
+ description: '- ID of the original parent `Transfer` where the transaction
+ occurred.
+
+ - Only appears for `Transfers:type` **REVERSAL** and **FEE**.'
+ nullable: true
+ parent_transfer_trace_id:
+ type: string
+ description: '- `trace_id` of the original parent `Transfer` where the transaction
+ occurred.
+
+ - Only appears for `Transfers:type` **REVERSAL** and **FEE**.'
+ nullable: true
messages:
$ref: '#/components/schemas/Messages'
raw:
@@ -16121,8 +19974,22 @@ components:
format: date-time
description: Timestamp of when the `Transfer` is ready to be settled at.
nullable: true
+ security_code_verification:
+ type: string
+ description: Details the results of the Security Code Verification checks.
+ nullable: true
source:
- $ref: '#/components/schemas/Id'
+ type: string
+ description: The ID of the `Payment Instrument` that will be debited and
+ performing the `Transfer`.
+ nullable: true
+ split_transfers:
+ type: string
+ description: '- The ID of the `split_transfer` resources moving funds from
+ the primary `Transfer` to the specified `Merchants.`
+
+ - Only used for Split Transactions. For more information, see [Split Transactions](/docs/guides/payments/modify/split-transactions/).'
+ nullable: true
state:
type: string
enum:
@@ -16134,8 +20001,9 @@ components:
description: The stauts of the `Transfer`.
statement_descriptor:
type: string
- description: The description of the merchant that appears on the buyer's
- bank or card statement.
+ description: - The description of the seller that appears on the buyer's
+ bank or card statement.
- statement_descriptors for `Transfers`
+ in live enviroments will have a FI * prefix.
nullable: true
subtype:
type: string
@@ -16182,7 +20050,6 @@ components:
description: Type of `Transfer`.
_links:
type: object
- additionalProperties: true
description: For your convenience, every response includes several URLs
which link to resources relevant to the request. You can use these `_links`
to make your follow-up requests and quickly access relevant IDs.
@@ -16270,8 +20137,6 @@ components:
type: string
CreateTransferRequest:
type: object
- title: CreateTransferRequest
- description: Create a `transfer`.
properties:
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
@@ -16284,8 +20149,8 @@ components:
amount:
type: integer
format: int64
- description: The total amount that will be debited in cents (e.g. 100 cents
- to debit $1.00).
+ description: The total amount that will be debited from the buyer in cents
+ (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
destination:
@@ -16296,123 +20161,70 @@ components:
type: string
description: The ID of the activated device.
nullable: true
- device_configuration:
- $ref: '#/components/schemas/ConfigurationDetails'
fee:
type: integer
format: int64
- description: The amount of the `Transfer` you'd like to collect as your
- fee in cents. Defaults to zero (must be less than or equal to the `amount`).
+ description: "The minimum amount of the `Transfer` you'd like to collect\
+ \ as your fee in cents. Defaults to zero (must be less than or equal to\
+ \ the `amount`).\n- If the fees applied by the 'Fee Profile' are ***higher***\
+ \ than the value passed in 'fee', 'fee' will not be applied and have no\
+ \ effect.\n- If the fees applied by the 'Fee Profile' are ***lower***\
+ \ than the value passed in 'fee', an additional fee is be applied, in\
+ \ addition to the fees generated by the `Fee Profile`.\n - The additional\
+ \ fee is equal to the difference between the value passed in 'fee' and\
+ \ the fees generated by the `Fee Profile`."
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
+ hsa_fsa_payment:
+ $ref: '#/components/schemas/HSAFSAPayment'
idempotency_id:
type: string
- description: A randomly generated value that'll be associated with the request.
+ description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
- description: ID of the `Merchant` the `Transfer` was created under.
+ description: "- ID of the primary `Merchant` that's processing the `Transfer`\
+ \ for the buyer. \n- In Split Transactions, the `Merchant` specified in\
+ \ the `Transfer` request is the primary `Merchant`."
nullable: true
operation_key:
type: string
enum:
- - PUSH_TO_CARD
- - PULL_FROM_CARD
- CARD_PRESENT_DEBIT
- CARD_PRESENT_UNREFERENCED_REFUND
- - SALE
- - UNREFERENCED_REFUND
- MERCHANT_CREDIT_ADJUSTMENT
- MERCHANT_DEBIT_ADJUSTMENT
- description: Details the operation that'll be performed in the transaction.
+ - PULL_FROM_CARD
+ - PUSH_TO_CARD
+ - SALE
+ - UNREFERENCED_REFUND
+ description: Details the operation that's be performed in the transaction.
nullable: true
- payment_instrument:
- type: object
- title: CardPresentInstrumentForm
- description: 'Details the `Payment Instrument` that the `Transfer` debits
- or credits. '
- properties:
- type:
- type: string
- enum:
- - BANK_ACCOUNT
- - VIRTUAL
- - TOKEN
- - SWIPED_PAYMENT_CARD
- - PAYMENT_CARD_PRESENT
- - PAYMENT_CARD
- - VANTIV_OMNI_TOKEN
- description: The type of `Payment Instrument`.
- available_account_type:
- type: string
- enum:
- - BALANCE
- - LEDGERED
- emv_data:
- type: string
- description: Encrypted card data used to process the transaction.
- emv_data_key_serial_number:
- type: string
- description: Encrypted EMV card data about the key serial number used
- to process the transaction.
- encrypted_emv_data:
- type: string
- description: Encrypted EMV card data. Required if using an encrypted
- device.
- encrypted_emv_format:
- type: integer
- format: int64
- description: EMV encryption format provided from integrated encryption
- devices (defaults to **0**).
- expiration_month:
- type: integer
- format: int64
- description: Expiration month of the `Payment Instrument` (e.g. 12 for
- December).
- expiration_year:
- type: integer
- format: int64
- description: 4-digit expiration year of the `Payment Instrument`.
- first_name:
- type: string
- description: The first name of the `Payment Instrument` owner.
- last_name:
- type: string
- description: The last name of the `Payment Instrument` owner.
- name:
- type: object
- title: Name
- properties:
- first_name:
- type: string
- description: The first name of the `Payment Instrument` owner.
- full_name:
- type: string
- description: The full name of the `Payment Instrument` owner.
- last_name:
- type: string
- description: The last name of the `Payment Instrument` owner.
- value:
- type: string
- number:
- type: string
- description: Primary card account number (no dashes in between numbers).
processor:
type: string
description: Name of the transaction processor.
source:
type: string
description: ID of the `Payment Instrument` where funds get debited.
+ security_code:
+ type: string
+ description: The 3-4 digit security code for the card (i.e. CVV code). Include
+ the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/)
+ with the created `Transfer`.
+ nullable: true
statement_descriptor:
type: string
- description: The description of the transaction that appears on the buyer's
- bank or card statement.
+ description:
- The description of the transaction that appears on the
+ buyer's bank or card statement.
- statement_descriptors
+ for `Transfers` in live enviroments will have a FI
+ * prefix.
+ maxLength: 20
nullable: true
tags:
$ref: '#/components/schemas/Tags'
3d_secure_authentication:
type: object
- description: The 3D secure information for an authorization.
+ description: The 3D secure information required to create a 3D secure `Transfer.`
nullable: true
properties:
cardholder_authentication:
@@ -16422,17 +20234,49 @@ components:
each authentication transaction.
cardholder_ip_address:
type: string
- description: Only required for American Express cards. Format is nnn.nnn.nnn.nnn
+ description: Only required for **American Express** cards.
+ example: 189.1.126.240
electronic_commerce_indicator:
type: string
- description: 'AUTHENTICATED: Approved by 3D Secure Vendor; ATTEMPTED:
- Issuer or cardholder does not support 3D Secure'
+ description: '- **AUTHENTICATED**: Approved by 3D Secure Vendor.
+
+ - **ATTEMPTED**: Issuer or cardholder does not support 3D Secure.'
transaction_id:
type: string
- description: Only valid for Visa transactions
- required:
- - amount
- - currency
+ description: Only required for **Visa** cards.
+ required:
+ - cardholder_authentication
+ - electronic_commerce_indicator
+ 'additional_purchase_data ':
+ $ref: '#/components/schemas/L3AdditionalPurchaseData'
+ device_configuration:
+ $ref: '#/components/schemas/ConfigurationDetails'
+ split_transfers:
+ type: object
+ description: '- An array used to detail how funds from the `Transfer` will
+ split and the amount `Merchants` receive.
+
+ - The combined `amounts` under `split_transfers` must be equal to the
+ `amount` submitted in the parent `Transfer.`
+
+ - For more information, see [Split Transactions](/docs/guides/payments/modify/split-transactions/).'
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: '- The amount of funds that get split and paid out to the
+ specified `Merchant`.
+
+ - Must be less than or equal to the `amount` of the `Transfer.`'
+ merchant:
+ type: string
+ description: '- The ID of the `Merchant` that will receive the specified
+ `amount` under the `split_transfers` object.
+
+ - In Split Transactions, the `Merchants` specified in the `split_transfers`
+ object are the ancillary `Merchants.`'
+ tags:
+ $ref: '#/components/schemas/Tags'
TransfersList:
type: object
description: ''
@@ -16482,7 +20326,8 @@ components:
- ROLE_PARTNER
- ROLE_MERCHANT
type: string
- description: Details the level of access the [`User`](#tag/Users) has available.
+ description: Details the level of access the [`User`](/api/tag/Users) has
+ available.
tags:
$ref: '#/components/schemas/Tags'
_links:
@@ -16594,9 +20439,45 @@ components:
type: object
payment_instrument:
type: string
- description: The `Payment Instrument` that'll be used to settle the `Merchant's`
+ description: The `Payment Instrument` that's used to settle the `Merchant's`
processed funds.
nullable: true
+ payment_instrument_verification_details:
+ type: object
+ description: Details the verification results of `Payment Instruments`.
+ properties:
+ push_to_card_domestic:
+ type: string
+ description: Details if the `Payment Instrument` supports push and pull
+ from card, domestically. For more details, see [Push to Card](/guides/push-pull/).
+ enum:
+ - FAST_FUNDS
+ - NON_FAST_FUNDS
+ - NOT_SUPPORTED
+ - UNKNOWN
+ push_to_card_cross_border:
+ type: string
+ description: Details if the `Payment Instrument` supports push and pull
+ from card, cross-border. For more details, see [Push to Card](/guides/push-pull/).
+ enum:
+ - FAST_FUNDS
+ - NON_FAST_FUNDS
+ - NOT_SUPPORTED
+ - UNKNOWN
+ card_type:
+ type: string
+ description: The type of card. Same value as `Payment Instrument#type`.
+ enum:
+ - CREDIT
+ - DEBIT
+ - HSA_FSA
+ - NON_RELOADABLE_PREPAID
+ - RELOADABLE_PREPAID
+ - UNKNOWN
+ billing_currency:
+ $ref: '#/components/schemas/Currency'
+ issuer_country:
+ $ref: '#/components/schemas/Country'
processor:
type: string
description: Name of the verification processor.
@@ -16617,7 +20498,6 @@ components:
`trace_id` so you can track the verification end-to-end.
_links:
type: object
- additionalProperties: true
description: For your convenience, every response includes several URLs
which link to resources relevant to the request. You can use these `_links`
to make your follow-up requests and quickly access relevant IDs.
@@ -16642,19 +20522,41 @@ components:
type: string
CreateVerificationRequest:
type: object
- title: CreateVerificationRequest
- x-examples: {}
properties:
- identity:
- type: string
- description: ID of the `Identity` resource associated with the `Merchant`.
merchant:
type: string
- description: The ID of the `Merchant`.
+ description: '- The ID of the `Merchant`.
+
+ - Must be included when `verify_payment_card` is set to **true**.'
processor:
- $ref: '#/components/schemas/ProcessorRequest'
+ type: string
+ enum:
+ - DUMMY_V1
+ - MASTERCARD_V1
+ - VISA_V1
+ default: DUMMY_V1
+ description: 'Set the acquiring processor. Avalible values include:
- DUMMY_V1
- MASTERCARD_V1
- VISA_V1
Use
+ DUMMY_V1 or null to use your sandbox.
+ For more details on which processor to use, reach out to your Finix point
+ of contact or email Finix
+ Support.'
+ security_code:
+ type: string
+ description: The ID of the `Merchant`.
+ verify_payment_card:
+ type: boolean
+ description: '- Set to **true** to verify card details with the card issuer.
+
+ - Must be set to **true** to update the CVV or security code of a card.
+
+ - When set to **true**, `merchant` must also be included with your request.'
tags:
$ref: '#/components/schemas/Tags'
+ address:
+ $ref: '#/components/schemas/Address'
+ identity:
+ type: string
+ description: ID of the `Identity` resource associated with the `Merchant`.
VerificationsList:
type: object
x-examples:
@@ -16743,7 +20645,8 @@ components:
under.
authentication:
type: object
- description: The authentication settings that are used to send webhook events.
+ description: The [authentication settings](/guides/developers/webhooks/#authenticating-webhooks)
+ that are used to send webhook events.
properties:
type:
type: string
@@ -16763,6 +20666,17 @@ components:
description: 'Details if the `Webhook` is enabled:- true:
Events are being sent to the `url`.
- false: Events
are not being sent.'
+ enabled_events:
+ $ref: '#/components/schemas/WebhookEnabledEvents'
+ previous_secret_expires_at:
+ type: string
+ description: The time when the previous `secret_signing_key` will expire.
+ This is **null** when the webhook is initially created.
+ nullable: true
+ secret_signing_key:
+ type: string
+ description: The secret signing key that gets used to verify webhook events.
+ nullable: true
url:
type: string
description: The HTTP or HTTPS URL where callbacks (i.e. events) will be
@@ -16818,9 +20732,15 @@ components:
fee:
type: integer
format: int64
- description: The amount of the `Authorization` you'd like to collect as
- your fee in cents. Defaults to zero (must be less than or equal to the
- `amount`).
+ description: "The minimum amount of the `Authorization` you'd like to collect\
+ \ as your fee in cents. Defaults to zero (must be less than or equal to\
+ \ the `amount`).\n- If the fees applied by the 'Fee Profile' are ***higher***\
+ \ than the value passed in 'fee', 'fee' will not be applied and have no\
+ \ effect.\n- If the fees applied by the 'Fee Profile' are ***lower***\
+ \ than the value passed in 'fee', an additional fee is be applied, in\
+ \ addition to the fees generated by the `Fee Profile`.\n - The additional\
+ \ fee is equal to the difference between the value passed in 'fee' and\
+ \ the fees generated by the `Fee Profile`."
tags:
$ref: '#/components/schemas/Tags'
void_me:
@@ -16829,9 +20749,17 @@ components:
Tags:
type: object
title: tags
- description: Key value pair for annotating custom meta data (e.g. order numbers).
- additionalProperties:
- type: string
+ description: 'Include up to 50 `key`: **value** pairs to annotate requests with
+ custom metadata.
+
+ - Maximum character length for individual `keys` is 40.
+
+ - Maximum character length for individual **values** is 500.
+
+
+ (e.g., `order number`: **25**, `item_type`: **produce**, `department`: **sales**,
+ etc.)'
+ nullable: true
UpdateTransferRequest:
title: TransferUpdate
type: object
@@ -16840,8 +20768,9 @@ components:
$ref: '#/components/schemas/Tags'
CreateReversalRequest:
type: object
- title: Refund a Transfer
properties:
+ idempotency_id:
+ $ref: '#/components/schemas/IdempotencyId'
refund_amount:
type: integer
description: The amount of the refund in cents. It must be equal to or less
@@ -16863,13 +20792,38 @@ components:
avalible.
example: CARD_PRESENT_UNREFERENCED_REFUND
nullable: true
- CreateWebhookRequest:
- title: WebhookCreate
- type: object
- properties:
- authentication:
+ split_transfers:
type: object
- description: The authentication settings that are used to send webhook events.
+ description: '- An array used to detail how funds from the `Transfer` will
+ split and the amount `Merchants` receive.
+
+ - The combined `amounts` under `split_transfers` must be equal to the
+ `amount` submitted in the parent `Transfer.`
+
+ - For more information, see [Split Transactions](/docs/guides/payments/modify/split-transactions/).'
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: '- The amount of funds that get split and paid out to the
+ specified `Merchant`.
+
+ - Must be less than or equal to the `amount` of the `Transfer.`'
+ merchant:
+ type: string
+ description: '- The ID of the `Merchant` that will receive the specified
+ `amount` under the `split_transfers` object.
+
+ - In Split Transactions, the `Merchants` specified in the `split_transfers`
+ object are the ancillary `Merchants.`'
+ CreateWebhookRequest:
+ title: WebhookCreate
+ type: object
+ properties:
+ authentication:
+ type: object
+ description: The [authentication settings](/guides/developers/webhooks/#authenticating-webhooks)
+ that are used to send webhook events.
properties:
basic:
type: object
@@ -16907,6 +20861,8 @@ components:
type: boolean
description: Set to false to disable Webhooks. Default value when created
is true.
+ enabled_events:
+ $ref: '#/components/schemas/WebhookEnabledEvents'
url:
type: string
description: The HTTP or HTTPS URL where callbacks (i.e. events) will be
@@ -17569,12 +21525,23 @@ components:
nullable: true
application:
type: string
- description: The ID of the resource.
+ description: The ID of the `Application` associated with the `Fee Profile`.
basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each
card-based `Transfer`. Calculated as one hundredth of one percent (1 basis
point = .0001 or .01%).
+ card_cross_border_basis_points:
+ type: integer
+ description: Percentage-based fee charged against the full amount of every
+ `Transfer` that includes non-US cards. Calculated as one hundredth of
+ one percent (1 basis point = .0001 or .01%).
+ nullable: true
+ card_cross_border_fixed_fee:
+ type: integer
+ description: Fee in cents charged against every `Transfer` that includes
+ non-US cards.
+ nullable: true
charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for card-based `Transfers`.
@@ -17713,8 +21680,6 @@ components:
description:
- Include AGGREGATE if you want to round
after the settlement calculation.
- By default, rounding happens before
the sum of the settlement calculation (i.e. round each fee transfer)
- tags:
- $ref: '#/components/schemas/Tags'
visa_acquirer_processing_fixed_fee:
type: integer
description: Applied to all U.S.-based credit card authorizations acquired
@@ -17764,14 +21729,8 @@ components:
description: ''
type: object
x-examples: {}
+ title: ''
properties:
- config:
- type: object
- description: Configure the details of how a `Processor` handles transactions.
- properties:
- canDebitBankAccount:
- type: boolean
- description: Details if a `Processor` can debit bank accounts.
tags:
$ref: '#/components/schemas/Tags'
type:
@@ -17780,7 +21739,6 @@ components:
description: The type of processor. Use **DUMMY_V1** for sandbox.
required:
- type
- title: ''
ProcessorRequest:
description: 'Set the acquiring processor. Avalible values include: - DUMMY_V1
- LITLE_V1
- MASTERCARD_V1
- VISA_V1
- NMI_V1
- VANTIV_V1
Use
DUMMY_V1 or null to use your sandbox. For
@@ -17799,8 +21757,7 @@ components:
Address:
title: Address
type: object
- description: Principal's personal home address. This field is used for `Identity`
- verification purposes.
+ description: Address of the account owner.
nullable: true
properties:
city:
@@ -18103,7 +22060,7 @@ components:
Id:
title: Id
type: string
- description: The ID of the resource.
+ description: The ID of the related resource.
x-examples:
example-1: string
nullable: true
@@ -18164,7 +22121,7 @@ components:
- ANCILLARY_FIXED_FEE_PRIMARY
- ANCILLARY_FIXED_FEE_SECONDARY
- SETTLEMENT_V2_TRANSFER
- description: The type of fee.
+ description: Details the type of fee if the `Transfer` includes a `fee`.
Raw:
title: Raw
description: Raw response from the processor.
@@ -18174,16 +22131,17 @@ components:
IdempotencyId:
title: IdempotencyId
type: string
- description: ID to [idempotently](#section/Idempotency-Requests) identifty the
- transfer.
+ description: Pass any randomly generated or internal ID to [idempotently](/api/overview/#section/Idempotency-Requests)
+ identify `Transfers`, `Authorizations`, and refund requests.
nullable: true
Messages:
title: Messages
type: array
- items:
- type: string
description: Message field that provides additional details. This field is typically
**null**.
+ nullable: true
+ items:
+ type: string
CreateBalanceTransferRequest:
title: CreateBalanceTransferRequest
x-stoplight:
@@ -18499,10 +22457,7 @@ components:
$ref: '#/components/schemas/ListLinks'
CreateExternalLinkRequest:
type: object
- x-examples:
- example-1:
- type: UPLOAD
- duration: 15
+ x-examples: {}
title: CreateExternalLinkRequest
properties:
duration:
@@ -18582,14 +22537,15 @@ components:
AdditionalPurchaseData:
title: AdditionalPurchaseData
x-stoplight:
- id: 1dey3tmn0hj6l
+ id: e98e7635f242c
type: object
- description: Additional information about the purchase. Used for Level 2 and
- Level 3 Processing.
+ description: Additional information about the purchase. Used for [Level 2 and
+ Level 3 Processing](/guides/payments/modify/level-2-and-level-3-processing/).
properties:
customer_reference_number:
type: string
description: The customer reference for the purchase (max 17 characters).
+ maxLength: 17
customs_duty_amount:
type: integer
description: The duty in cents on the total purchase amount for the order
@@ -18599,12 +22555,14 @@ components:
destination_postal_code:
type: string
description: The postal code of the order destination (10 characters)
+ maxLength: 10
discount_amount:
type: integer
description: The amount in cents of the discount for the order.
invoice_reference_number:
type: string
description: The order's invoice number (max 15 characters)
+ maxLength: 15
item_data:
type: array
description: Additional information about the transaction. Used for Level
@@ -18614,10 +22572,16 @@ components:
properties:
amount_excluding_sales_tax:
type: integer
- description: Total cost in cents of the line item excluding tax.
+ description: '- Total cost of the line item in cents, excluding tax.
+
+ - Must align with `sales_tax` so `amount_excluding_sales_tax` +
+ `sales_tax` = `amount_including_sales_tax`.'
amount_including_sales_tax:
type: integer
- description: Total cost in cents of the line item including tax.
+ description: '- Total cost of the line item in cents, including tax.
+
+ - Must align with `sales_tax` so `amount_excluding_sales_tax` +
+ `sales_tax` = `amount_including_sales_tax`.'
commodity_code:
type: string
description: A commodity code is a numeric code representing a particular
@@ -18625,12 +22589,14 @@ components:
Purchasing. The code can be 3, 5, 7, or 11 digits in length. The
longer the code the more granular the description of the product/service.
(max 12 characters).
+ maxLength: 12
cost_per_unit:
type: integer
description: The price in cents of one unit of the item purchased
item_description:
type: string
description: Required when `item_data` is supplied (max 25 characters)
+ maxLength: 25
item_discount_amount:
type: integer
description: 'Item discount amount in cents
@@ -18639,12 +22605,16 @@ components:
merchant_product_code:
type: string
description: Merchant defined product code (max 12 characters).
+ maxLength: 12
quantity:
type: integer
description: The number of items purchased. Must be greater than 0.
+ minimum: 1
+ maximum: 99
unit_of_measure:
type: string
description: The unit of measure of the purchased item (max 3 characters).
+ maxLength: 3
order_date:
type: object
properties:
@@ -18657,15 +22627,18 @@ components:
year:
type: integer
description: Year of purchase (4-digit)
+ minimum: 1990
sales_tax:
type: integer
- description: "Total aggregate tax amount in cents for the entire purchase.\
+ description: "- Total aggregate tax amount in cents for the entire purchase.\
\ Field is automatically calculated if you pass in the itemized tax amounts.\
- \ \n\nFor non-taxable transactions either set `sales_tax` to 0 or omit\
- \ from payload and also set `tax_exempt` to **True**."
+ \ \n- For non-taxable transactions either set `sales_tax` to 0 or omit\
+ \ from payload and also set `tax_exempt` to **True**.\n- Request must\
+ \ align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`."
ship_from_postal_code:
type: string
description: The postal code from where order is shipped (10 characters)
+ maxLength: 10
shipping_amount:
type: integer
description: 'The shipping cost in cents for the order.
@@ -18673,7 +22646,12 @@ components:
'
tax_exempt:
type: boolean
- description: For tax exempt purchases set to True.
+ description: '- For tax exempt purchases set to **True**.
+
+ - If set to **True**, request can''t include `sales_tax`.'
+ required:
+ - customer_reference_number
+ - sales_tax
ApplePaySessionRequest:
type: object
x-examples:
@@ -18788,43 +22766,14 @@ components:
type: boolean
description: Allow transaction to be processed on Debit rails. If `false`,
Debit card transactions will be processed on Credit rails.
- allow_partial_approvals:
- type: boolean
- description: Determines if a transaction can be partially approved (Usually
- **null**).
bypass_device_on_capture:
type: boolean
description: Sets whether the device will be used to capture `Authorizations`.
The device is required to be connected if `bypass_device_on_capture` is
set to false. (defaults to true).
- cashback_options:
- type: object
- properties:
- manual_entry:
- type: object
- properties:
- amount_increment:
- type: integer
- maximum_amount:
- type: integer
- selection_amounts:
- type: string
check_for_duplicate_transactions:
type: boolean
description: Sets whether the device will check for duplicate transactions.
- is_cash_back_allowed:
- type: boolean
- description: Sets whether the device will allow cash back.
- is_gift_supported:
- type: string
- description: Sets whether the device will allow gifting funds.
- is_manual_entry_allowed:
- type: boolean
- description: Sets whether the device will process payment details entered
- manually.
- market_code:
- type: string
- description: Used by the processor to handle the `transfer`. Usually **null**.
prompt_amount_confirmation:
type: boolean
description: Sets if the card holder needs to confirm the amount they will
@@ -18843,15 +22792,6 @@ components:
type: integer
description: The threshold to prompt a signature when `prompt_signature`
is set to **AMOUNT** (defaults to 0).
- tip_options:
- type: object
- properties:
- type:
- type: string
- other_options:
- type: string
- tip_selections:
- type: string
CardPresentDetails:
title: CardPresentDetails
x-stoplight:
@@ -18935,6 +22875,8 @@ components:
type: boolean
description: Set to false to disable `Webhooks`. Default value when created
is true.
+ enabled_events:
+ $ref: '#/components/schemas/WebhookEnabledEvents'
url:
type: string
description: The HTTP or HTTPS url where the callbacks will be sent via
@@ -18945,6 +22887,7 @@ components:
x-stoplight:
id: fylqbqcpw7nuv
format: binary
+ description: The file in question will begin to download.
PageCursor:
title: PageCursor
x-stoplight:
@@ -18965,7 +22908,7 @@ components:
id: lo8jqmipa7376
type: string
description: The code of the failure so the decline can be handled programmatically.
- For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).
+ For more info on how to handle the failure, see [Failure Codes](/guides/developers/errors/#failure-codes).
nullable: true
FailureMessage:
title: FailureMessage
@@ -18981,7 +22924,7 @@ components:
id: x00www7a3mlv6
type: string
description: The `fraud_session_session` ID you want to review for fraud. For
- more info, see [Fraud Detection](/docs/guides/payments/fraud-detection/).
+ more info, see [Fraud Detection](/guides/payments/fraud-detection/).
OperationKey:
type: string
title: OperationKey
@@ -18997,7 +22940,7 @@ components:
- MERCHANT_CREDIT_ADJUSTMENT
- MERCHANT_DEBIT_ADJUSTMENT
- CARD_PRESENT_AUTHORIZATION
- description: Details the operation that'll be performed in the transaction (Card
+ description: Details the operation that's performed in the transaction (Card
present transactions only) .
nullable: true
PageOffset:
@@ -19047,27 +22990,38 @@ components:
id:
type: string
description: ID of the `compliance_form`.
- type:
- type: string
- description: 'Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.'
- enum:
- - PCI_SAQ_A
- state:
- type: string
- description: The state of the `compliance_form`.
- enum:
- - PENDING
- - COMPLETED
- - INVALID
- - INCOMPLETE
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
+ application_id:
+ description: The ID of the `Application` the `compliance_form` was created
+ under.
+ type: string
+ example: APdoThHn4jjYUSxQf76txAgg
+ compliance_form_template:
+ type: string
+ description: Template linked to this `compliance_form`.
due_at:
type: string
description: Timestamp of when the `compliance_form` must be completed by.
format: date-time
+ files:
+ type: object
+ description: Details about the `File` resoruce where the `compliance_form`
+ was uploaded.
+ properties:
+ signed_file:
+ type: string
+ description: '- Autofills to null.
+
+ - When a compliance_form is attested, signed_file
+ will contain a File corresponding to the signed version
+ of the form.
'
+ nullable: true
+ unsigned_file:
+ type: string
+ description: ID of the `File` resource that has the `compliance_form`.
linked_to:
type: string
description: The ID of the `merchant` linked to the `compliance_form`.
@@ -19079,18 +23033,6 @@ components:
description: Details used to fille out the PCI Self-Assessment Questionnaire
(SAQ).
properties:
- name:
- type: string
- description: Name of the person completing (aka attesting to) the `compliance_form`.
- nullable: true
- signed_at:
- type: string
- description: Timestamp of the person attesting to this `compliance_form`.
- nullable: true
- user_agent:
- type: string
- description: User agent of the person attesting to this `compliance_form`.
- nullable: true
ip_address:
type: string
description: IP address of the person attesting to this `compliance_form`.
@@ -19100,27 +23042,39 @@ components:
description: If all `pci_saq_a` fields are all submitted, `is_accepted`
updates to **true**.
nullable: true
+ name:
+ type: string
+ description: Name of the person completing (aka attesting to) the `compliance_form`.
+ nullable: true
+ signed_at:
+ type: string
+ description: Timestamp of the person attesting to this `compliance_form`.
+ nullable: true
title:
type: string
description: Title or role of the person completing (aka attesting to)
the `compliance_form`.
nullable: true
- files:
- type: object
- description: Details about the `File` resoruce where the `compliance_form`
- was uploaded.
- properties:
- unsigned_file:
- type: string
- description: ID of the `File` resource that has the `compliance_form`.
- signed_file:
+ user_agent:
type: string
- description: '- Autofills to null.
-
- - When a compliance_form is attested, signed_file
- will contain a File corresponding to the signed version
- of the form.
'
+ description: User agent of the person attesting to this `compliance_form`.
nullable: true
+ state:
+ type: string
+ description: The state of the `compliance_form`.
+ enum:
+ - PENDING
+ - COMPLETE
+ - INVALID
+ - INCOMPLETE
+ example: INCOMPLETE
+ tags:
+ $ref: '#/components/schemas/Tags'
+ type:
+ type: string
+ description: 'Type of `compliance_form`. There is one available value: **PCI_SAQ_A**.'
+ enum:
+ - PCI_SAQ_A
valid_from:
type: string
description: Timestamp of when the `compliance_form` becomes active and
@@ -19130,11 +23084,12 @@ components:
type: string
description: Timestamp of when the `compliance_form` is no longer active
and valid.
- compliance_form_template:
+ version:
type: string
- description: Template linked to this `compliance_form`.
- tags:
- $ref: '#/components/schemas/Tags'
+ description: Details the version of the SAQ form. When `compliance_forms`
+ are created, Finix automatically provides the most up-to-date SAQ form
+ that's available.
+ title: ''
UpdateComplianceFormRequest:
type: object
x-examples: {}
@@ -19143,254 +23098,1587 @@ components:
type: object
description: Details used to fille out the PCI Self-Assessment Questionnaire.
properties:
+ ip_address:
+ type: string
+ description: IP address of the person attesting to this `compliance_form`.
name:
type: string
description: Name of the person completing (aka attesting to) the `compliance_form`.
signed_at:
type: string
- description: Timestamp of the person attesting to this `compliance_form`.
- user_agent:
+ description: Timestamp of the person attesting to this `compliance_form`.
+ title:
+ type: string
+ description: "Title or role of the person completing (aka attesting\
+ \ to)\n the `compliance_form`."
+ user_agent:
+ type: string
+ description: User agent of the person attesting to this `compliance_form`.
+ CreateOnboardingFormRequest:
+ type: object
+ x-examples: {}
+ title: CreateOnboardingFormRequest
+ properties:
+ onboarding_data:
+ $ref: '#/components/schemas/OnboardingFormOnboardingData'
+ merchant_processors:
+ type: array
+ description: An array of objects with the processors and gateways users
+ will be onboarded to.
+ items:
+ type: object
+ properties:
+ processor:
+ type: string
+ description: The name of the processor you plan to onboard users to.
+ onboarding_link_details:
+ type: object
+ description: The information of the initial onboarding link. This is only
+ provided when creating an `onboarding_form`.
+ properties:
+ expiration_in_minutes:
+ type: string
+ description: How long (in minutes) the link should be valid for. Defaults
+ to 60 minutes.
+ expired_session_url:
+ type: string
+ description: The URL users get sent to if the bearer token expires.
+ fee_details_url:
+ type: string
+ description: The URL of the page where you display the fees related
+ to processing payments (for more info, see [Displaying Processing
+ Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
+ return_url:
+ type: string
+ description: The URL users get sent to after completing the onboarding
+ flow.
+ terms_of_service_url:
+ type: string
+ description: Your Terms of Service URL. The URL is provided to users
+ for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).
+ tags:
+ $ref: '#/components/schemas/Tags'
+ OnboardingForm:
+ type: object
+ x-examples: {}
+ title: OnboardingForm
+ properties:
+ id:
+ type: string
+ description: The ID of the `onboarding_form` resource.
+ created_at:
+ $ref: '#/components/schemas/CreatedAt'
+ updated_at:
+ $ref: '#/components/schemas/UpdatedAt'
+ merchant_processors:
+ type: array
+ description: An array of objects with the processors and gateways users
+ will be onboarded to.
+ items:
+ type: object
+ properties:
+ processor:
+ type: string
+ description: The name of the processor you plan to onboard users to.
+ onboarding_data:
+ $ref: '#/components/schemas/OnboardingFormOnboardingData'
+ onboarding_link:
+ type: object
+ description: The information of the initial onboarding link. This is only
+ provided when creating an `onboarding_form`.
+ properties:
+ expires_at:
+ type: string
+ description: A UTC timestamp detailing when the onboarding form expires
+ and will no longer be available via `link_url`. To generate a new
+ link to the same form, see [Get an Onboarding Form URL](/guides/onboarding/onboarding-form/#get-an-onboarding-form-url).
+ link_url:
+ type: string
+ description: The URL of the user's Finix Onboarding Form. Users can
+ use the `link_url` to return to the form until the link expires.
+ status:
+ type: string
+ description: Status of the `onboarding_from`.
+ enum:
+ - IN_PROGRESS
+ - COMPLETED
+ tags:
+ $ref: '#/components/schemas/Tags'
+ CreateOnboardingFormLinkRequest:
+ type: object
+ x-examples: {}
+ title: CreateOnboardingFormLinkRequest
+ properties:
+ expiration_in_minutes:
+ type: integer
+ description: How long (in minutes) the link should be valid for. Defaults
+ to 60 minutes.
+ expired_session_url:
+ type: string
+ description: The URL users get sent to if the bearer token expires.
+ fee_details_url:
+ type: string
+ description: The URL of the page where you display the fees related to processing
+ payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
+ return_url:
+ type: string
+ description: The URL users get sent to after completing the onboarding flow.
+ terms_of_service_url:
+ type: string
+ description: Your Terms of Service URL. The URL is provided to users for
+ consent along with Finix's Terms of Service.
+ OnboardingFormLink:
+ type: object
+ x-examples:
+ example-1:
+ expires_at: '2022-07-11T22:39:55.469Z'
+ link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g
+ properties:
+ expires_at:
+ type: string
+ description: A UTC timestamp detailing when the onboarding form expires
+ and will no longer be available via `link_url`. To generate a new link
+ to the same form, see [Get an Onboarding Form URL](/guides/onboarding/onboarding-form/#get-an-onboarding-form-url).
+ link_url:
+ type: string
+ description: The URL of the user's Finix Onboarding Form. Users can use
+ the `link_url` to return to the form at any time.
+ title: OnboardingFormLink
+ AdditionalBuyerCharges:
+ title: AdditionalBuyerCharges
+ x-stoplight:
+ id: 8t8auxc19wmuw
+ type: object
+ description: Object detailing any [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)
+ that got included in the `Authorization`.
+ nullable: true
+ properties:
+ convenience_amount:
+ type: number
+ description: Include the convenience fee the merchant is charging the buyer
+ for the transaction when creating a `Transfer` or an `Authorization`.
+ nullable: true
+ rent_surcharge_amount:
+ type: number
+ description: Include the rent surcharge the merchant is charging the buyer
+ for the transaction when creating a `Transfer` or an `Authorization`.
+ nullable: true
+ UpdateMerchantProfileRequest:
+ title: UpdateMerchantProfileRequest
+ x-stoplight:
+ id: 9cuj94a54fwqp
+ type: object
+ properties:
+ fee_profile:
+ type: string
+ description: ID of the `fee_profile`.
+ payout_profile:
+ type: string
+ description: ID of the `payout_profile`.
+ risk_profile:
+ type: string
+ description: ID of the `risk_profile`.
+ tags:
+ $ref: '#/components/schemas/Tags'
+ UpdateDeviceRequest:
+ type: object
+ properties:
+ action:
+ type: string
+ enum:
+ - ACTIVATE
+ - CREATE_IDLE_MESSAGE
+ - DEACTIVATE
+ - REBOOT
+ description: The action you want to perform on the device. Use **DEACTIVATE**
+ to deactivate the device.
+ tags:
+ $ref: '#/components/schemas/Tags'
+ activation_code:
+ type: string
+ description: Used when `action` is **ACTIVATE**. Provide the input code
+ that shows up on the device screen.
+ idle_message:
+ type: string
+ description: Message to display on the idle screen.
+ configuration_details:
+ $ref: '#/components/schemas/ConfigurationDetails'
+ description:
+ type: string
+ description: Additional information about device (e.g. self serving terminal).
+ name:
+ type: string
+ description: Name of the `Device`.
+ serial_number:
+ type: string
+ description: Serial number of the `device`.
+ WebhookEnabledEvents:
+ title: WebhookEnabledEvents
+ x-stoplight:
+ id: ux7v2p72v0shw
+ type: array
+ description: A list of events the [webhook is explicitly enabled for](/guides/developers/webhooks/#webhook-event-filtering).
+ items:
+ type: object
+ properties:
+ entity:
+ type: string
+ description: The entity type for the enabled event. There can only be
+ one enabled event object for a given entity.
+ types:
+ type: array
+ description: A list of event types you want to receive for the specified
+ `entity`.
+ items:
+ type: string
+ HSAFSAPayment:
+ title: HSAFSAPayment
+ x-stoplight:
+ id: qo360ogzirm07
+ type: boolean
+ description: Set to to **true** to process a payment using a `Payment Instrument`
+ [created from a health savings account (HSA) or flexible spending account
+ (FSA)](/guides/making-a-payment/hsa-fsa/).
+ nullable: true
+ AdditionalHealthcareData:
+ title: AdditionalHealthcareData
+ x-stoplight:
+ id: ibznc087ymmit
+ type: object
+ description: Optional object detailing [specific healthcare amounts](/guides/making-a-payment/hsa-fsa/).
+ nullable: true
+ properties:
+ clinic_amount:
+ type: integer
+ description: The amount used for clinic and office visits such as a copay
+ amount.
+ nullable: true
+ dental_amount:
+ type: integer
+ description: The amount used for dental related expenses.
+ nullable: true
+ prescription_amount:
+ type: integer
+ description: The amount used to purchase perscriptions and medications.
+ nullable: true
+ vision_amount:
+ type: integer
+ description: The amount used for vision related expenses.
+ nullable: true
+ PayoutProfile:
+ type: object
+ properties:
+ id:
+ type: string
+ description: The ID of the `Payout Profile` resource.
+ created_at:
+ $ref: '#/components/schemas/CreatedAt'
+ updated_at:
+ $ref: '#/components/schemas/UpdatedAt'
+ gross:
+ type: object
+ description: Details how `Payout Profiles` with type **GROSS** are configured.
+ nullable: true
+ properties:
+ fees:
+ type: object
+ description: Configures and details how fees get debited.
+ properties:
+ day_of_month:
+ type: integer
+ description: Day of the month fees get debited. Required when `frequency`
+ is set to **MONTHLY**.
+ frequency:
+ type: string
+ description: Configures how frequentyly *fees* get debited. To configure
+ a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument` that *fees* get
+ debited from.
+ rail:
+ type: string
+ description: Configures how quickly and which payment `rail` will
+ be used to debit *fees*.
+ enum:
+ - NEXT_DAY_ACH
+ - SAME_DAY_ACH
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay
+ when `funding_transfers` for *fees* will get submitted to debit
+ (in days) the `payment_instrument_id`.
+ payouts:
+ type: object
+ description: Configures and details how payouts get paid and credited.
+ properties:
+ frequency:
+ type: string
+ description: Configures how frequentyly *payouts* get credited.
+ To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument`that *payouts*
+ will get credited to.
+ rail:
+ type: string
+ description: Configures how quickly and which payment `rail` will
+ be used to credit *payouts*.
+ enum:
+ - NEXT_DAY_ACH
+ - SAME_DAY_ACH
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay
+ when `funding_transfers` for *payouts* will get submitted to credit
+ (in days) the `payment_instrument_id`.
+ linked_id:
+ type: string
+ description: ID of the resource linked to the `Payout Profile`.
+ linked_type:
+ type: string
+ description: The type of resource the `Payout Profile` is linked to.
+ tags:
+ $ref: '#/components/schemas/Tags'
+ type:
+ type: string
+ description: Configures how fees are calculated and billed from payouts.
+ For more infromation, see [Payout Types](/guides/payouts/#payout-types).
+ enum:
+ - CUSTOM
+ - GROSS
+ - NET
+ _links:
+ $ref: '#/components/schemas/ListLinks'
+ net:
+ type: object
+ description: Details how `Payout Profiles` with type **NET** are configured.
+ nullable: true
+ properties:
+ frequency:
+ type: string
+ description: Configures how frequentyly fees and payouts get credited.
+ To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument` that payouts and fees
+ get credited to and debited from.
+ rail:
+ type: string
+ description: Configures how quickly and which payment `rail` will be
+ used to debit fees and credit payouts.
+ enum:
+ - NEXT_DAY_ACH
+ - SAME_DAY_ACH
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay when
+ `funding_transfers` for both payouts and fees will get submitted (in
+ days) to debit/credit the `payment_instrument_id`.
+ custom:
+ type: object
+ description: Details how `Payout Profiles` with type **CUSTOM** are configured.
+ `Payout Profiles` with type **CUSTOM** can be setup with more specific
+ configurations. To configure a **CUSTOM** `Payout Profile` [contact Finix
+ Support](/guides/payouts/#payout-types).
+ nullable: true
+ PayoutProfilesList:
+ type: object
+ x-examples:
+ example-1:
+ _embedded:
+ payout_profiles:
+ - id: PO6UbajkQrbFd5nAvs57dwyn
+ created_at: '2022-10-24T21:38:23.72Z'
+ updated_at: '2022-10-24T21:38:23.72Z'
+ tags: {}
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ type: GROSS
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ fees:
+ frequency: MONTHLY
+ day_of_month: 1
+ submission_delay_days: 3
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
+ - id: POf5rP3c3XyRX7M6PuCvmgxf
+ created_at: '2022-10-20T19:43:18.02Z'
+ updated_at: '2022-10-20T19:43:18.02Z'
+ tags: {}
+ linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
+ linked_type: MERCHANT
+ type: CUSTOM
+ custom: {}
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles
+ next:
+ href: https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
+ page:
+ limit: 100
+ next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
+ description: List of `Payout Profiles`.
+ properties:
+ _embedded:
+ type: object
+ description: List of `Payout Profiles`.
+ properties:
+ payout_profiles:
+ type: array
+ description: '`Payout Profile` objects.'
+ items:
+ $ref: '#/components/schemas/PayoutProfile'
+ _links:
+ $ref: '#/components/schemas/ListLinks'
+ page:
+ $ref: '#/components/schemas/PageCursor'
+ SplitTransfersList:
+ type: object
+ x-examples:
+ example-1:
+ _embedded:
+ payout_profiles:
+ - id: PO6UbajkQrbFd5nAvs57dwyn
+ created_at: '2022-10-24T21:38:23.72Z'
+ updated_at: '2022-10-24T21:38:23.72Z'
+ tags: {}
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ type: GROSS
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ fees:
+ frequency: MONTHLY
+ day_of_month: 1
+ submission_delay_days: 3
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
+ - id: POf5rP3c3XyRX7M6PuCvmgxf
+ created_at: '2022-10-20T19:43:18.02Z'
+ updated_at: '2022-10-20T19:43:18.02Z'
+ tags: {}
+ linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
+ linked_type: MERCHANT
+ type: CUSTOM
+ custom: {}
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles
+ next:
+ href: https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
+ page:
+ limit: 100
+ next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
+ description: List of `Split Transferss` created for a split `Transfer`.
+ x-stoplight:
+ id: 11d3f3351214e
+ properties:
+ _embedded:
+ type: object
+ description: List of `Payout Profiles`.
+ properties:
+ split_transfers:
+ type: array
+ description: '`Payout Profile` objects.'
+ items:
+ $ref: '#/components/schemas/SplitTransfersList'
+ _links:
+ $ref: '#/components/schemas/ListLinks'
+ page:
+ $ref: '#/components/schemas/PageCursor'
+ ComplianceFormList:
+ type: object
+ x-examples:
+ example-1:
+ _embedded:
+ payout_profiles:
+ - id: PO6UbajkQrbFd5nAvs57dwyn
+ created_at: '2022-10-24T21:38:23.72Z'
+ updated_at: '2022-10-24T21:38:23.72Z'
+ tags: {}
+ linked_id: MU6TXYpA37uM9H4GwitQr8E3
+ linked_type: MERCHANT
+ type: GROSS
+ gross:
+ payouts:
+ frequency: DAILY
+ submission_delay_days: 1
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ fees:
+ frequency: MONTHLY
+ day_of_month: 1
+ submission_delay_days: 3
+ payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
+ rail: STANDARD
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn
+ - id: POf5rP3c3XyRX7M6PuCvmgxf
+ created_at: '2022-10-20T19:43:18.02Z'
+ updated_at: '2022-10-20T19:43:18.02Z'
+ tags: {}
+ linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
+ linked_type: MERCHANT
+ type: CUSTOM
+ custom: {}
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf
+ _links:
+ self:
+ href: https://finix.sandbox-payments-api.com/payout_profiles
+ next:
+ href: https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf
+ page:
+ limit: 100
+ next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
+ description: List of `Payout Profiles`.
+ x-stoplight:
+ id: 11d3f3351214e
+ properties:
+ _embedded:
+ type: object
+ description: List of `Payout Profiles`.
+ properties:
+ compliance_forms:
+ type: array
+ description: '`Payout Profile` objects.'
+ items:
+ $ref: '#/components/schemas/ComplianceForm'
+ _links:
+ $ref: '#/components/schemas/ListLinks'
+ page:
+ $ref: '#/components/schemas/PageCursor'
+ UpdatePayoutProfileRequest:
+ type: object
+ properties:
+ gross:
+ type: object
+ description: Configure how `Payout Profiles` with type **GROSS** are setup.
+ nullable: true
+ properties:
+ fees:
+ type: object
+ description: Configures the details of how fees get debited.
+ properties:
+ day_of_month:
+ type: integer
+ description: Day of the month fees get debited. Required when `frequency`
+ is set to **MONTHLY**.
+ frequency:
+ type: string
+ description: Configures how frequentyly **fees** get debited. To
+ configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument`that **fees** get
+ debited from.
+ rail:
+ type: string
+ description: Configures how quickly and which payment `rail` will
+ be used to debit **fees**.
+ enum:
+ - NEXT_DAY_ACH
+ - SAME_DAY_ACH
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay
+ when `funding_transfers` for `fees` will get submitted to debit
+ (in days) the `payment_instrument_id`.
+ payouts:
+ type: object
+ description: Configures the details of how payouts get paid and credited.
+ properties:
+ frequency:
+ type: string
+ description: Configures how frequentyly **payouts** get credited.
+ To configure a **CUSTOM** `frequency` [contact Finix Support](/guides/payouts/).
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument`that payouts will
+ get credited to.
+ rail:
+ type: string
+ description: Configures how quickly and which payment `rail` will
+ be used to credit **payouts**.
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay
+ when `funding_transfers` for `payouts` will get submitted to credit
+ (in days) the `payment_instrument_id`.
+ tags:
+ $ref: '#/components/schemas/Tags'
+ type:
+ type: string
+ description: Configures how fees are calculated and billed from payouts.
+ For more infromation, see [Payout Types](/guides/payouts/#payout-types).
+ enum:
+ - CUSTOM
+ - GROSS
+ - NET
+ net:
+ type: object
+ description: Configure how `Payout Profiles` with type **NET** are setup.
+ nullable: true
+ properties:
+ frequency:
+ type: string
+ description: Configures how frequentyly fees *and* payouts get credited.
+ enum:
+ - DAILY
+ - MONTHLY
+ - CONTINUOUS
+ - CUSTOM
+ payment_instrument_id:
+ type: string
+ description: The `id` of the `Payment Instrument` that payouts *and*
+ fees get credited to and debited from.
+ rail:
+ type: string
+ enum:
+ - NEXT_DAY_ACH
+ - SAME_DAY_ACH
+ description: Configures how quickly and which payment `rail` will be
+ used to debit fees *and* credit payouts.
+ submission_delay_days:
+ type: integer
+ description: Include a number of `submission_delay_days` to delay when
+ `funding_transfers` for both payouts *and* fees get submitted (in
+ days) to debit/credit the `payment_instrument_id`.
+ OnboardingFormOnboardingData:
+ title: OnboardingFormOnboardingData
+ x-stoplight:
+ id: lu5e8v4djdyv7
+ type: object
+ description: The prefilled information of the user that's being onboarded. For
+ more information, see [Prefilling Fields](/guides/onboarding/onboarding-forms/#prefilling-fields).
+ properties:
+ additional_underwriting_data:
+ type: object
+ description: Additional underwriting data about the user.
+ properties:
+ annual_ach_volume:
+ type: integer
+ description: The approximate annual ACH sales expected to be processed
+ (in cents) by this merchant (max 10 characters).
+ average_ach_transfer_amount:
+ type: integer
+ description: The approximate average ACH sale amount (in cents) for
+ this merchant.
+ average_card_transfer_amount:
+ type: integer
+ description: The average credit card sale amount (in cents) for this
+ merchant.
+ business_description:
+ type: string
+ minLength: 1
+ description: Description of this merchant's business (max 200 characters).
+ card_volume_distribution:
+ type: object
+ description: The distribution of the merchant's credit card volume The
+ sum of `card_volume_distribution` must be 100.
+ nullable: true
+ properties:
+ card_present_percentage:
+ type: integer
+ description: The percentage of the merchant's volume that's card
+ present (between 0 and 100).
+ ecommerce_percentage:
+ type: integer
+ description: The percentage of the merchant's business that is eCommerce
+ (between 0 and 100).
+ mail_order_telephone_order_percentage:
+ type: integer
+ description: The percentage of the merchant's business that is a
+ mail or telephone order (between 0 and 100).
+ credit_check_allowed:
+ type: boolean
+ description: Sets if this merchant has consented and accepted to a credit
+ check.
+ credit_check_ip_address:
+ type: string
+ minLength: 1
+ description: The IP address of the merchant when they consented to a
+ credit check (e.g., 42.1.1.112 ).
+ credit_check_timestamp:
+ type: string
+ minLength: 1
+ description: A timestamp of when this merchant consented to a credit
+ check (e.g., 2021-04-28T16:42:55Z).
+ credit_check_user_agent:
+ type: string
+ minLength: 1
+ description: The details of the browser that was used when this merchant
+ consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac
+ OS X 10 _14_6)).
+ merchant_agreement_accepted:
+ type: boolean
+ description: Sets whether this merchant has accepted the terms and conditions
+ of the merchant agreement.
+ merchant_agreement_ip_address:
+ type: string
+ minLength: 1
+ description: IP address of the merchant when this merchant accepted
+ the merchant agreement (e.g., 42.1.1.113).
+ merchant_agreement_timestamp:
+ type: string
+ minLength: 1
+ description: Timestamp of when the merchant accepted Finix's Terms of
+ Service (e.g., 2021-04-28T16:42:55Z).
+ merchant_agreement_user_agent:
+ type: string
+ minLength: 1
+ description: The details of the browser that was used when this merchant
+ accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel
+ Mac OS X 10 _14_6)).
+ refund_policy:
+ type: string
+ minLength: 1
+ description: Include the value that best applies to the merchant's refund
+ policy.
+ enum:
+ - NO_REFUNDS
+ - MERCHANDISE_EXCHANGE_ONLY
+ - WITHIN_30_DAYS
+ - OTHER
+ volume_distribution_by_business_type:
+ type: object
+ description: Merchant's distribution of credit card volume by business
+ type. Sum of `volume_distribution_by_business_type` must be 100.
+ nullable: true
+ properties:
+ business_to_business_volume_percentage:
+ type: integer
+ description: The percentage of the merchant's volume that's business
+ to business (between 0 and 100).
+ business_to_consumer_volume_percentage:
+ type: integer
+ description: The percentage of the merchant's volume that's business
+ to consumer (between 0 and 100).
+ consumer_to_consumer_volume_percentage:
+ type: integer
+ description: Merchant's percentage of volume that is consumer to
+ consumer (between 0 and 100).
+ other_volume_percentage:
+ type: integer
+ description: The percentage of the merchant's volume that isn't
+ represented by the previous fields (between 0 and 100).
+ person_to_person_volume_percentage:
+ type: integer
+ description: The percentage the merchant's volume that's person
+ to person (between 0 and 100).
+ associated_entities:
+ type: array
+ description: The `entities` saved in the `associated_identities` of the
+ user. For more information, see [Create an Associated Identity](/guides/onboarding/onboarding-form/#prefilling-fields).
+ items:
+ type: object
+ description: Underwriting data that's required to verify the `Identity`.
+ properties:
+ annual_card_volume:
+ type: integer
+ description: The annual credit card sales (in cents) expected to be
+ processed (max 19 characters).
+ business_address:
+ type: object
+ description: The primary address for the legal entity.
+ nullable: true
+ properties:
+ city:
+ type: string
+ description: City (max 20 characters).
+ minLength: 1
+ country:
+ type: string
+ minLength: 1
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter state code.
+ business_name:
+ type: string
+ minLength: 1
+ description: Abbreviated names of the business. If there are no abbreviated
+ name, leave this field blank.
+ nullable: true
+ business_phone:
+ type: string
+ minLength: 1
+ description: Customer service phone number where the merchant can
+ be reached (max 10 characters).
+ business_tax_id:
+ type: string
+ minLength: 1
+ description: Nine digit Tax Identification Number (TIN), Employer
+ Identification Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**
+ and they do not have an EIN, use the sole proprietor's Social Security
+ Number (SSN).
+ business_type:
+ type: string
+ minLength: 1
+ description: Include the value that best applies to the merchant.
+ enum:
+ - INDIVIDUAL_SOLE_PROPRIETORSHIP
+ - CORPORATION
+ - LIMITED_LIABILITY_COMPANY
+ - PARTNERSHIP
+ - ASSOCIATION_ESTATE_TRUST
+ - TAX_EXEMPT_ORGANIZATION
+ - INTERNATIONAL_ORGANIZATION
+ - GOVERNMENT_AGENCY
+ default_statement_descriptor:
+ type: string
+ minLength: 1
+ description: The description of the merchant that appears on the buyer's
+ bank or card statement.
+ dob:
+ type: object
+ description: 'The control owner''s date of birth.
+
+ '
+ properties:
+ day:
+ type: integer
+ month:
+ type: integer
+ year:
+ type: integer
+ doing_business_as:
+ type: string
+ minLength: 1
+ description: Alternate names of the business. If there are no other
+ names, pass the same value used for `business_name` (max 60 characters).
+ email:
+ type: string
+ minLength: 1
+ description: The email address of the principal control owner where
+ they can be reached (max 100 characters).
+ first_name:
+ type: string
+ minLength: 1
+ description: The legal first name of the control owner (max 20 characters).
+ has_accepted_credit_cards_previously:
+ type: boolean
+ description: Defaults to **false** if not passed.
+ incorporation_date:
+ type: object
+ description: The date the company was founded and registered.
+ nullable: true
+ properties:
+ day:
+ type: integer
+ description: Day business was incorporated (between 1 and 31).
+ month:
+ type: integer
+ description: Month business was incorporated (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
+ last_name:
+ type: string
+ minLength: 1
+ description: The `Identity` owner's legal last name.
+ max_transaction_amount:
+ type: integer
+ description: The maximum amount (in cents) that can be charged for
+ a single transaction (max 12 characters).
+ mcc:
+ type: string
+ minLength: 1
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ ownership_type:
+ type: string
+ minLength: 1
+ description: 'Values can be either:
+
+ - PUBLIC to indicate a publicly-traded company.
+
+
- PRIVATE for privately-held businesses.'
+ nullable: true
+ personal_address:
+ type: object
+ description: The home address of the principal control owner. This
+ field is used for identity verification purposes.
+ properties:
+ city:
+ type: string
+ minLength: 1
+ description: City (max 20 characters).
+ country:
+ type: string
+ minLength: 1
+ description: 3-Letter country code (e.g. USA).
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter State code.
+ phone:
+ type: string
+ minLength: 1
+ description: The principal control owner's phone number (max 10 characters).
+ principal_percentage_ownership:
+ type: integer
+ description: Percentage of the company owned by the principal control
+ owner (min 0; max 100).
+ tax_id:
+ type: string
+ minLength: 1
+ description: Details if the `tax_id` was provided.
+ title:
+ type: string
+ minLength: 1
+ description: The corporate title of the control owner (e.g. Chief
+ Executive Officer, CFO, etc. Max 60 characters).
+ url:
+ type: string
+ minLength: 1
+ description: The URL of the `Identity` owner's public website.
+ entity:
+ type: object
+ description: The `entity` information saved in the `Identity` of the user.
+ properties:
+ amex_mid:
+ type: integer
+ description: Assigned amexMid value. If a value is passed, it must be
+ 10 or 11 digits.
+ nullable: true
+ annual_card_volume:
+ type: integer
+ description: The annual credit card sales (in cents) expected to be
+ processed by this seller (max 19 characters).
+ nullable: true
+ business_address:
+ type: object
+ description: The primary address for the legal entity.
+ nullable: true
+ properties:
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ nullable: true
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ nullable: true
+ city:
+ type: string
+ minLength: 1
+ description: City (max 20 characters).
+ nullable: true
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter state code.
+ nullable: true
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ nullable: true
+ country:
+ type: string
+ minLength: 1
+ description: 3-Letter Country code (e.g. USA).
+ nullable: true
+ business_name:
+ type: string
+ minLength: 1
+ description: The merchant's legal business name (max 120 characters).
- If
+ INDIVIDUAL_SOLE_PROPRIETORSHIP, pass the owner's
+ legal first name, last name and middle initial.
+ nullable: true
+ business_phone:
+ type: string
+ minLength: 1
+ description: Customer service phone number where the seller can be reached
+ (max 10 characters).
+ nullable: true
+ business_tax_id_provided:
+ type: boolean
+ description: Details if the `business_tax_id` was provided.
+ business_type:
+ description: Include the value that best applies to the seller.
+ type: string
+ nullable: true
+ default_statement_descriptor:
+ type: string
+ minLength: 1
+ description: The description of the seller that appears on the buyer's
+ bank or card statement.
+ nullable: true
+ discover_mid:
+ description: Assigned discoverMid value.
+ type: integer
+ nullable: true
+ dob:
+ type: object
+ description: The control owner's date of birth.
+ nullable: true
+ properties:
+ day:
+ type: integer
+ description: Day of birth (between 1 and 31).
+ minimum: 1
+ month:
+ type: integer
+ description: Month of birth (between 1 and 12).
+ minimum: 1
+ year:
+ type: integer
+ description: Year of birth (4-digit). Year must be greater than
+ 1900.
+ minimum: 1900
+ doing_business_as:
+ type: string
+ minLength: 1
+ description: Alternate names of the business. If there are no other
+ names, pass the same value used for `business_name` (max 60 characters).
+ nullable: true
+ email:
+ type: string
+ minLength: 1
+ description: The email address of the principal control owner where
+ they can be reached (max 100 characters).
+ nullable: true
+ first_name:
+ type: string
+ minLength: 1
+ description: The legal first name of the merchant's control owner (max
+ 20 characters).
+ nullable: true
+ has_accepted_credit_cards_previously:
+ type: boolean
+ description: Defaults to **false** if not passed.
+ incorporation_date:
+ type: object
+ description: The date the company was founded and registered with the
+ US.
+ nullable: true
+ properties:
+ day:
+ type: integer
+ description: Day business was incorporated (between 1 and 31).
+ month:
+ type: integer
+ description: Month of birth (between 1 and 12).
+ year:
+ type: integer
+ description: Year business was incorporated (4-digit).
+ last_name:
+ type: string
+ minLength: 1
+ description: The legal last name of the merchant's control owner (max
+ 20 characters).
+ nullable: true
+ max_transaction_amount:
+ type: integer
+ description: The maximum amount (in cents) that can be charged for a
+ single transaction (max 12 characters).
+ nullable: true
+ mcc:
+ type: string
+ minLength: 1
+ description: The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf))
+ that this merchant will be classified under. For a list of approved
+ MCCs, see [Approved Merchant Category Codes.](/docs/guides/business/security-and-compliance/approved-merchants/)
+ nullable: true
+ ownership_type:
+ type: string
+ minLength: 1
+ description: 'Values can be either:
- PUBLIC
+ to indicate a publicly-traded company.
- PRIVATE
+ for privately-held businesses.'
+ enum:
+ - PUBLIC
+ - PRIVATE
+ nullable: true
+ personal_address:
+ type: object
+ description: The home address of the merchant's principal control owner.
+ This field is used for identity verification purposes.
+ nullable: true
+ properties:
+ line1:
+ type: string
+ minLength: 1
+ description: First line of the address (max 35 characters).
+ nullable: true
+ line2:
+ type: string
+ minLength: 1
+ description: Second line of the address (max 35 characters).
+ nullable: true
+ city:
+ type: string
+ minLength: 1
+ description: City (max 20 characters).
+ nullable: true
+ region:
+ type: string
+ minLength: 1
+ description: 2-letter State code.
+ nullable: true
+ postal_code:
+ type: string
+ minLength: 1
+ description: Zip or Postal code (max 7 characters).
+ nullable: true
+ country:
+ type: string
+ minLength: 1
+ description: 3-Letter country code (e.g. USA).
+ nullable: true
+ phone:
+ type: string
+ minLength: 1
+ description: The principal control owner's phone number (max 10 characters).
+ nullable: true
+ principal_percentage_ownership:
+ type: integer
+ description: Percentage of the company owned by the principal control
+ owner (min 0; max 100).
+ nullable: true
+ short_business_name:
type: string
- description: User agent of the person attesting to this `compliance_form`.
- ip_address:
+ description: Abbreviated names of the business. If there are no abbreviated
+ name, leave this field blank.
+ nullable: true
+ tax_authority:
type: string
- description: IP address of the person attesting to this `compliance_form`.
+ description:
- Only required when onboarding a seller with a MCC
+ of 9311.
- The tax_authority is the tax
+ gathering entity (e.g San Francisco Water Authority).
+ nullable: true
+ tax_id_provided:
+ type: boolean
+ description: Details if the `tax_id` was provided.
title:
type: string
- description: "Title or role of the person completing (aka attesting\
- \ to)\n the `compliance_form`."
- CreateOnboardingFormRequest:
- type: object
- x-examples: {}
- title: CreateOnboardingFormRequest
- properties:
- onboarding_data:
- type: object
- description: The prefilled information of the user that's being onboarded.
- For more information, see [Prefilling Fields](/guides/onboarding/onboarding-form/#prefilling-fields).
- properties:
- entity:
- type: object
- description: The `entity` information saved in the `Identity` of the
- user.
- associated_entities:
- type: array
- description: The `entities` saved in the `associated_identities` of
- the user. For more information, see [Create an Associated Identity](/guides/onboarding/onboarding-form/#prefilling-fields).
- items:
- type: object
- additional_underwriting_data:
- type: object
- description: Additional underwriting data about the user.
- payment_instruments:
- type: object
- description: The `Payment Instrument` that'll be used to payout the
- user. For more information, see [Payouts](/guides/payouts/).
- max_transaction_amount:
- type: integer
- description: Maximum amount that can be transacted for a single transaction
- in cents (max 12 characters). Must be equal to or less than your `max_transaction_amount`.
- merchant_processors:
- type: array
- description: An array of objects with the processors and gateways users
- will be onboarded to.
- items:
- type: object
- properties:
- processor:
- type: string
- description: The name of the processor you plan to onboard users to.
- onboarding_link_details:
+ minLength: 1
+ description: The corporate title of the control owner (e.g. Chief Executive
+ Officer, CFO, etc. Max 60 characters).
+ nullable: true
+ url:
+ type: string
+ minLength: 1
+ description: The URL of the merchant's public website.
+ nullable: true
+ payment_instruments:
type: object
- description: The information of the initial onboarding link. This is only
- provided when creating an `onboarding_form`.
+ description: The `Payment Instrument` that'll be used to payout the seller.
+ For more information, see [Payouts](/guides/payouts/).
properties:
- return_url:
+ account_number:
type: string
- description: The URL users get sent to after completing the onboarding
- flow.
- expired_session_url:
+ description: The bank account number (no dashes in between numbers).
+ acount_type:
type: string
- description: The URL users get sent to if the bearer token expires.
- terms_of_service_url:
+ description: 'The type of bank account. Use the following respective
+ enum when creating a `Payment Instrument` for:
- CHECKING:
+ The checking account of your buyer.
- SAVINGS:
+ The savings account of your buyer.
- CORPORATE:
+ A corporate checking account.
- CORP_SAVINGS:
+ A corporate savings account.
- BUSINESS_CHECKING:
+ A checking account primarily owned by a business.
- BUSINESS_SAVINGS:
+ A savings account primarily owned by a business
- PERSONAL_CHECKING:
+ Seller''s using their personal checking account.
- PERSONAL_SAVINGS:
+ Seller''s using their personal savings account.
'
+ attempt_bank_account_validation_check:
+ enum:
+ - CHECKING
+ - SAVINGS
+ - PERSONAL_CHECKING
+ - PERSONAL_SAVINGS
+ - BUSINESS_CHECKING
+ - BUSINESS_SAVINGS
+ - CORPORATE
+ - CORP_SAVINGS
+ bank_code:
type: string
- description: Your Terms of Service URL. The URL is provided to users
- for consent along with [Finix's Terms of Service](https://finix-hosted-content.s3.amazonaws.com/flex/v2/finix-terms-of-service.html).
- fee_details_url:
+ description: The routing number of the bank account.
+ name:
type: string
- description: The URL of the page where you display the fees related
- to processing payments (for more info, see [Displaying Processing
- Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
- expiration_in_minutes:
+ description: The name of the bank account owner.
+ type:
type: string
- description: How long (in minutes) the link should be valid for. Defaults
- to 60 minutes.
- OnboardingForm:
+ description: Type of `Payment Instrument`.
+ enum:
+ - BANK_ACCOUNT
+ max_transaction_amount:
+ type: integer
+ description: Maximum amount that can be transacted for a single transaction
+ in cents (max 12 characters). Must be equal to or less than your `max_transaction_amount`.
+ VoidAuthorization:
type: object
- x-examples: {}
- title: OnboardingForm
+ x-examples:
+ Void Authorization:
+ void_me: true
+ x-stoplight:
+ id: aa39354e659aa
properties:
- id:
- type: string
- description: The ID of the `onboarding_form` resource.
- onboarding_data:
- type: object
- description: The prefilled information of the user that's being onboarding.
- See [Prefilling Fields](/guides/onboarding/onboarding-form/) below.
- properties:
- entity:
- type: object
- description: The `entity` information saved in the `Identity` of the
- user.
- associated_entities:
- type: array
- description: The `entities` saved in the `associated_identities` of
- the user. For more information, see [Create an Associated Identity](/api/#operation/createAssociatedIdentity).
- items:
- type: object
- payment_instruments:
- type: object
- description: The `Payment Instrument` that'll be used to payout the
- user. For more information, see [Payouts](/guides/payouts).
- additional_underwriting_data:
- type: object
- description: Additional underwriting data about the user.
- max_transaction_amount:
- type: integer
- description: Maximum amount that can be transacted for a single transaction
- in cents (max 12 characters). Must be equal to or less than your `max_transaction_amount`.
- merchant_processors:
- type: array
- description: An array of objects with the processors and gateways users
- will be onboarded to.
- items:
- type: object
- properties:
- processor:
- type: string
- description: The name of the processor you plan to onboard users to.
- onboarding_link:
- type: object
- description: The information of the initial onboarding link. This is only
- provided when creating an `onboarding_form`.
- properties:
- expires_at:
- type: string
- description: A UTC timestamp detailing when the onboarding form expires
- and will no longer be available via `link_url`. To generate a new
- link to the same form, see [Get an Onboarding Form URL](/guides/onboarding/onboarding-form/#get-an-onboarding-form-url).
- link_url:
- type: string
- description: The URL of the user's Finix Onboarding Form. Users can
- use the `link_url` to return to the form until the link expires.
- status:
- type: string
- description: Status of the `onboarding_from`.
- enum:
- - IN_PROGRESS
- - COMPLETED
- created_at:
- $ref: '#/components/schemas/CreatedAt'
- updated_at:
- $ref: '#/components/schemas/UpdatedAt'
tags:
$ref: '#/components/schemas/Tags'
- CreateOnboardingFormLinkRequest:
+ void_me:
+ type: boolean
+ description: Set to **True** to void the `Authorization`.
+ VoidAuthorizationRequest:
type: object
- x-examples: {}
+ x-examples:
+ Example 1:
+ void_me: true
properties:
- terms_of_service_url:
- type: string
- description: Your Terms of Service URL. The URL is provided to users for
- consent along with Finix's Terms of Service.
- return_url:
+ tags:
+ $ref: '#/components/schemas/Tags'
+ void_me:
+ type: boolean
+ description: Set to **True** to void the `Authorization`.
+ L3AdditionalPurchaseData:
+ title: L3AdditionalPurchaseData
+ x-stoplight:
+ id: 7xbmc1d9p49or
+ type: object
+ description: Additional information about the purchase. Used for [Level 2 and
+ Level 3 Processing](/guides/payments/modify/level-2-and-level-3-processing/).
+ properties:
+ customer_reference_number:
type: string
- description: The URL users get sent to after completing the onboarding flow.
- fee_details_url:
+ description: The customer reference for the purchase (max 17 characters).
+ maxLength: 17
+ customs_duty_amount:
+ type: integer
+ description: The duty in cents on the total purchase amount for the order
+ destination_country_code:
type: string
- description: The URL of the page where you display the fees related to processing
- payments (for more info, see [Displaying Processing Fees](/guides/onboarding/onboarding-form/#displaying-processing-fees)).
- expired_session_url:
+ description: The ISO country code of the order destination.
+ destination_postal_code:
type: string
- description: The URL users get sent to if the bearer token expires.
- expiration_in_minutes:
+ description: The postal code of the order destination (10 characters)
+ maxLength: 10
+ discount_amount:
type: integer
- description: How long (in minutes) the link is valid for.
- title: CreateOnboardingFormLinkRequest
- OnboardingFormLink:
- type: object
- x-examples:
- example-1:
- expires_at: '2022-07-11T22:39:55.469Z'
- link_url: https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g
- properties:
- expires_at:
- type: string
- description: A UTC timestamp detailing when the onboarding form expires
- and will no longer be available via `link_url`. To generate a new link
- to the same form, see [Get an Onboarding Form URL](/guides/onboarding/onboarding-form/#get-an-onboarding-form-url).
- link_url:
+ description: The amount in cents of the discount for the order.
+ invoice_reference_number:
type: string
- description: The URL of the user's Finix Onboarding Form. Users can use
- the `link_url` to return to the form at any time.
- title: OnboardingFormLink
- AdditionalBuyerCharges:
- title: AdditionalBuyerCharges
+ description: The order's invoice number (max 15 characters)
+ maxLength: 15
+ item_data:
+ type: array
+ description: Additional information about the transaction. Used for Level
+ 2 and Level 3 Processing.
+ items:
+ type: object
+ properties:
+ amount_excluding_sales_tax:
+ type: integer
+ description: '- Total cost of the line item in cents, excluding tax.
+
+ - Must align with `sales_tax` so `amount_excluding_sales_tax` +
+ `sales_tax` = `amount_including_sales_tax`.'
+ amount_including_sales_tax:
+ type: integer
+ description: '- Total cost of the line item in cents, including tax.
+
+ - Must align with `sales_tax` so `amount_excluding_sales_tax` +
+ `sales_tax` = `amount_including_sales_tax`.'
+ commodity_code:
+ type: string
+ description: A commodity code is a numeric code representing a particular
+ product or service as defined by the National Institute of Governmental
+ Purchasing. The code can be 3, 5, 7, or 11 digits in length. The
+ longer the code the more granular the description of the product/service.
+ (max 12 characters).
+ maxLength: 12
+ cost_per_unit:
+ type: integer
+ description: The price in cents of one unit of the item purchased
+ item_description:
+ type: string
+ description: Required when `item_data` is supplied (max 25 characters)
+ maxLength: 25
+ item_discount_amount:
+ type: integer
+ description: 'Item discount amount in cents
+
+ '
+ merchant_product_code:
+ type: string
+ description: Merchant defined product code (max 12 characters).
+ maxLength: 12
+ quantity:
+ type: integer
+ description: The number of items purchased. Must be greater than 0.
+ minimum: 1
+ maximum: 99
+ unit_of_measure:
+ type: string
+ description: The unit of measure of the purchased item (max 3 characters).
+ maxLength: 3
+ required:
+ - amount_excluding_sales_tax
+ - amount_including_sales_tax
+ - commodity_code
+ - cost_per_unit
+ - item_description
+ - item_discount_amount
+ - merchant_product_code
+ - quantity
+ - unit_of_measure
+ order_date:
+ type: object
+ properties:
+ day:
+ type: integer
+ description: Day of purchase (between 1 and 31)
+ month:
+ type: integer
+ description: Month of purchase (between 1 and 12)
+ year:
+ type: integer
+ description: Year of purchase (4-digit)
+ minimum: 1990
+ sales_tax:
+ type: integer
+ description: "- Total aggregate tax amount in cents for the entire purchase.\
+ \ Field is automatically calculated if you pass in the itemized tax amounts.\
+ \ \n- For non-taxable transactions either set `sales_tax` to 0 or omit\
+ \ from payload and also set `tax_exempt` to **True**.\n- Request must\
+ \ align so `amount_excluding_sales_tax` + `sales_tax` = `amount_including_sales_tax`.e**."
+ ship_from_postal_code:
+ type: string
+ description: The postal code from where order is shipped (10 characters)
+ maxLength: 10
+ shipping_amount:
+ type: integer
+ description: 'The shipping cost in cents for the order.
+
+ '
+ tax_exempt:
+ type: boolean
+ description: '- For tax exempt purchases set to **True**.
+
+ - If set to **True**, request can''t include `sales_tax`.'
+ required:
+ - customer_reference_number
+ - customs_duty_amount
+ - discount_amount
+ - item_data
+ - sales_tax
+ - shipping_amount
+ SubmitDisputeEvidence:
+ title: SubmitDisputeEvidence
x-stoplight:
- id: 8t8auxc19wmuw
+ id: 3ea63d77b21a4
type: object
- description: Object detailing any [Buyer Charges](/guides/payments/buyer-charges)
- that got included in the `Authorization`.
- nullable: true
properties:
- convenience_amount:
- type: number
- description: Include the convenience fee the merchant is charging the buyer
- for the transaction when creating a `Transfer` or an `Authorization`.
- nullable: true
- rent_surcharge_amount:
- type: number
- description: Include the rent surcharge the merchant is charging the buyer
- for the transaction when creating a `Transfer` or an `Authorization`.
- nullable: true
- UpdateMerchantProfileRequest:
- title: UpdateMerchantProfileRequest
+ note:
+ type: string
+ description: 'Include a note or custom metadata to reference the `Dispute` '
+ example: '"Submitting Dispute Evidence: July 23rd Receipt"'
+ required:
+ - note
+ UpdateDisputeEvidence:
+ title: UpdateDisputeEvidence
x-stoplight:
- id: 9cuj94a54fwqp
+ id: 20436cd87ffb5
type: object
properties:
- fee_profile:
- type: string
- description: ID of the `fee_profile`.
- risk_profile:
- type: string
- description: ID of the `risk_profile`.
tags:
$ref: '#/components/schemas/Tags'
- UpdateDeviceRequest:
- title: UpdateDeviceRequest
+ required:
+ - tags
+ AcceptDispute:
+ title: AcceptDispute
+ type: object
+ x-stoplight:
+ id: 47d1ecd88c757
+ properties:
+ note:
+ type: string
+ description: 'Include a note or custom metadata to reference the `Dispute`. '
+ example: '"Accepting Dispute: Mistaken Charge"'
+ required:
+ - note
+ CloseSettlement:
+ title: CloseSettlement
x-stoplight:
- id: w6o14ff8xpu3w
+ id: apumcx91bdtxm
type: object
properties:
action:
type: string
enum:
- - DEACTIVATE
- description: The action you want to perform on the device. Use **DEACTIVATE**
- to deactivate the device.
- activation_code:
+ - STOP_ACCRUAL
+ description: The action you want to perform on the `settlement`. Use **STOP_ACCRUAL**
+ to close the specified `settlement`.
+ required:
+ - action
+ CreateSplitTransferRequest:
+ title: CreateSplitTransferRequest
+ x-stoplight:
+ id: hy4p75wbwrf3t
+ type: object
+ properties:
+ id:
type: string
- description: Used when `action` is **ACTIVATE**. Provide the input code
- that shows up on the device screen.
- tags:
- $ref: '#/components/schemas/Tags'
- idle_message:
+ SplitTransfer:
+ type: object
+ x-examples:
+ Example 1:
+ id: split_transfer_7i2gxncPcfkN5rJwuhrb3q
+ created_at: '2023-07-19T02:30:17.10Z'
+ updated_at: '2023-07-19T02:30:17.10Z'
+ amount: 600
+ fee: 0
+ currency: USD
+ parent_transfer_id: TR7h8NxhCDHunLFdJ1HCLp4r
+ ready_to_settle_at: '2023-07-19T02:30:18.04Z'
+ type: DEBIT
+ merchant_id: MU4jpoNGRkAyjBxumZhGa6Hc
+ identity_id: IDhCtMvcteDx37eD9m4rmdKd
+ fee_profile_id: FPbDSnEPtaT8Nttxj9NJk7eC
+ application_id: APgPDQrLD52TYvqazjHJJchM
+ tags:
+ key: value
+ properties:
+ id:
type: string
- description: Message to display on the idle screen.
+ description: The ID of the `split_transfer` resource.
+ created_at:
+ $ref: '#/components/schemas/CreatedAt'
+ updated_at:
+ $ref: '#/components/schemas/UpdatedAt'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ fee:
+ type: integer
+ description: "The minimum amount of the `Transfer` you'd like to collect\
+ \ as your fee in cents. Defaults to zero (must be less than or equal to\
+ \ the `amount`).\n- If the fees applied by the 'Fee Profile' are ***higher***\
+ \ than the value passed in 'fee', 'fee' will not be applied and have no\
+ \ effect.\n- If the fees applied by the 'Fee Profile' are ***lower***\
+ \ than the value passed in 'fee', an additional fee is be applied, in\
+ \ addition to the fees generated by the `Fee Profile`.\n - The additional\
+ \ fee is equal to the difference between the value passed in 'fee' and\
+ \ the fees generated by the `Fee Profile`.\nfraud_session_id:"
+ format: int64
+ currency:
+ $ref: '#/components/schemas/Currency'
+ parent_transfer_id:
+ type: string
+ description: '**ID** of the original parent `Transfer` where the split was
+ defined.'
+ example: TR7h8NxhCDHunLFdJ1HCLp4r
+ pattern: TRxxxxxxxxxxxxxxxxxxxxxx
+ ready_to_settle_at:
+ type: string
+ format: date-time
+ description: Timestamp of when the `Transfer` is ready to be settled at.
+ nullable: true
+ type:
+ type: string
+ description: Type of `split_transfer`.
+ merchant_id:
+ type: string
+ description: The ID of the `Merchant` resource the `split_transfer` was
+ created for and will settle under.
+ identity_id:
+ type: string
+ description: The ID of `Identity` resource used by the `Merchant` the `split_transfer`
+ was created for.
+ fee_profile_id:
+ type: string
+ description: The `fee_profile` associated to this `split_transfer`.
+ application_id:
+ type: string
+ description: The `application_id` associated to this `split_transfer`.
+ tags:
+ type: object
+ properties:
+ key:
+ type: string
+ description: The `split_transfer` resource that was created from a split transacion.
ListAuthorizationsQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
amount:
description: Filter by an amount equal to the given value.
type: integer
@@ -19409,6 +24697,9 @@ components:
before_cursor:
description: Return every resource created before the cursor value.
type: string
+ after_cursor:
+ description: Return every resource created after the cursor value.
+ type: string
created_at.gte:
description: Filter where `created_at` is after the given date.
type: string
@@ -19421,8 +24712,11 @@ components:
limit:
description: The numbers of items to return.
type: integer
- sort:
- description: Specify key to be used for sorting the collection.
+ tags.key:
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ type: string
+ tags.value:
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
type: string
state:
description: Filter by Transaction state.
@@ -19480,8 +24774,9 @@ components:
type:
description: Type of the `Authorization`.
type: string
- after_cursor:
- description: Return every resource created after the cursor value.
+ Finix-Version:
+ description: Specify the API version of your request. For more details,
+ see [Versioning.](/guides/developers/versioning/)
type: string
ListBalanceTransfersQueryParams:
type: object
@@ -19489,10 +24784,6 @@ components:
limit:
description: The numbers of items to return.
type: integer
- offset:
- description: The number of items to skip before starting to collect the
- result set.
- type: integer
pageNumber:
description: The page number to list.
type: integer
@@ -19538,16 +24829,18 @@ components:
include_connection:
description: Specifies whether the connection information should be included.
type: boolean
+ GetDeviceConnectionQueryParams:
+ type: object
+ properties:
+ include_connection:
+ description: Specifies whether the connection information should be included.
+ type: boolean
ListDisputesQueryParams:
type: object
properties:
- sort:
- description: Specify key to be used for sorting the collection.
+ Accept:
+ description: Body Header
type: string
- offset:
- description: The number of items to skip before starting to collect the
- result set.
- type: integer
limit:
description: The numbers of items to return.
type: integer
@@ -19563,6 +24856,81 @@ components:
updated_at.lte:
description: Filter where `updated_at` is before the given date.
type: string
+ transfer_id:
+ description: 'Filter by the ID of the `Transfer` that''s being disputed.
+
**Note**: If included, all other filter parameters are ignored.'
+ type: string
+ adjustment_transfer_id:
+ description: 'Filter by the ID of the adjustment `Transfer`.
**Note**:
+ If included, all other filter parameters are ignored.'
+ type: string
+ amount:
+ description: Filter by an amount equal to the given value.
+ type: integer
+ amount.gte:
+ description: Filter by an amount greater than or equal.
+ type: integer
+ amount.gt:
+ description: Filter by an amount greater than.
+ type: integer
+ amount.lt:
+ description: Filter by an amount less than.
+ type: integer
+ state:
+ description: Filter by the state of the `Dispute`.
+ type: string
+ response_state:
+ description: Filter by the `response_state` of the `Dispute`.
+ type: string
+ respond_by.lte:
+ description: Filter where `respond_by` is before the given date.
+ type: string
+ respond_by.gte:
+ description: Filter where `respond_by` is after the given date.
+ type: string
+ instrument_bin:
+ description: Filter by the Bank Identification Number (BIN). The BIN is
+ the first 6 digits of the masked account number.
+ type: string
+ instrument_brand_type:
+ description: Filter by the card brand used.
+ type: string
+ merchant_identity_id:
+ description: Filter by the ID of the `Identity` used by the `Merchant`.
+ type: string
+ merchant_identity_name:
+ description: Filter by the name used by the `Merchant`.
+ type: string
+ instrument_name:
+ description: Filter by the name of the `Payment Instrument`.
+ type: string
+ instrument_type:
+ description: Filter by `Payment Instrument` type.
+ type: string
+ merchant_id:
+ description: Filter by the ID of the `Merchant`.
+ type: string
+ merchant_mid:
+ description: Filter by the MID of the `Merchant`.
+ type: string
+ instrument_card_last4:
+ description: Filter by the last 4 digits of the card used.
+ type: string
+ instrument_card_type:
+ description: Filter by the card type.
+ type: string
+ instrument_fingerprint:
+ description: Filter by the fingerprint of the `Payment Instrument`.
+ type: string
+ before_cursor:
+ description: Returns every `Dispute` created before the cursor value.
+ type: string
+ tags.key:
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ type: string
+ tags.value:
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
+ type: string
ListDisputeEvidenceQueryParams:
type: object
properties:
@@ -19578,6 +24946,9 @@ components:
ListFeeProfilesQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
after_cursor:
description: Return every resource created after the cursor value.
type: string
@@ -19590,8 +24961,8 @@ components:
ListIdentitiesQueryParams:
type: object
properties:
- sort:
- description: Specify key to be used for sorting the collection.
+ Accept:
+ description: Body Header
type: string
after_cursor:
description: Return every resource created after the cursor value.
@@ -19635,6 +25006,12 @@ components:
before_cursor:
description: Return every resource created before the cursor value.
type: string
+ tags.key:
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ type: string
+ tags.value:
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
+ type: string
ListIdentityAssociatedIdentitiesQueryParams:
type: object
properties:
@@ -19650,6 +25027,9 @@ components:
ListMerchantProfilesQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
id:
description: Filter by `id`.
type: string
@@ -19665,26 +25045,32 @@ components:
ListMerchantsQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
id:
description: Filter by `id`.
type: string
- created_at.gte:
- description: Filter where `created_at` is after the given date.
- type: string
- created_at.lte:
- description: Filter where `created_at` is before the given date.
- type: string
after_cursor:
description: Return every resource created after the cursor value.
type: string
before_cursor:
description: Return every resource created before the cursor value.
type: string
+ created_at.gte:
+ description: Filter where `created_at` is after the given date.
+ type: string
+ created_at.lte:
+ description: Filter where `created_at` is before the given date.
+ type: string
limit:
description: The numbers of items to return.
type: integer
- sort:
- description: Specify key to be used for sorting the collection.
+ updated_at.gte:
+ description: Filter where `updated_at` is after the given date.
+ type: string
+ updated_at.lte:
+ description: Filter where `updated_at` is before the given date.
type: string
ListMerchantVerificationsQueryParams:
type: object
@@ -19701,6 +25087,9 @@ components:
ListPaymentInstrumentsQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
account_last4:
description: Filter by the last 4 digits of the account if available.
type: string
@@ -19734,7 +25123,7 @@ components:
description: Filter by the 4 digit expiration year associated with the Payment
Instrument if applicable. This filter only applies to payment cards.
type: string
- last_four:
+ last4:
description: Filter by the last 4 digits of the `Payment Instrument` card.
This filter only applies to payment cards.
type: string
@@ -19750,19 +25139,12 @@ components:
type:
description: Filter by the `Payment Instrument` type.
type: string
- ListPaymentInstrumentUpdatesQueryParams:
- type: object
- properties:
- limit:
- description: The number of entries to return.
- type: integer
- offset:
- description: The number of items to skip before starting to collect the
- result set.
- type: integer
- pageSize:
- description: The size of the page.
- type: integer
+ tags.key:
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ type: string
+ tags.value:
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
+ type: string
ListPaymentInstrumentVerificationsQueryParams:
type: object
properties:
@@ -19788,53 +25170,59 @@ components:
created_at.lte:
description: Filter where `created_at` is before the given date.
type: string
- updated_at.gte:
- description: Filter where `updated_at` is after the given date.
- type: string
- updated_at.lte:
- description: Filter where `updated_at` is before the given date.
+ amount:
+ description: Filter by an amount equal to the given value.
+ type: integer
+ amount.gt:
+ description: Filter by an amount greater than.
+ type: integer
+ amount.gte:
+ description: Filter by an amount greater than or equal.
+ type: integer
+ amount.lt:
+ description: Filter by an amount less than.
+ type: integer
+ amount.lte:
+ description: Filter by an amount less than or equal.
+ type: integer
+ status:
+ description: Filter by the status of the `Settlement`. Available values
+ include:- **PENDING**
- **STAGED**
- **AWAITING_APPROVAL**
- **APPROVED**.
+ Merchants only receive payouts when `Settlements` are **APPROVED**. For
+ more information, see [Payouts](/docs/guides/payouts/payouts/).
type: string
- id:
- description: Filter by `id`.
+ transfer_id:
+ description: 'Filter by a `transfer_id` a `Settlement` has accrued. Please
+ note this filter is only available for non-versioned requests, or requests
+ using `-H ''Finix-Version: 2018-01-01''`. We''re actively working on making
+ this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).'
type: string
- limit:
- description: The numbers of items to return.
- type: integer
- after_cursor:
- description: Return every resource created after the cursor value.
+ funding_transfer_id:
+ description: Filter by a `funding_transfer` a `Settlement` has created.
type: string
- before_cursor:
- description: Return every resource created before the cursor value.
+ Accept:
+ description: Body Header
type: string
ListSettlementFundingTransfersQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
limit:
description: The numbers of items to return.
type: integer
- after_cursor:
- description: Return every resource created after the cursor value.
- type: string
- before_cursor:
- description: Return every resource created before the cursor value.
- type: string
ListSettlementTransfersQueryParams:
type: object
properties:
limit:
description: The numbers of items to return.
type: integer
- after_cursor:
- description: Return every resource created after the cursor value.
- type: string
- before_cursor:
- description: Return every resource created before the cursor value.
- type: string
ListTransfersQueryParams:
type: object
properties:
- sort:
- description: Specify key to be used for sorting the collection.
+ Accept:
+ description: Body Header
type: string
after_cursor:
description: Return every resource created after the cursor value.
@@ -19869,14 +25257,16 @@ components:
id:
description: Filter by `id`.
type: string
- state:
- description: Filter by Transaction state.
- type: string
ready_to_settle_at.gte:
- description: Filter by `ready_to_settle_at`.
+ description: 'Filter where `ready_to_settle_at` is after the given date.
+ Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
type: string
ready_to_settle_at.lte:
- description: Filter by `ready_to_settle_at`.
+ description: 'Filter where `ready_to_settle_at` is before the given date.
+ Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
+ type: string
+ state:
+ description: Filter by Transaction state.
type: string
statement_descriptor:
description: Filter by `statement_descriptor`.
@@ -19935,9 +25325,18 @@ components:
before_cursor:
description: Return every resource created before the cursor value.
type: string
+ tags.key:
+ description: Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).
+ type: string
+ tags.value:
+ description: Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).
+ type: string
ListTransferReversalsQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
limit:
description: The number of entries to return.
type: integer
@@ -19950,6 +25349,9 @@ components:
ListVerificationsQueryParams:
type: object
properties:
+ Accept:
+ description: Body Header
+ type: string
limit:
description: The numbers of items to return.
type: integer
@@ -19981,9 +25383,6 @@ components:
ListFilesQueryParams:
type: object
properties:
- sort:
- description: Specify key to be used for sorting the collection.
- type: string
after_cursor:
description: Return every resource created after the cursor value.
type: string
@@ -20011,9 +25410,6 @@ components:
ListExternalLinksQueryParams:
type: object
properties:
- sort:
- description: Specify key to be used for sorting the collection.
- type: string
after_cursor:
description: Return every resource created after the cursor value.
type: string
@@ -20050,6 +25446,15 @@ components:
before_cursor:
description: Return every resource created before the cursor value.
type: string
+ ListPayoutprofilesQueryParams:
+ type: object
+ properties:
+ after_cursor:
+ description: Return every resource created after the cursor value.
+ type: string
+ limit:
+ description: The numbers of items to return.
+ type: integer
securitySchemes:
BasicAuth:
type: http
From 8c5e19120825dd9c6821614740505fcf89052126 Mon Sep 17 00:00:00 2001
From: kmehta951 <98618440+kmehta951@users.noreply.github.com>
Date: Fri, 29 Sep 2023 16:28:02 -0700
Subject: [PATCH 2/2] Update Readme
Update Readme
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9328faf..1370f22 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ This is the official Finix Python library
Our team is hard at work revamping our SDKs to bring you exciting new features and optimizations.
-While we fine-tune and make changes, we've temporarily paused releasing updates since 09/20/222. If you have any questions, feel free to reach out to the [Finix Support Team](mailto:support@finixpayments.com).
+While we fine-tune and make changes, we've temporarily paused releasing updates since 09/20/22. If you have any questions, feel free to reach out to the [Finix Support Team](mailto:support@finixpayments.com).
### Prerequisites
- Python>=3.6