* Checks that the service is running. * @summary Ping * @param {*} [options] Override http request option. * @throws {RequiredError} * @me

* * @summary Create a recipient * @param {AddressBookRecipientRequest} [addressBookRecipientRequest] * @param {*} [options] Override http req

* * @summary Create a CUBIX bank account * @param {CubixFiatAccountCreationRequest} [cubixFiatAccountCreationRequest] * @param {*} [options]

* Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For e

* Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency. * @summary Create a payout * @param {BusinessPayo

* * @summary Create a PIX bank account * @param {PixFiatAccountCreationRequest} [pixFiatAccountCreationRequest] * @param {*} [options] Overri

* Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. **Fo

* A transfer can be made from an existing business account to a blockchain location. * @summary Create a transfer * @param {BusinessTransferCrea

* * @summary Create a wire bank account * @param {WireCreationRequest} [wireCreationRequest] * @param {*} [options] Override http request opt

* Creates an external entity for the institutional account. To access the Core API for Institutions, contact your Circle account representative. *

* Creates a currency trading account * @summary Create FX account * @param {CreateFxAccountRequest} [createFxAccountRequest] * @param {*} [op

* Creates a cross-currency trade * @summary Create FX trade * @param {FxTradeRequest} [fxTradeRequest] * @param {*} [options] Override http r

* Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet.

* In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wal

* Create a transient or continuous payment intent * @summary Create a payment intent * @param {CreatePaymentIntentRequest} [createPaymentIntentR

* Create a crypto payout. The following table includes the supported pairs of `amount.currency` and `toAmount.currency` for address book payouts:

* Subscribe to receiving notifications at a given endpoint. The endpoint should be able to handle AWS SNS subscription requests. For more details see

* * @summary Delete a recipient * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override h

* Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully.

* To remove a subscription, all its subscription requests\' statuses must be either \'confirmed\', \'deleted\' or a combination of those. A subscripti

* * @summary Expire a payment intent * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {object} [body]

* Retrieves general configuration information. * @summary Get configuration info * @param {*} [options] Override http request option. * @thro

* * @summary Get a recipient * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http

* Returns all external entities for the institutional account. To access the Core API for Institutions, contact your Circle account representative.

* * @summary Get a CUBIX bank account * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Over

* Get the CUBIX transfer instructions into the Circle bank account given your fiat account id. * @summary Get CUBIX instructions * @param {strin

* Returns a list of deposit addresses for a given wallet. * @summary List all deposit addresses * @param {string} [walletId] The wallet ID for w

* Returns a deposit by ID. * @summary Get a deposit by ID * @param {string} id Universally unique identifier (UUID v4) of a resource. * @para

* * @summary Get a payout * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http re

* * @summary Get a PIX bank account * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Overri

* Get the PIX transfer instructions into the Circle bank account given your bank account id. * @summary Get PIX instructions * @param {string} i

* * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http

* * @summary Get a wire bank account * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Overr

* Get the wire transfer instructions into the Circle bank account given your bank account ID. * @summary Get wire instructions * @param {string}

* Returns daily currency exchange limits and usages. * @summary Get daily currency exchange limits * @param {*} [options] Override http request

* Returns an external entity by wallet ID. To access the Core API for Institutions, contact your Circle account representative. * @summary Get an

* Returns an FX trade by ID. * @summary Get FX trade * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*}

* Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement.

* * @summary Get a payment * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http r

* * @summary Get a payment intent * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override

* * @summary Get a payout * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http re

* Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange r

* Returns a settlement by ID. * @summary Get settlement * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param

* Returns settlement instructions for a specific currency. * @summary Get settlement instructions * @param {'BRL' | 'MXN'} currency Fiat currenc

* Returns all settlements. * @summary Get all settlements * @param {string} [from] Queries items created since the specified date-time (inclusiv

* * @summary List all recipients * @param {string} [address] Filters results to fetch only address book recipients with the provided address.

* Retrieves the balance of funds that are available for use. * @summary List all balances * @param {string} [walletId] The wallet ID of the wall

* * @summary List all CUBIX bank accounts. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CUBI

* Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up

* Lists all payouts for your account. Note that this endpoint does not return the tracking reference number for the payouts in the response. If you n

* * @summary List all PIX bank accounts. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PIXApi

* Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator ver

* Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up t

* * @summary List all wire bank accounts * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WiresA

* Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provi

* * @summary List all payment intents * @param {'created' | 'pending' | 'complete' | 'expired' | 'failed'} [status] Filters by the most recent &

* * @summary List all payments * @param {string} [source] Universally unique identifier (UUID v4) for the source. Filters results to fetch only

* * @summary List all payouts * @param {string} [source] Identifier for the source wallet. Filters the fetched payout results to only be from a

* Retrieves total circulating supply for supported stablecoins across all chains. This endpoint is rate limited to one call per minute (based on IP).

* Retrieve a list of existing notification subscriptions with details. * @summary List all notification subscriptions * @param {*} [options] Ove

* * @summary Modify a recipient * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {AddressBookRecipientMod

* * @summary Refund a payment intent * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {CryptoRefundCreati

* Creates a daily custody balance report for USDC and EURC and sends it to Circle. **Note:** Only one report is allowed per day per currency. * @s