Circle.Client

https://developers.circle.com/developer/v1/docs

Documentation

createBusinessWireAccount :: WireAccountRequestBody -> CircleAPIRequest WireAccountRequest TupleBS8 ByteString

Create a business bank account for a wire https://developers.circle.com/reference/createbusinesswireaccount

listBusinessWireAccounts :: CircleAPIRequest WireAccountsRequest TupleBS8 ByteString

Get a list of business account wire accounts https://developers.circle.com/reference/listbusinesswireaccounts

getBusinessWireAccount :: UUID -> CircleAPIRequest WireAccountRequest TupleBS8 ByteString

Get a single business account wire account, accepts the wire account Id as a parameter https://developers.circle.com/reference/getbusinesswireaccount

getBusinessWireAccountInstructions :: UUID -> CircleAPIRequest WireInstructionsRequest TupleBS8 ByteString

Get the wire transfer instructions into the Circle business bank account given your bank account id. https://developers.circle.com/reference/getbusinesswireaccountinstructions

listAllBusinessBalances :: CircleAPIRequest BalanceRequest TupleBS8 ByteString

List all business balances https://developers.circle.com/reference/listbusinesspayouts

getConfigurationInfo :: CircleAPIRequest ConfigurationRequest TupleBS8 ByteString

Get configuration info https://developers.circle.com/reference/getaccountconfig

getPublicKey :: CircleAPIRequest EncryptionRequest TupleBS8 ByteString

Get encryption info https://developers.circle.com/reference/getpublickey

listAllChannels :: CircleAPIRequest ChannelsRequest TupleBS8 ByteString

List all channels https://developers.circle.com/reference/listchannels

listAllStablecoins :: CircleAPIRequest StablecoinsRequest TupleBS8 ByteString

List all stablecoins https://developers.circle.com/reference/listchannels

listAllNotificationSubscriptions :: CircleAPIRequest SubscriptionsRequest TupleBS8 ByteString

List all subscriptions https://developers.circle.com/reference/listsubscriptions

createSubscription :: SubscriptionRequestBody -> CircleAPIRequest SubscriptionRequest TupleBS8 ByteString

Create new subscription https://developers.circle.com/reference/createsubscribtion

deleteSubscription :: UUID -> CircleAPIRequest SubscriptionsRequest TupleBS8 ByteString

Delete subscription https://developers.circle.com/reference/deletesubscribtion

listAllBusinessAccountPayouts :: CircleAPIRequest PayoutsRequest TupleBS8 ByteString

Lists all payouts made from a given business account https://developers.circle.com/reference/listbusinesspayouts

getBusinessAccountPayout :: UUID -> CircleAPIRequest PayoutRequest TupleBS8 ByteString

Gets a specific payout associated with a business account https://developers.circle.com/reference/getbusinesspayout

createBusinessAccountPayout :: BusinessPayoutRequestBody -> CircleAPIRequest PayoutRequest TupleBS8 ByteString

Creates a business account payout https://developers.circle.com/reference/createbusinesspayout

listAllBusinessAccountTransfers :: CircleAPIRequest TransfersRequest TupleBS8 ByteString

Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. https://developers.circle.com/reference/listbusinesstransfers

getBusinessAccountTransfer :: UUID -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Get a business account transfer based on a transfer ID https://developers.circle.com/reference/getbusinesstransfer

createBusinessAccountTransfer :: BusinessTransferRequestBody -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Create a new transfer https://developers.circle.com/reference/createbusinesstransfer

listAllBusinessAccountDepositAddresses :: CircleAPIRequest DepositAddressesRequest TupleBS8 ByteString

List all deposit addresses https://developers.circle.com/developer/v1/reference/getbusinessdepositaddress

createBusinessAccountDepositAddress :: DepositAddressRequestBody -> CircleAPIRequest DepositAddressRequest TupleBS8 ByteString

Create new business account deposit address Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. https://developers.circle.com/developer/v1/reference/createbusinessdepositaddress

listAllBusinessAccountRecipientAddresses :: CircleAPIRequest RecipientAddressesRequest TupleBS8 ByteString

List all recipient addresses Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. https://developers.circle.com/developer/v1/reference/listbusinessrecipientaddresses

createBusinessAccountRecipientAddress :: RecipientAddressRequestBody -> CircleAPIRequest RecipientAddressRequest TupleBS8 ByteString

