Rust API client for circle-api

Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 2.12.0
• Package version: 2.12.0
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named circle-api and add the following to Cargo.toml under [dependencies]:

circle-api = { path = "./circle-api" }

Documentation for API Endpoints

All URIs are relative to https://api-sandbox.circle.com

Class	Method	HTTP request	Description
AddressesApi	create_business_deposit_address	POST /v1/businessAccount/wallets/addresses/deposit	Create a deposit address
AddressesApi	create_business_recipient_address	POST /v1/businessAccount/wallets/addresses/recipient	Create a recipient address
AddressesApi	delete_business_recipient_address	DELETE /v1/businessAccount/wallets/addresses/recipient/{id}	Delete a recipient address
AddressesApi	get_business_deposit_address	GET /v1/businessAccount/wallets/addresses/deposit	List all deposit addresses
AddressesApi	list_business_recipient_addresses	GET /v1/businessAccount/wallets/addresses/recipient	List all recipient addresses
BalancesApi	list_balances	GET /v1/balances	List all balances
BalancesApi	list_business_balances	GET /v1/businessAccount/balances	List all balances
CbitApi	create_business_cbit_account	POST /v1/businessAccount/banks/cbit	Create a CBIT bank account
CbitApi	get_business_cbit_account	GET /v1/businessAccount/banks/cbit/{id}	Get a CBIT bank account
CbitApi	get_business_cbit_account_instructions	GET /v1/businessAccount/banks/cbit/{id}/instructions	Get CBIT instructions
CbitApi	list_business_cbit_accounts	GET /v1/businessAccount/banks/cbit	List all CBIT bank accounts.
CardsApi	create_card	POST /v1/cards	Create a card
CardsApi	get_card	GET /v1/cards/{id}	Get a card
CardsApi	list_cards	GET /v1/cards	List all cards
CardsApi	update_card	PUT /v1/cards/{id}	Update a card
ChannelsApi	list_channels	GET /v1/channels	List all channels
ChargebacksApi	create_mock_chargeback	POST /v1/mocks/cards/chargebacks	Create a mock chargeback
ChargebacksApi	get_chargeback	GET /v1/chargebacks/{id}	Get a chargeback
ChargebacksApi	list_chargebacks	GET /v1/chargebacks	List all chargebacks
CheckoutSessionsApi	create_checkout_session	POST /v1/checkoutSessions	Create a checkout session
CheckoutSessionsApi	extend_checkout_session	POST /v1/checkoutSessions/{id}/extend	Extend a checkout session
CheckoutSessionsApi	get_checkout_session	GET /v1/checkoutSessions/{id}	Get a checkout session
CheckoutSessionsApi	list_checkout_sessions	GET /v1/checkoutSessions	List all checkout sessions
CryptoAddressBookApi	create_address_book_recipient	POST /v1/addressBook/recipients	Create a recipient
CryptoAddressBookApi	delete_address_book_recipient	DELETE /v1/addressBook/recipients/{id}	Delete a recipient
CryptoAddressBookApi	get_address_book_recipient	GET /v1/addressBook/recipients/{id}	Get a recipient
CryptoAddressBookApi	list_address_book_recipients	GET /v1/addressBook/recipients	List all recipients
CryptoAddressBookApi	modify_address_book_recipient	PATCH /v1/addressBook/recipients/{id}	Modify a recipient
CryptoExchangeRatesApi	get_exchange_rates	GET /v1/exchange/rates/{trading-pair}	Get a exchange rate
CryptoPaymentIntentsApi	create_payment_intent	POST /v1/paymentIntents	Create a payment intent
CryptoPaymentIntentsApi	expire_payment_intent	POST /v1/paymentIntents/{id}/expire	Expire a payment intent
CryptoPaymentIntentsApi	get_payment_intent	GET /v1/paymentIntents/{id}	Get a payment intent
CryptoPaymentIntentsApi	list_payment_intents	GET /v1/paymentIntents	List all payment intents
CryptoPaymentIntentsApi	refund_payment_intent	POST /v1/paymentIntents/{id}/refund	Refund a payment intent
DepositsApi	list_business_deposits	GET /v1/businessAccount/deposits	List all deposits
EncryptionApi	get_public_key	GET /v1/encryption/public	Get public key
HealthApi	ping	GET /ping	Ping
ManagementApi	get_account_config	GET /v1/configuration	Get configuration info
PixApi	create_business_pix_account	POST /v1/businessAccount/banks/pix	Create a PIX bank account
PixApi	get_business_pix_account	GET /v1/businessAccount/banks/pix/{id}	Get a PIX bank account
PixApi	get_business_pix_account_instructions	GET /v1/businessAccount/banks/pix/{id}/instructions	Get PIX instructions
PixApi	list_business_pix_accounts	GET /v1/businessAccount/banks/pix	List all PIX bank accounts.
PaymentTokensApi	create_payment_token	POST /v1/paymentTokens	Create a payment token
PaymentsApi	cancel_payment	POST /v1/payments/{id}/cancel	Cancel a payment
PaymentsApi	capture_payment	POST /v1/payments/{id}/capture	Capture a payment (BETA)
PaymentsApi	create_mock_wire_payment	POST /v1/mocks/payments/wire	Create a mock Wire payment
PaymentsApi	create_payment	POST /v1/payments	Create a payment
PaymentsApi	exchange_rate	POST /v1/exchange/quotes	Fetch exchange rate
PaymentsApi	get_payment	GET /v1/payments/{id}	Get a payment
PaymentsApi	list_payments	GET /v1/payments	List all payments
PaymentsApi	refund_payment	POST /v1/payments/{id}/refund	Refund a payment
PayoutsApi	create_business_payout	POST /v1/businessAccount/payouts	Create a payout
PayoutsApi	create_payout	POST /v1/payouts	Create a payout
PayoutsApi	get_business_payout	GET /v1/businessAccount/payouts/{id}	Get a payout
PayoutsApi	get_payout	GET /v1/payouts/{id}	Get a payout
PayoutsApi	list_business_payouts	GET /v1/businessAccount/payouts	List all payouts
PayoutsApi	list_net_burn_fee_daily_calculations	GET /v1/fees/redemption/net/dailyReports	List all NET burn daily fee calculations
PayoutsApi	list_payouts	GET /v1/payouts	List all payouts
PullCryptoPaymentsApi	create_crypto_payment	POST /v1/payments/crypto	Create a crypto payment
PullCryptoPaymentsApi	presign	GET /v1/payments/presign	Get a typed message for signing
SettlementsApi	get_settlement	GET /v1/settlements/{id}	Get a settlement
SettlementsApi	list_settlements	GET /v1/settlements	List all settlements
StablecoinsApi	list_stablecoins	GET /v1/stablecoins	List all stablecoins
SubscriptionsApi	create_subscription	POST /v1/notifications/subscriptions	Create a notification subscription
SubscriptionsApi	delete_subscription	DELETE /v1/notifications/subscriptions/{id}	Remove a notification subscription
SubscriptionsApi	list_subscriptions	GET /v1/notifications/subscriptions	List all notification subscriptions
TransfersApi	create_business_transfer	POST /v1/businessAccount/transfers	Create a transfer
TransfersApi	create_transfer	POST /v1/transfers	Create a transfer
TransfersApi	get_business_transfer	GET /v1/businessAccount/transfers/{id}	Get a transfer
TransfersApi	get_transfer	GET /v1/transfers/{id}	Get a transfer
TransfersApi	list_business_transfers	GET /v1/businessAccount/transfers	List all transfers
TransfersApi	list_transfers	GET /v1/transfers	List all transfers
WalletsApi	create_wallet	POST /v1/wallets	Create a wallet
WalletsApi	generate_address	POST /v1/wallets/{walletId}/addresses	Create a blockchain address
WalletsApi	get_wallet	GET /v1/wallets/{walletId}	Get a wallet
WalletsApi	list_addresses	GET /v1/wallets/{walletId}/addresses	List all addresses
WalletsApi	list_wallets	GET /v1/wallets	List all wallets
WiresApi	create_business_wire_account	POST /v1/businessAccount/banks/wires	Create a Wire bank account
WiresApi	get_business_wire_account	GET /v1/businessAccount/banks/wires/{id}	Get a Wire bank account
WiresApi	get_business_wire_account_instructions	GET /v1/businessAccount/banks/wires/{id}/instructions	Get Wire instructions
WiresApi	list_business_wire_accounts	GET /v1/businessAccount/banks/wires	List all Wire bank accounts

