Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
204 changes: 174 additions & 30 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

56 changes: 56 additions & 0 deletions docs/ACHResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# ACHResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_guid** | **str** | | [optional]
**account_number_last_four** | **str** | | [optional]
**account_type** | **str** | | [optional]
**ach_initiated_at** | **str** | | [optional]
**client_guid** | **str** | | [optional]
**corrected_account_number** | **str** | | [optional]
**corrected_routing_number** | **str** | | [optional]
**created_at** | **str** | | [optional]
**guid** | **str** | | [optional]
**id** | **str** | | [optional]
**institution_guid** | **str** | | [optional]
**investigation_notes** | **str** | | [optional]
**member_guid** | **str** | | [optional]
**processing_errors** | **str** | | [optional]
**resolution_code** | **str** | | [optional]
**resolution_detail** | **str** | | [optional]
**resolved_status_at** | **str** | | [optional]
**return_code** | **str** | | [optional]
**return_notes** | **str** | | [optional]
**return_account_number** | **str** | | [optional]
**return_routing_number** | **str** | | [optional]
**return_status** | **str** | | [optional]
**returned_at** | **str** | | [optional]
**sec_code** | **str** | | [optional]
**started_processing_at** | **str** | | [optional]
**submitted_at** | **str** | | [optional]
**transaction_amount** | **float** | | [optional]
**updated_at** | **str** | | [optional]
**user_guid** | **str** | | [optional]

## Example

```python
from mx_platform_python.models.ach_response import ACHResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ACHResponse from a JSON string
ach_response_instance = ACHResponse.from_json(json)
# print the JSON string representation of the object
print ACHResponse.to_json()

# convert the object into a dict
ach_response_dict = ach_response_instance.to_dict()
# create an instance of ACHResponse from a dict
ach_response_form_dict = ach_response.from_dict(ach_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


43 changes: 43 additions & 0 deletions docs/ACHReturnCreateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# ACHReturnCreateRequest


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_guid** | **str** | The unique identifier for the account associated with the transaction. Defined by MX. |
**account_number_last_four** | **str** | The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI). | [optional]
**ach_initiated_at** | **str** | The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp. | [optional]
**corrected_account_number** | **str** | The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. | [optional]
**corrected_routing_number** | **str** | The routing number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format. | [optional]
**id** | **str** | Client-defined identifier for this specific return submission. Allows you to track and reference you requests. |
**member_guid** | **str** | The unique identifier for the member associated with the transaction. Defined by MX. |
**return_account_number** | **str** | Incorrect account number used in the ACH transaction. | [optional]
**return_code** | **str** | The associated ACH return code and notice of change code (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list. |
**return_notes** | **str** | Notes that you set to inform MX on internal ACH processing. | [optional]
**return_routing_number** | **str** | Incorrect routing number used in the ACH transaction. | [optional]
**returned_at** | **str** | The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp. | [optional]
**sec_code** | **str** | The SEC code (Standard Entry Class Code)–a three-letter code describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list. | [optional]
**transaction_amount** | **float** | The amount of the transaction. | [optional]
**transaction_amount_range** | **float** | The transaction amount range, used for impact assessment. | [optional]
**user_guid** | **str** | MX-defined identifier for the user associated with the ACH return. |

## Example

```python
from mx_platform_python.models.ach_return_create_request import ACHReturnCreateRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ACHReturnCreateRequest from a JSON string
ach_return_create_request_instance = ACHReturnCreateRequest.from_json(json)
# print the JSON string representation of the object
print ACHReturnCreateRequest.to_json()

