Skip to content

moovfinancial/moov-python

BranchesTags

Repository files navigation

moov

Developer-friendly & type-safe Python SDK specifically catered to leverage moov API.



Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Moov API: Moov is a platform that enables developers to integrate all aspects of money movement with ease and speed. The Moov API makes it simple for platforms to send, receive, and store money. Our API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. To learn more about how Moov works at a high level, read our concepts guide.

Table of Contents

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

SDK Example Usage

Example

# Synchronous Example
from moov import Moov
import os

s = Moov(
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
})

if res is not None:
    # handle response
    pass

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from moov import Moov
import os

async def main():
    s = Moov(
        gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
    )
    res = await s.signup.self_signup_async(request={
        "email": "amanda@classbooker.dev",
    })
    if res is not None:
        # handle response
        pass

asyncio.run(main())

Available Resources and Operations

Available methods

access_token

accounts

analytics

application

avatars

bank_accounts

branding

capabilities

card_issuing

cards

checkout

connections

devices

disputes

email_password

end_to_end_encryption

enriched_address

enriched_profile

files

industries

institutions

invites

issuing_transactions

moov_internal

onboarding

open_id_connect

payment_methods

ping

  • ping - Test Authentication

representatives

roles

schedules

session

signup

sweeps

transfers

underwriting

users

verification

wallet_transactions

wallets

webhooks

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

import moov
from moov import Moov
import os

s = Moov(
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.disputes.upload_evidence_file(dispute_id="ec7e1848-dc80-4ab0-8827-dd7fc0737b43", evidence_file={
    "file": {
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    },
    "evidence_type": moov.EvidenceType.CUSTOMER_COMMUNICATION,
})

if res is not None:
    # handle response
    pass

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from moov import Moov
from moov.utils import BackoffStrategy, RetryConfig
import os

s = Moov(
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
},
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from moov import Moov
from moov.utils import BackoffStrategy, RetryConfig
import os

s = Moov(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
})

if res is not None:
    # handle response
    pass

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.SDKError exception, which has the following properties:

Property Type Description
.status_code int The HTTP status code
.message str The error message
.raw_response httpx.Response The raw HTTP response
.body str The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_o_auth2_token_async method may raise the following exceptions:

Error Type Status Code Content Type
models.AccessTokenErrorResponse 400 application/json
models.SDKError 4XX, 5XX */*

Example

from .clientcredentialsgranttoaccesstokenerrorresponse import ClientCredentialsGrantToAccessTokenErrorResponseData
import moov
from moov import Moov, models
import os

s = Moov()

res = None
try:
    res = s.access_token.create_o_auth2_token(security=moov.CreateOAuth2TokenSecurity(
        username=os.getenv("MOOV_USERNAME", ""),
        password=os.getenv("MOOV_PASSWORD", ""),
    ), request={
        "grant_type": moov.GrantType.REFRESH_TOKEN,
        "client_id": "5clTR_MdVrrkgxw2",
        "client_secret": "dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-",
        "scope": "/accounts.write",
        "refresh_token": "i1qxz68gu50zp4i8ceyxqogmq7y0yienm52351c6...",
    })

    if res is not None:
        # handle response
        pass

except models.AccessTokenErrorResponse as e:
    if isinstance(e.data, ClientCredentialsGrantToAccessTokenErrorResponseData):
        # handle custom error data
    raise(e)
except models.SDKError as e:
    # handle exception
    raise(e)

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://api.moov.io None

Example

from moov import Moov
import os

s = Moov(
    server_idx=0,
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
})

if res is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from moov import Moov
import os

s = Moov(
    server_url="https://api.moov.io",
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
})

if res is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from moov import Moov
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Moov(client=http_client)

or you could wrap the client with your own custom logic:

from moov import Moov
from moov.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Moov(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
gateway_auth http HTTP Bearer MOOV_GATEWAY_AUTH

To authenticate with the API the gateway_auth parameter must be set when initializing the SDK client instance. For example:

from moov import Moov
import os

s = Moov(
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.signup.self_signup(request={
    "email": "amanda@classbooker.dev",
})

if res is not None:
    # handle response
    pass

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import moov
from moov import Moov
import os

s = Moov()

res = s.access_token.create_o_auth2_token(security=moov.CreateOAuth2TokenSecurity(
    username=os.getenv("MOOV_USERNAME", ""),
    password=os.getenv("MOOV_PASSWORD", ""),
), request={
    "grant_type": moov.GrantType.REFRESH_TOKEN,
    "client_id": "5clTR_MdVrrkgxw2",
    "client_secret": "dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-",
    "scope": "/accounts.write",
    "refresh_token": "i1qxz68gu50zp4i8ceyxqogmq7y0yienm52351c6...",
})

if res is not None:
    # handle response
    pass

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from moov import Moov
import logging

logging.basicConfig(level=logging.DEBUG)
s = Moov(debug_logger=logging.getLogger("moov"))

You can also enable a default debug logger by setting an environment variable MOOV_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

Python SDK for Moov's API

docs.moov.io

Topics

payments

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages