API Reference Circlex v0.1.6

modules

Modules

A module to build requests for Circle API calls.

API Client to access Wallets service from the Circle API.

API Client to the Channels API.

API Client to the Circle Core Addresses API.

API Client to the Core Balances API.

API Client to the Core Bank Accounts API.

API Client to the Core Payouts API.

API Client to the Core Transfers API.

API Client to the Encryption API.

API Client to the Health API.

API Client to the Management API.

API Client to the Payments Bank Accounts API.

API Client to the Payments Payments API.

API Client to the Payouts Bank Accounts API.

API Client to the Payouts Payouts API.

API Client to the Payouts Transfers API.

API Client to the Stabecoins API.

API Client to the Subscriptions API.

A basic server to mimic the functionality of Circle.

Models a wire payment (transfer in)

Models a wire payout (transfer out)

Handles a transfer, either in or out, specifically handling

Mounted under /v1/wallets.

Mounted under /circlex.

Mounted under /v1/businessAccount/wallet/addresses.

Mounted under /v1/businessAccount/balances.

Mounted under /v1/businessAccount/banks and /v1/banks

Mounted under /v1/businessAccount/payouts.

Mounted under /v1/businessAccount/transfers.

Mounted under /ping.

Mounted under /v1/configuration.

Mounted under /v1/mocks.

Mounted under /v1/payments.

Mounted under /v1/payouts.

Mounted under /v1/transfers.

Mounted under /v1/stablecoins.

Mounted under /v1/notifications/subscriptions.

Checks for Deposits

Helper functions for common logic utilities.

Process to handle sending out notifications, such as SNS subscriptions.

Service to simulate sending SNS notifications.

mix-tasks

Mix Tasks

Starts the Emulator.