Documentation For Models

• AccountConfiguration
• AddressBookRecipient
• AddressBookRecipientMetadata
• AddressBookRecipientModifyRequest
• AddressBookRecipientRequest
• AddressObject
• ApplePayToken
• ApplePayTokenEcHeader
• ApplePayTokenHeader
• ApplePayTokenRsaHeader
• BadRequest
• Balances
• BankAddress
• BankAddressIbanSupported
• BankAddressNonIban
• BankDestination
• BasicChargeback
• BasicChargebackHistory
• BillingDetails
• BurnFeeNetAmount
• BurnFeePaymentAmount
• BurnFeePayoutAmount
• BusinessAccountPayoutDestinationType
• BusinessDeposit
• BusinessDestinationRequest
• BusinessGenerateAddressRequest
• BusinessPayout
• BusinessPayoutCreationRequest
• BusinessPixAccountInstructionsResponse
• BusinessRecipientAddressCreationRequest
• BusinessRecipientAddressObject
• BusinessTransferCreationRequest
• CancelCreationRequest
• CancelPaymentResponse
• CancelRefundReversalStatus
• CaptureCreationRequest
• Card
• CardCreationRequest
• CardUpdate
• CardVerificationResponse
• CbitFiatAccountCreationRequest
• CbitFiatAccountResponse
• CbitInstruction
• Chain
• ChannelResponse
• ChargebackCategories
• ChargebackStatus
• CheckoutSession
• CheckoutSessionCreationRequest
• CheckoutSessionMoney
• CheckoutSessionStatus
• Conflict
• ContinuousPaymentIntent
• ContinuousPaymentIntentCreationRequest
• CreateAddressBookRecipientResponse
• CreateBusinessCbitAccountResponse
• CreateBusinessDepositAddressResponse
• CreateBusinessPayoutResponse
• CreateBusinessPixAccountResponse
• CreateBusinessRecipientAddressResponse
• CreateBusinessTransferResponse
• CreateBusinessWireAccountResponse
• CreateCardResponse
• CreateCheckoutSessionResponse
• CreateCryptoPaymentResponse
• CreateCryptoPaymentResponse1
• CreateCryptoRefundResponse
• CreateMockChargebackResponse
• CreatePaymentIntentRequest
• CreatePaymentIntentResponse
• CreatePaymentIntentResponseData
• CreatePaymentResponse
• CreatePaymentTokenResponse
• CreatePayoutResponse
• CreateSubscriptionResponse
• CreateTransferResponse
• CreateWalletResponse
• CreateWirePaymentResponse
• CryptoPayment
• CryptoPaymentCreationRequest
• CryptoPaymentDepositAddress
• CryptoPaymentDestination
• CryptoPaymentFromAddresses
• CryptoPaymentNetworkFee
• CryptoPaymentSource
• CryptoPaymentsMoney
• CryptoPaymentsOptionalAmountMoney
• CryptoPayout
• CryptoPayoutCreationRequest
• CryptoPayoutDestination
• CryptoPayoutDestinationType
• CryptoRefundCreationRequest
• CryptoRefundCreationRequestAmount
• CryptoRefundCreationRequestToAmount
• CryptoRefundDestination
• Currency
• CvvResults
• DeleteSubscriptionResponse
• DetailedCancel
• DetailedPayment
• DetailedRefund
• Eci
• ExchangeRateRequest
• ExchangeRateResponse
• ExpirePaymentIntentResponse
• ExtendCheckoutSessionRequest
• ExtendCheckoutSessionResponse
• ExternalFiatAccountStatus
• Fee
• FetchExchangeRateResponse
• FiatCancel
• FiatCurrency
• FiatMoney
• FiatMoneyUsd
• FiatOptionalAmountMoney
• FiatPayment
• FiatPaymentPolymorphic
• FiatPayoutToMoney
• FiatRefund
• FinalAdjustments
• Forbidden
• GenerateAddressRequest
• GenerateAddressResponse
• GetAddressBookRecipientResponse
• GetBusinessCbitAccountResponse
• GetBusinessDepositAddressResponse
• GetBusinessPayoutResponse
• GetBusinessPixAccountResponse
• GetBusinessTransferResponse
• GetBusinessWireAccountInstructionsResponse
• GetBusinessWireAccountResponse
• GetCardResponse
• GetChargebackResponse
• GetCheckoutSessionResponse
• GetConfigResponse
• GetExchangeRatesResponse
• GetPaymentIntentResponse
• GetPaymentResponse
• GetPaymentResponseData
• GetPayoutResponse
• GetPublicKeyResponse
• GetSettlementResponse
• GetSettlementsResponse
• GetTransferResponse
• GetWalletResponse
• GooglePayToken
• Identity
• IdentityAddress
• LimitExceeded
• ListAddressBookRecipientsResponse
• ListAddressesResponse
• ListBalancesResponse
• ListBurnFeeCalculationsResponse
• ListBusinessBalancesResponse
• ListBusinessCbitAccountInstructionsResponse
• ListBusinessCbitAccountsResponse
• ListBusinessDepositsResponse
• ListBusinessPayoutsResponse
• ListBusinessPixAccountsResponse
• ListBusinessRecipientAddressesResponse
• ListBusinessTransfersResponse
• ListBusinessWireAccountsResponse
• ListCardsResponse
• ListChannelsResponse
• ListChargebacksResponse
• ListCheckoutSessionsResponse
• ListPaymentIntentsResponse
• ListPaymentIntentsResponseDataInner
• ListPaymentsResponse
• ListPaymentsResponseDataInner
• ListPayoutsResponse
• ListStablecoinsResponse
• ListSubscriptionsResponse
• ListTransfersResponse
• ListWalletsResponse
• MetadataCardAndAch
• MetadataCryptoPayment
• MetadataPayment
• MetadataPhoneEmail
• MockChargebackCreationRequest
• MockWirePaymentBeneficiaryBankInstruction
• MockWirePaymentRequest
• MockWirePaymentResponse
• ModifyAddressBookRecipientResponse
• Money
• NetworkFeeQuote
• NotAuthorized
• NotFound
• PaymentCreationRequest
• PaymentErrorCode
• PaymentInfoCancel
• PaymentInfoPaymentAndRefund
• PaymentIntent
• PaymentIntentCreationRequest
• PaymentIntentFees
• PaymentMethodBlockchain
• PaymentStatus
• PaymentToken
• PaymentTokenRequest
• PaymentTokenRequestTokenData
• PaymentVerificationResponse
• PayoutDestinationType
• PayoutErrorCode
• PayoutMoney
• PayoutStatus
• Ping
• PixAccountType
• PixFiatAccountCreationRequest
• PixFiatAccountResponse
• PixInstruction
• PresignDomain
• PresignMessage
• PresignMessageTypes
• PresignMessageTypesItems
• PresignResponse
• PresignResponseTypedData
• PublicKey
• Rate
• RedemptionFeeCalculation
• RefundCreationRequest
• RefundPaymentResponse
• RequiredAction
• ReversalReason
• RiskEvaluation
• Settlement
• SimpleBillingDetails
• SimpleCard
• Source
• SourceResponse
• Stablecoin
• SubscriptionDetail
• SubscriptionRequest
• SubscriptionResponse
• ThreeDsResult
• Timeline
• ToAmount
• TokenAmount
• TokenizedCardDetails
• Transfer
• TransferCreationRequest
• TransferCreationRequestDestination
• TransferDestinationBlockchainLocation
• TransferDestinationLocation
• TransferDestinationWalletLocation
• TransferDetailedTransfer
• TransferErrorCode
• TransferRequestBlockchainLocation
• TransferRequestSourceWalletLocation
• TransferRequestVerifiedBlockchainLocation
• TransferSourceBlockchainLocation
• TransferSourceLocation
• TransferSourceWalletLocation
• TransferTypeInfo
• TransferTypeInfoAdditionalProperties
• UnwithdrawalObject
• UpdateBillingDetails
• UpdateCardResponse
• VerificationErrorCode
• Wallet
• WalletConfig
• WalletCreationRequest
• WalletLocation
• Wire
• WireCreationRequest
• WireCreationRequestAccountNumber
• WireCreationRequestIban
• WireCreationRequestUs
• WireInstruction
• WireInstructionBeneficiary
• WireInstructionBeneficiaryBank

To get access to the crate's generated documentation, use:

cargo doc --open

Author