# convert the object into a dict
ach_return_create_request_dict = ach_return_create_request_instance.to_dict()
# create an instance of ACHReturnCreateRequest from a dict
ach_return_create_request_form_dict = ach_return_create_request.from_dict(ach_return_create_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


28 changes: 28 additions & 0 deletions docs/ACHReturnCreateRequestBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ACHReturnCreateRequestBody


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ach_return** | [**ACHReturnCreateRequest**](ACHReturnCreateRequest.md) | | [optional]

## Example

```python
from mx_platform_python.models.ach_return_create_request_body import ACHReturnCreateRequestBody

# TODO update the JSON string below
json = "{}"
# create an instance of ACHReturnCreateRequestBody from a JSON string
ach_return_create_request_body_instance = ACHReturnCreateRequestBody.from_json(json)
# print the JSON string representation of the object
print ACHReturnCreateRequestBody.to_json()

# convert the object into a dict
ach_return_create_request_body_dict = ach_return_create_request_body_instance.to_dict()
# create an instance of ACHReturnCreateRequestBody from a dict
ach_return_create_request_body_form_dict = ach_return_create_request_body.from_dict(ach_return_create_request_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


28 changes: 28 additions & 0 deletions docs/ACHReturnResponseBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ACHReturnResponseBody


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ach_return** | [**ACHResponse**](ACHResponse.md) | | [optional]

## Example

```python
from mx_platform_python.models.ach_return_response_body import ACHReturnResponseBody

# TODO update the JSON string below
json = "{}"
# create an instance of ACHReturnResponseBody from a JSON string
ach_return_response_body_instance = ACHReturnResponseBody.from_json(json)
# print the JSON string representation of the object
print ACHReturnResponseBody.to_json()

# convert the object into a dict
ach_return_response_body_dict = ach_return_response_body_instance.to_dict()
# create an instance of ACHReturnResponseBody from a dict
ach_return_response_body_form_dict = ach_return_response_body.from_dict(ach_return_response_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


29 changes: 29 additions & 0 deletions docs/ACHReturnsResponseBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ACHReturnsResponseBody


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ach_returns** | [**List[ACHResponse]**](ACHResponse.md) | | [optional]
**pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional]

## Example

```python
from mx_platform_python.models.ach_returns_response_body import ACHReturnsResponseBody

# TODO update the JSON string below
json = "{}"
# create an instance of ACHReturnsResponseBody from a JSON string
ach_returns_response_body_instance = ACHReturnsResponseBody.from_json(json)
# print the JSON string representation of the object
print ACHReturnsResponseBody.to_json()

# convert the object into a dict
ach_returns_response_body_dict = ach_returns_response_body_instance.to_dict()
# create an instance of ACHReturnsResponseBody from a dict
ach_returns_response_body_form_dict = ach_returns_response_body.from_dict(ach_returns_response_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/AccountNumberResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Name | Type | Description | Notes
**account_guid** | **str** | | [optional]
**account_number** | **str** | | [optional]
**guid** | **str** | | [optional]
**institution_number** | **str** | | [optional]
**loan_guarantor** | **str** | | [optional]
**loan_reference_number** | **str** | | [optional]
**institution_number** | **str** | | [optional]
**member_guid** | **str** | | [optional]
**passed_validation** | **bool** | | [optional]
**routing_number** | **str** | | [optional]
Expand Down
42 changes: 21 additions & 21 deletions docs/AccountUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_subtype** | **str** | | [optional]
**account_type** | **str** | | [optional]
**apr** | **float** | | [optional]
**apy** | **float** | | [optional]
**available_balance** | **float** | | [optional]
**balance** | **float** | | [optional]
**cash_surrender_value** | **float** | | [optional]
**credit_limit** | **float** | | [optional]
**currency_code** | **str** | | [optional]
**death_benefit** | **int** | | [optional]
**interest_rate** | **float** | | [optional]
**is_business** | **bool** | | [optional]
**is_closed** | **bool** | | [optional]
**is_hidden** | **bool** | | [optional]
**loan_amount** | **float** | | [optional]
**metadata** | **str** | | [optional]
**name** | **str** | | [optional]
**nickname** | **str** | | [optional]
**original_balance** | **float** | | [optional]
**property_type** | **str** | | [optional]
**skip_webhook** | **bool** | | [optional]
**account_subtype** | **str** | Can only be updated for manual accounts. | [optional]
**account_type** | **str** | Can only be updated for manual accounts. | [optional]
**apr** | **float** | Can only be updated for manual accounts. | [optional]
**apy** | **float** | Can only be updated for manual accounts. | [optional]
**available_balance** | **float** | Can only be updated for manual accounts. | [optional]
**balance** | **float** | Can only be updated for manual accounts. | [optional]
**cash_surrender_value** | **float** | Can only be updated for manual accounts. | [optional]
**credit_limit** | **float** | Can only be updated for manual accounts. | [optional]
**currency_code** | **str** | Can only be updated for manual accounts. | [optional]
**death_benefit** | **int** | Can only be updated for manual accounts. | [optional]
**interest_rate** | **float** | Can only be updated for manual accounts. | [optional]
**is_business** | **bool** | Can be updated for manual accounts and aggregated accounts. | [optional]
**is_closed** | **bool** | Can only be updated for manual accounts. | [optional]
**is_hidden** | **bool** | Can be updated for manual accounts and aggregated accounts. | [optional]
**loan_amount** | **float** | Can only be updated for manual accounts. | [optional]
**metadata** | **str** | Can only be updated for manual accounts. | [optional]
**name** | **str** | Can only be updated for manual accounts. | [optional]
**nickname** | **str** | Can only be updated for manual accounts. | [optional]
**original_balance** | **float** | Can only be updated for manual accounts. | [optional]
**property_type** | **str** | Can only be updated for manual accounts. | [optional]
**skip_webhook** | **bool** | If set to true, prevents sending an account webhook for the update if that webhook type is enabled for you. | [optional]

## Example

Expand Down
Loading