Create a new recipient address Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. https://developers.circle.com/developer/v1/reference/createbusinessrecipientaddress

listAllBusinessAccountDeposits :: CircleAPIRequest DepositsRequest TupleBS8 ByteString

List all deposits Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. https://developers.circle.com/developer/v1/reference/listbusinessdeposits

createSignetBankAccount :: SignetBankAccountRequestBody -> CircleAPIRequest SignetBankAccountRequest TupleBS8 ByteString

Create a signet bank account https://developers.circle.com/developer/v1/reference/createbusinesssignetaccount

listSignetAccounts :: CircleAPIRequest SignetBankAccountsRequest TupleBS8 ByteString

Get a list of Signet accounts https://developers.circle.com/developer/v1/reference/listbusinesssignetaccounts

getSignetAccount :: UUID -> CircleAPIRequest SignetBankAccountRequestBody TupleBS8 ByteString

Get a single Signet bank account, accepts the Signet bank account Id as a parameter https://developers.circle.com/developer/v1/reference/getbusinesssignetaccount

getSignetAccountInstructions :: UUID -> CircleAPIRequest SignetBankInstructionsResponseData TupleBS8 ByteString

Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now). https://developers.circle.com/developer/v1/reference/getbusinesssignetaccountinstructions

createSENAccount :: SENAccountRequestBody -> CircleAPIRequest SENAccountRequest TupleBS8 ByteString

Create a bank account for a SEN https://developers.circle.com/developer/v1/reference/createbusinesssenaccount

listSENAccounts :: CircleAPIRequest SENAccountsRequest TupleBS8 ByteString

Get a list of SEN accounts https://developers.circle.com/developer/v1/reference/listbusinesssenaccounts

getSENAccount :: UUID -> CircleAPIRequest SENAccountRequest TupleBS8 ByteString

Get a single SEN account, accepts the SEN account Id as a parameter https://developers.circle.com/developer/v1/reference/getbusinesssenaccount

getSENAccountInstructions :: UUID -> CircleAPIRequest SENInstructionsRequest TupleBS8 ByteString

Get the SEN transfer instructions into the Circle bank account given your bank account id. https://developers.circle.com/developer/v1/reference/getbusinesssenaccountinstructions

listAllPayments :: CircleAPIRequest PaymentsRequest TupleBS8 ByteString

List all payments https://developers.circle.com/developer/v1/reference/listpayments

createPayment :: CreatePaymentRequestBody -> CircleAPIRequest PaymentRequest TupleBS8 ByteString

Create a payment (fiat or Crypto) https://developers.circle.com/developer/v1/reference/payments-payments-create

getPayment :: UUID -> CircleAPIRequest PaymentRequest TupleBS8 ByteString

Get a payment (fiat or Crypto) https://developers.circle.com/developer/v1/reference/payments-payments-get-id

cancelPayment :: UUID -> CancelPaymentRequestBody -> CircleAPIRequest PaymentRequest TupleBS8 ByteString

Cancel a fiat payment https://developers.circle.com/developer/v1/reference/payments-payments-cancel-id

refundPayment :: UUID -> RefundPaymentRequestBody -> CircleAPIRequest PaymentRequest TupleBS8 ByteString

Refund a fiat payment https://developers.circle.com/developer/v1/reference/payments-payments-refund-id

createMockWirePayment :: MockSenOrWirePaymentRequestBody -> CircleAPIRequest MockPaymentRequest TupleBS8 ByteString

Create mock wire payment SANDBOX ONLY In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet. https://developers.circle.com/developer/v1/reference/createmockwirepayment

createMockSEPAPayment :: MockSEPAPaymentRequestBody -> CircleAPIRequest MockPaymentRequest TupleBS8 ByteString

Create mock SEPA payment SANDBOX ONLY (in Beta) In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet. https://developers.circle.com/developer/v1/reference/createmocksepapayment

createMockSilvergatePayment :: MockSenOrWirePaymentRequestBody -> CircleAPIRequest MockPaymentRequest TupleBS8 ByteString

Create mock Silvergate payment SANDBOX ONLY In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet. https://developers.circle.com/developer/v1/reference/createmocksenpayment

createMockACHBankAccount :: CreateMockACHBankAccountRequestBody -> CircleAPIRequest MockAccountRequest TupleBS8 ByteString

Create mock ACH account SANDBOX ONLY In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account. https://developers.circle.com/developer/v1/reference/createmockachaccount-1

createMockChargeback :: UUID -> CircleAPIRequest MockChargebackRequest TupleBS8 ByteString

Create mock chargeback SANDBOX ONLY In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the paid state (otherwise the endpoint will return a 404), and each payment can only be charged back once (otherwise the endpoint will return a 409). This endpoint is only available in the sandbox environment. https://developers.circle.com/developer/v1/reference/payments-chargebacks-mock-create

listAllOnChainTransfers :: CircleAPIRequest OnChainTransfersRequest TupleBS8 ByteString

Searches for transfers. Searches for transfers involving the provided wallets. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. https://developers.circle.com/developer/v1/reference/listtransfers-1

getOnChainTransfer :: UUID -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Get a business account transfer based on a transfer ID https://developers.circle.com/developer/v1/reference/gettransfer

createOnChainTransfer :: OnChainTransferRequestBody -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Create an on-chain transfer (i.e. a crypto payment) https://developers.circle.com/developer/v1/reference/accounts-transfers-create

listAllCards :: CircleAPIRequest CardsRequest TupleBS8 ByteString

List all cards https://developers.circle.com/developer/v1/reference/listcards

getCard :: UUID -> CircleAPIRequest CardRequest TupleBS8 ByteString

Get a card https://developers.circle.com/developer/v1/reference/payments-cards-get-id

createCard :: CreateCardRequestBody -> CircleAPIRequest CardRequest TupleBS8 ByteString

Create a card https://developers.circle.com/developer/v1/reference/payments-cards-create

updateCard :: UUID -> UpdateCardRequestBody -> CircleAPIRequest CardRequest TupleBS8 ByteString

Update a card https://developers.circle.com/developer/v1/reference/updatecard

createWireAccount :: WireAccountRequestBody -> CircleAPIRequest WireAccountRequest TupleBS8 ByteString

Create a bank account for a wire https://developers.circle.com/developer/v1/reference/createwireaccount

getWireAccount :: UUID -> CircleAPIRequest WireAccountRequest TupleBS8 ByteString

Get a single wire account, accepts the wire account Id as a parameter https://developers.circle.com/developer/v1/reference/getwireaccount-1

getWireAccountInstructions :: UUID -> CircleAPIRequest WireInstructionsRequest TupleBS8 ByteString

Get the wire transfer instructions into the Circle bank account given your bank account id. https://developers.circle.com/developer/v1/reference/getwireaccountinstructions

createACHAccount :: CreateACHBankAccountRequestBody -> CircleAPIRequest ACHBankAccountRequest TupleBS8 ByteString

Create an ACH account https://developers.circle.com/developer/v1/reference/payments-bank-accounts-ach-mock

getACHAccount :: UUID -> CircleAPIRequest ACHBankAccountRequest TupleBS8 ByteString

Get an ACH account https://developers.circle.com/developer/v1/reference/getachaccount-1

createSEPAAccount :: SEPAAccountRequestBody -> CircleAPIRequest SEPAAccountRequest TupleBS8 ByteString

Create a SEPA account (in beta) https://developers.circle.com/developer/v1/reference/createsepaaccount-1

getSEPAAccount :: UUID -> CircleAPIRequest SEPAAccountRequest TupleBS8 ByteString

Get a SEPA account (in beta) https://developers.circle.com/developer/v1/reference/getsepaaccount-1

getSEPAAccountInstructions :: UUID -> CircleAPIRequest SEPAInstructionsRequest TupleBS8 ByteString

Get instructions for a SEPA transfer (in beta) https://developers.circle.com/developer/v1/reference/getsepaaccountinstructions

listAllSettlements :: CircleAPIRequest SettlementsRequest TupleBS8 ByteString

List all settlements https://developers.circle.com/developer/v1/reference/listsettlements

getSettlement :: UUID -> CircleAPIRequest SettlementRequest TupleBS8 ByteString

Get a settlement https://developers.circle.com/developer/v1/reference/payments-settlements-get-id

listAllChargebacks :: CircleAPIRequest ChargebacksRequest TupleBS8 ByteString

List all chargebacks https://developers.circle.com/developer/v1/reference/listchargebacks

getChargeback :: UUID -> CircleAPIRequest ChargebackRequest TupleBS8 ByteString

Get a chargeback https://developers.circle.com/developer/v1/reference/payments-chargebacks-get-id

listAllACHReversals :: CircleAPIRequest ReversalsRequest TupleBS8 ByteString

Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list https://developers.circle.com/developer/v1/reference/listreversals

listAllBalances :: CircleAPIRequest BalanceRequest TupleBS8 ByteString

Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled. https://developers.circle.com/developer/v1/reference/listbalances

listAllPaymentIntents :: CircleAPIRequest PaymentIntentsRequest TupleBS8 ByteString

List all payment intents https://developers.circle.com/developer/v1/reference/listpaymentintents

createPaymentIntent :: CreatePaymentIntentRequestBody -> CircleAPIRequest PaymentIntentRequest TupleBS8 ByteString

Create a payment intent https://developers.circle.com/developer/v1/reference/createpaymentintent

getPaymentIntent :: UUID -> CircleAPIRequest PaymentIntentRequest TupleBS8 ByteString

Get a payment intent https://developers.circle.com/developer/v1/reference/getpaymentintent

expirePaymentIntent :: UUID -> CircleAPIRequest PaymentIntentRequest TupleBS8 ByteString

Expire a payment intent https://developers.circle.com/developer/v1/reference/expirepaymentintent

listAllPayouts :: CircleAPIRequest PayoutsRequest TupleBS8 ByteString

Lists all payouts made from a given account https://developers.circle.com/developer/v1/reference/listpayouts

getPayout :: UUID -> CircleAPIRequest PayoutRequest TupleBS8 ByteString

Gets a specific payout based on an ID https://developers.circle.com/developer/v1/reference/payouts-payouts-get-id

createPayout :: PayoutRequestBody -> CircleAPIRequest PayoutRequest TupleBS8 ByteString

Creates a payout https://developers.circle.com/developer/v1/reference/payouts-payouts-create

listAllTransfers :: CircleAPIRequest TransfersRequest TupleBS8 ByteString

Searches for transfers from your account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. https://developers.circle.com/developer/v1/reference/listtransfers

getTransfer :: UUID -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Get a transfer based on a transfer ID https://developers.circle.com/reference/getbusinesstransfer

createTransfer :: TransferRequestBody -> CircleAPIRequest TransferRequest TupleBS8 ByteString

Create a new transfer https://developers.circle.com/developer/v1/reference/payouts-transfers-create

listAllReturns :: CircleAPIRequest ReturnsRequest TupleBS8 ByteString

Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list. https://developers.circle.com/developer/v1/reference/listreturns

listAllWallets :: CircleAPIRequest WalletsRequest TupleBS8 ByteString

Retrieves a list of a user's wallets. https://developers.circle.com/developer/v1/reference/listwallets

getWallet :: UUID -> CircleAPIRequest WalletRequest TupleBS8 ByteString

Get a wallet https://developers.circle.com/developer/v1/reference/accounts-wallets-get-id

createWallet :: CreateWalletRequestBody -> CircleAPIRequest WalletRequest TupleBS8 ByteString

Creates an end user wallet. https://developers.circle.com/developer/v1/reference/accounts-wallets-create

createDepositAddress :: UUID -> DepositAddressRequestBody -> CircleAPIRequest DepositAddressRequest TupleBS8 ByteString

Create new blockchain deposit address Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. https://developers.circle.com/developer/v1/reference/payments-on-chain-addresses-create

listAllAddresses :: UUID -> CircleAPIRequest RecipientAddressesRequest TupleBS8 ByteString

List all recipient addresses associated with a wallet Id Retrieves a list of addresses associated with a wallet. https://developers.circle.com/developer/v1/reference/listaddresses

circle :: FromJSON (CircleRequest a) => CircleConfig -> CircleAPIRequest a TupleBS8 ByteString -> IO (Either CircleError (CircleRequest a))

Create a request to circle's API

circleTest :: FromJSON (CircleRequest a) => CircleConfig -> Manager -> CircleAPIRequest a TupleBS8 ByteString -> IO (Either CircleError (CircleRequest a))

This function is only used internally to speed up the test suite. Instead of creating a new Manager we reuse the same one.

paramsToByteString :: [Query] -> ByteString

Conversion of a key value pair to a query parameterized string