Copyright	(c) Dylan Martin 2022
Maintainer	dmarticus@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Circle.Types

Contents

Orphan instances

Description

https://developers.circle.com/developer/v1/docs/circle-api-resources

Synopsis

newtype ApiToken = ApiToken {
- unApiToken :: ByteString
}
data CircleAPIRequest a b c = CircleAPIRequest {
- rMethod :: !Method
- endpoint :: !Text
- params :: !(Params TupleBS8 ByteString)
}
mkCircleAPIRequest :: Method -> Text -> Params TupleBS8 ByteString -> CircleAPIRequest a b c
type family CircleRequest a :: *
data CircleError = CircleError {
- parseError :: !Text
- errorResponseBody :: !Reply
}
data CircleResponseBody a = CircleResponseBody {
- circleResponseCode :: !(Maybe ResponseStatus)
- circleResponseMessage :: !(Maybe ResponseMessage)
- circleResponseData :: !(Maybe a)
}
newtype ResponseStatus = ResponseStatus {
- unResponseStatus :: Int
}
newtype ResponseMessage = ResponseMessage {
- unResponseMessage :: Text
}
type Reply = Response ByteString
type Method = Method
type Host = Text
data CircleHost
- = CircleProduction
- | CircleSandbox
hostUri :: CircleHost -> Text
data CircleConfig = CircleConfig {
- host :: !CircleHost
- token :: !ApiToken
}
credentialsEnv :: Maybe String -> IO ApiToken
prodEnvConfig :: Maybe String -> IO CircleConfig
sandboxEnvConfig :: Maybe String -> IO CircleConfig
newtype Query = Query {
- unQuery :: TupleBS8
}
newtype Body = Body {
- unBody :: ByteString
}
data Params b c = Params {
- paramsBody :: Maybe Body
- paramsQuery :: ![Query]
}
joinQueryParams :: Params b c -> Params b c -> Params b c
type TupleBS8 = (ByteString, ByteString)
class ToCircleParam param where
- toCircleParam :: param -> Params TupleBS8 c -> Params TupleBS8 c
class ToCircleParam param => CircleHasParam request param
(-&-) :: CircleHasParam r param => CircleAPIRequest r b c -> param -> CircleAPIRequest r b c
newtype PaginationQueryParams = PaginationQueryParams {
- paginationQueryParams :: PaginationQueryParam
}
data PaginationQueryParam
- = PageBefore !Text
- | PageAfter !Text
newtype FromQueryParam = FromQueryParam {
- fromQueryParam :: UTCTime
}
newtype ToQueryParam = ToQueryParam {
- toQueryParam :: UTCTime
}
newtype PageSizeQueryParam = PageSizeQueryParam {
- pageSizeQueryParam :: Integer
}
newtype StatusQueryParams = StatusQueryParams {
- statusQueryParams :: [Status]
}
statusToBS8 :: Status -> ByteString
newtype DestinationQueryParam = DestinationQueryParam {
- destinationQueryParam :: UUID
}
newtype TypeQueryParam = TypeQueryParam {
- typeQueryParam :: BankAccountType
}
bankAccountTypeToBS8 :: BankAccountType -> ByteString
newtype CurrencyQueryParam = CurrencyQueryParam {
- currencyQueryParam :: SupportedCurrencies
}
currencyToBS8 :: SupportedCurrencies -> ByteString
newtype SourceQueryParam = SourceQueryParam {
- sourceQueryParam :: UUID
}
newtype SettlementIdQueryParam = SettlementIdQueryParam {
- settlementIdQueryParam :: UUID
}
newtype PaymentIntentIdQueryParam = PaymentIntentIdQueryParam {
- paymentIntentIdQueryParam :: UUID
}
newtype PaymentIdQueryParam = PaymentIdQueryParam {
- paymentIdQueryParam :: UUID
}
newtype PaymentStatusQueryParams = PaymentStatusQueryParams {
- paymentStatusQueryParams :: [PaymentStatus]
}
paymentStatusToBS8 :: PaymentStatus -> ByteString
newtype PaymentIntentContextQueryParams = PaymentIntentContextQueryParams {
- paymentIntentContextQueryParams :: [PaymentIntentContext]
}
paymentIntentContextToBS8 :: PaymentIntentContext -> ByteString
newtype WalletIdQueryParam = WalletIdQueryParam {
- walletIdQueryParam :: WalletId
}
newtype SourceWalletIdQueryParam = SourceWalletIdQueryParam {
- sourceWalletIdQueryParam :: WalletId
}
newtype DestinationWalletIdQueryParam = DestinationWalletIdQueryParam {
- destinationWalletIdQueryParam :: WalletId
}
newtype ReturnIdentitiesQueryParam = ReturnIdentitiesQueryParam {
- returnIdentitiesQueryParam :: Bool
}
data BalanceRequest
data BalanceResponseBody = BalanceResponseBody {
- balanceResponseBodyAvailable :: ![MoneyAmount]
- balanceResponseBodyUnsettled :: ![MoneyAmount]
}
data PayoutRequest
data PayoutsRequest
data PayoutResponseBody = PayoutResponseBody {
- payoutResponseBodyId :: !UUID
- payoutResponseBodySourceWalletId :: !WalletId
- payoutResponseBodyDestinationBankAccount :: !DestinationBankAccount
- payoutResponseBodyAmount :: !MoneyAmount
- payoutResponseBodyFees :: !MoneyAmount
- payoutResponseBodyStatus :: !Status
- payoutResponseBodyTrackingRef :: !TrackingReference
- payoutResponseBodyPayoutErrorCode :: !PayoutErrorCode
- payoutResponseBodyRiskEvaluation :: !RiskEvaluation
- payoutResponseBodyAdjustments :: !Adjustments
- payoutResponseBodyPayoutReturn :: !PayoutReturnResponseBody
- payoutResponseBodyCreateDate :: !UTCTime
- payoutResponseBodyUpdateDate :: !UTCTime
}
data BusinessPayoutRequestBody = BusinessPayoutRequestBody {
- businessPayoutIdempotencyKey :: !UUID
- businessPayoutDestination :: !DestinationBankAccount
- businessPayoutAmount :: !MoneyAmount
}
newtype PayoutMetadata = PayoutMetadata {
- payoutMetadataBeneficiaryEmail :: Email
}
data PayoutRequestBody = PayoutRequestBody {
- payoutIdempotencyKey :: !UUID
- payoutSource :: !(Maybe PaymentSource)
- payoutDestination :: !DestinationBankAccount
- payoutAmount :: !MoneyAmount
- payoutMetadata :: !PayoutMetadata
}
data PayoutReturnResponseBody = PayoutReturnResponseBody {
- payoutReturnResponseBodyId :: !UUID
- payoutReturnResponseBodyOriginalPayoutId :: !UUID
- payoutReturnResponseBodyAmount :: !MoneyAmount
- payoutReturnResponseBodyFees :: !MoneyAmount
- payoutReturnResponseBodyReason :: !Text
- payoutReturnResponseBodyStatus :: !Status
- payoutReturnResponseBodyCreateDate :: !UTCTime
- payoutReturnResponseBodyUpdateDate :: !UTCTime
}
data PayoutErrorCode
- = InsufficientFunds
- | TransactionDenied
- | TransactionFailed
- | TransactionReturned
- | BankTransactionError
- | FiatAccountLimitExceeded
- | InvalidBankAccountNumber
- | InvalidACHRoutingTransitNumber
- | InvalidWireRoutingTransitNumber
- | VendorInactive
data ConfigurationRequest
newtype ConfigurationResponseBody = ConfigurationResponseBody {
- configurationResponseBodyPayments :: WalletConfig
}
newtype WalletConfig = WalletConfig {
- masterWalletId :: WalletId
}
data EncryptionRequest
data EncryptionResponseBody = EncryptionResponseBody {
- encryptionResponseBodyKeyId :: !Text
- encryptionResponseBodyPublicKey :: !PGPKey
}
newtype PGPKey = PGPKey {
- unPGPKey :: Text
}
data ChannelsRequest
newtype ChannelResponseBody = ChannelResponseBody {
- channels :: [Channel]
}
data Channel = Channel {
- channelId :: !UUID
- channelDefault :: !Bool
- channelCardDescriptor :: !Text
- channelAchDescriptor :: !Text
}
data StablecoinsRequest
data StablecoinResponseBody = StablecoinResponseBody {
- stablecoinResponseBodyName :: !Text
- stablecoinResponseBodySymbol :: !Stablecoin
- stablecoinResponseBodyTotalAmount :: !Text
- stablecoinResponseBodyChains :: ![ChainAmount]
}
data ChainAmount = ChainAmount {
- chainAmountAmount :: !Text
- chainAmountChain :: !Chain
- chainAmountUpdateDate :: !UTCTime
}
data Chain
- = ALGO
- | ARB
- | AVAX
- | ChainBTC
- | ChainETH
- | FLOW
- | HBAR
- | MATIC
- | NEAR
- | OP
- | SOL
- | TRX
- | XLM
data Stablecoin
- = USDC
- | EUROC
- | USDT
data SubscriptionsRequest
data SubscriptionRequest
data SubscriptionResponseBody = SubscriptionResponseBody {
- subscriptionResponseBodyId :: !UUID
- subscriptionResponseBodyEndpoint :: !URL
- subscriptionResponseBodySubscriptionDetails :: ![SubscriptionDetails]
}
data SubscriptionDetails = SubscriptionDetails {
- subscriptionDetailsUrl :: !URL
- subscriptionDetailsStatus :: !Status
}
newtype SubscriptionRequestBody = SubscriptionRequestBody {
- subscriptionRequestBodyEndpoint :: Text
}
data TransfersRequest
data TransferRequest
data BusinessTransferRequestBody = BusinessTransferRequestBody {
- businessTransferRequestBodyIdempotencyKey :: !UUID
- businessTransferRequestBodyDestination :: !TransferDestination
- businessTransferRequestBodyAmount :: !MoneyAmount
}
data TransferRequestBody = TransferRequestBody {
- transferRequestBodyIdempotencyKey :: !UUID
- transferRequestBodySource :: !PaymentSource
- transferRequestBodyDestination :: !TransferDestination
- transferRequestBodyAmount :: !MoneyAmount
}
data TransferDestination = TransferDestination {
- transferDestinationType :: !DestinationType
- transferDestinationAddressId :: !UUID
}
data DestinationType = VerifiedBlockchain
data TransferResponseBody = TransferResponseBody {
- transferResponseBodyId :: !UUID
- transferResponseBodySource :: !(ThisOrThat SourceWallet SourceBlockchain)
- transferResponseBodyDestination :: !(ThisOrThat DestinationWallet DestinationBlockchain)
- transferResponseBodyAmount :: !MoneyAmount
- transferResponseBodyFees :: !TransferFeeAmount
- transferResponseBodyTransactionHash :: !(Maybe HexString)
- transferResponseBodyStatus :: !Status
- transferResponseBodyTransferErrorCode :: !(Maybe TransferErrorCode)
- transferResponseBodyRiskEvaluation :: !(Maybe RiskEvaluation)
- transferResponseBodyCreateDate :: !(Maybe UTCTime)
}
data SourceWallet = SourceWallet {
- sourceWalletType :: !TransferType
- sourceWalletId :: !WalletId
- sourceWalletIdentities :: ![Identity]
}
data SourceBlockchain = SourceBlockchain {
- sourceBlockchainType :: !TransferType
- sourceBlockchainChain :: !Chain
- sourceBlockChainIdentities :: ![Identity]
}
data DestinationWallet = DestinationWallet {
- destinationWalletType :: !TransferType
- destinationWalletId :: !WalletId
- destinationWalletAddress :: !(Maybe Text)
- destinationWalletAddressTag :: !(Maybe Text)
}
data DestinationBlockchain = DestinationBlockchain {
- destinationBlockchainType :: !TransferType
- destinationBlockchainAddress :: !HexString
- destinationBlockchainAddressTag :: !(Maybe Text)
- destinationBlockchainAddressChain :: !Chain
}
data Identity = Identity {
- identityType :: !IdentityType
- identityName :: !Text
- identityAddresses :: ![Address]
}
data IdentityType
- = Individual
- | Business
data TransferType
- = Wallet
- | Blockchain
data TransferErrorCode
- = TransferInsufficientFunds
- | BlockchainError
- | TransferDenied
- | TransferFailed
data DepositAddressesRequest
data DepositAddressRequest
data DepositAddressResponseBody = DepositAddressResponseBody {
- depositAddressResponseBodyAddress :: !HexString
- depositAddressResponseBodyAddressTag :: !(Maybe Text)
- depositAddressResponseBodyCurrency :: !SupportedCurrencies
- depositAddressResponseBodyChain :: !Chain
}
data DepositAddressRequestBody = DepositAddressRequestBody {
- depositAddressRequestBodyIdempotencyKey :: !UUID
- depositAddressRequestBodyCurrency :: !SupportedCurrencies
- depositAddressRequestBodyChain :: !Chain
}
data RecipientAddressesRequest
data RecipientAddressRequest
data RecipientAddressResponseBody = RecipientAddressResponseBody {
- recipientAddressResponseBodyId :: !UUID
- recipientAddressResponseBodyAddress :: !HexString
- recipientAddressResponseBodyAddressTag :: !(Maybe Text)
- recipientAddressResponseBodyChain :: !Chain
- recipientAddressResponseBodyCurrency :: !SupportedCurrencies
- recipientAddressResponseBodyDescription :: !Text
}
data RecipientAddressRequestBody = RecipientAddressRequestBody {
- recipientAddressRequestBodyIdempotencyKey :: !UUID
- recipientAddressRequestBodyAddress :: !HexString
- recipientAddressRequestBodyAddressTag :: !(Maybe Text)
- recipientAddressRequestBodyChain :: !Chain
- recipientAddressRequestBodyCurrency :: !SupportedCurrencies
- recipientAddressRequestBodyDescription :: !Text
}
data DepositsRequest
data DepositResponseBody = DepositResponseBody {
- depositResponseBodyId :: !UUID
- depositResponseBodySourceWalletId :: !(Maybe WalletId)
- depositResponseBodyDestination :: !DestinationWallet
- depositResponseBodyAmount :: !MoneyAmount
- depositResponseBodyFee :: !MoneyAmount
- depositResponseBodyStatus :: !Status
- depositResponseBodyRiskEvaluation :: !(Maybe RiskEvaluation)
- depositResponseBodyCreateDate :: !UTCTime
- depositResponseBodyUpdateDate :: !(Maybe UTCTime)
}
data MockPaymentRequest
data MockPaymentResponseBody = MockPaymentResponseBody {
- mockPaymentResponseBodyTrackingRef :: !(Maybe TrackingReference)
- mockPaymentResponseBodyAmount :: !(Maybe MoneyAmount)
- mockPaymentResponseBodyBeneficiaryBank :: !(Maybe BeneficiaryBankDetails)
- mockPaymentResponseBodyStatus :: !(Maybe Status)
}
data MockSenOrWirePaymentRequestBody = MockSenOrWirePaymentRequestBody {
- mockSenOrWirePaymentRequestBodyTrackingRef :: !TrackingReference
- mockSenOrWirePaymentRequestBodyAmount :: !MoneyAmount
- mockSenOrWirePaymentRequestBodyBeneficiaryBank :: !MockBeneficiaryBankDetails
}
data MockSEPAPaymentRequestBody = MockSEPAPaymentRequestBody {
- mockSEPAPaymentRequestBodyTrackingRef :: !TrackingReference
- mockSEPAPaymentRequestBodyAmount :: !MoneyAmount
}
newtype MockBeneficiaryBankDetails = MockBeneficiaryBankDetails {
- mockBeneficiaryBankDetailsAccountNumber :: AccountNumber
}
data SENAccountRequest
data SENAccountsRequest
data SENInstructionsRequest
data SENAccountRequestBody = SENAccountRequestBody {
- senAccountRequestBodyIdempotencyKey :: !UUID
- senAccountRequestBodyAccountNumber :: !AccountNumber
- senAccountRequestBodyCurrency :: !(Maybe SupportedCurrencies)
}
data SENAccountResponseBody = SENAccountResponseBody {
- senAccountResponseBodyId :: !UUID
- senAccountResponseBodyStatus :: !Status
- senAccountResponseBodyDescription :: !Text
- senAccountResponseBodyTrackingRef :: !TrackingReference
- senAccountResponseBodyCreateDate :: !UTCTime
- senAccountResponseBodyUpdateDate :: !UTCTime
- senAccountResponseBodyCurrency :: !(Maybe SupportedCurrencies)
}
data SENInstructionsResponseData = SENInstructionsResponseData {
- senInstructionsResponseDataTrackingRef :: !TrackingReference
- senInstructionsResponseDataAccountNumber :: !AccountNumber
- senInstructionsResponseDataCurrency :: !SupportedCurrencies
}
data SignetBankAccountRequest
data SignetBankAccountsRequest
data SignetBankInstructionsRequest
data SignetBankAccountRequestBody = SignetBankAccountRequestBody {
- signetBankAccountRequestBodyIdempotencyKey :: !UUID
- signetBankAccountRequestBodyWalletAddress :: !HexString
}
data SignetBankAccountResponseData = SignetBankAccountResponseData {
- signetBankAccountId :: !UUID
- signetBankAccountStatus :: !Status
- signetBankAccountTrackingRef :: !TrackingReference
- signetBankAccountWalletAddress :: !HexString
- signetBankAccountCreateDate :: !UTCTime
- signetBankAccountUpdateDate :: !UTCTime
}
data SignetBankInstructionsResponseData = SignetBankInstructionsResponseData {
- signetBankInstructionsTrackingRef :: !(Maybe TrackingReference)
- signetBankInstructionsWalletAddress :: !(Maybe HexString)
}
data WireAccountRequest
data WireAccountsRequest
data WireInstructionsRequest
data WireAccountRequestBody
- = USBankAccount !USBankAccountRequestBody
- | IBANBankAccount !IBANBankAccountRequestBody
- | NonIBANBankAccount !NonIBANBankAccountRequestBody
data USBankAccountRequestBody = USBankAccountRequestBody {
- usBankAccountIdempotencyKey :: !UUID
- usBankAccountAccountNumber :: !AccountNumber
- usBankAccountRoutingNumber :: !RoutingNumber
- usBankAccountBillingDetails :: !BillingDetails
- usBankAccountBankAddress :: !BankAddress
}
data IBANBankAccountRequestBody = IBANBankAccountRequestBody {
- ibanBankAccountIdempotencyKey :: !UUID
- ibanBankAccountIBAN :: !Iban
- ibanBankAccountBillingDetails :: !BillingDetails
- ibanBankAccountBankAddress :: !BankAddress
}
data NonIBANBankAccountRequestBody = NonIBANBankAccountRequestBody {
- nonIBANBankAccountIdempotencyKey :: !UUID
- nonIBANBankAccountAccountNumber :: !AccountNumber
- nonIBANBankAccountRoutingNumber :: !RoutingNumber
- nonIBANBankAccountBillingDetails :: !BillingDetails
- nonIBANBankAccountBankAddress :: !BankAddress
}
data WireInstructionsResponseData = WireInstructionsResponseData {
- wireInstructionsResponseDataTrackingRef :: !TrackingReference
- wireInstructionsResponseDataBeneficiaryDetails :: !BeneficiaryDetails
- wireInstructionsResponseDataBeneficiaryBankDetails :: !BeneficiaryBankDetails
}
data WireAccountResponseBody = WireAccountResponseBody {
- wireAccountResponseBodyId :: !UUID
- wireAccountResponseBodyStatus :: !Status
- wireAccountResponseBodyDescription :: !Text
- wireAccountResponseBodyTrackingRef :: !TrackingReference
- wireAccountResponseBodyFingerprint :: !UUID
- wireAccountResponseBodyBillingDetails :: !BillingDetails
- wireAccountResponseBodyBankAddress :: !BankAddress
- wireAccountResponseBodyCreateDate :: !UTCTime
- wireAccountResponseBodyUpdateDate :: !UTCTime
}
data PaymentRequest
data PaymentsRequest
data CreatePaymentRequestBody = CreatePaymentRequestBody {
- createPaymentIdempotencyKey :: !UUID
- createPaymentKeyId :: !Text
- requestMetadata :: !RequestMetadata
- createPaymentAmount :: !MoneyAmount
- createPaymentAutoCapture :: !(Maybe Bool)
- createPaymentVerification :: !VerificationType
- createPaymentVerificationSuccessUrl :: !(Maybe URL)
- createPaymentVerificationFailureUrl :: !(Maybe URL)
- createPaymentSource :: !PaymentSource
- createPaymentDescription :: !(Maybe Text)
- createPaymentEncryptedData :: !(Maybe Text)
- createPaymentChannel :: !(Maybe UUID)
}
data RequestMetadata = RequestMetadata {
- requestMetadataEmail :: !Email
- requestMetadataPhoneNumber :: !(Maybe PhoneNumber)
- requestMetadataSessionId :: !SessionId
- requestMetadataIpAddress :: !IPAddress
}
newtype SessionId = SessionId {
- unSessionId :: Text
}
newtype IPAddress = IPAddress {
- unIPAddress :: Text
}
newtype PhoneNumber = PhoneNumber {
- unPhoneNumber :: Text
}
data PaymentErrorCode
- = PaymentFailedErrorCode
- | PaymentFraudDetected
- | PaymentDenied
- | PaymentNotSupportedByIssuer
- | PaymentNotFunded
- | PaymentUnprocessable
- | PaymentStoppedByIssuer
- | PaymentCanceled
- | PaymentReturned
- | PaymentFailedBalanceCheck
- | CardFailed
- | CardInvalid
- | CardAddressMismatch
- | CardZipMismatch
- | CardCvvInvalid
- | CardExpired
- | CardLimitViolated
- | CardNotHonored
- | CardCvvRequired
- | CardRestricted
- | CardAccountIneligible
- | CardNetworkUnsupported
- | ChannelInvalid
- | UnauthorizedTransaction
- | BankAccountIneligible
- | PaymentBankTransactionError
- | InvalidAccountNumber
- | InvalidWireRtn
- | InvalidAchRtn
- | RefIdInvalid
- | AccountNameMismatch
- | AccountNumberMismatch
- | AccountIneligible
- | WalletAddressMismatch
- | CustomerNameMismatch
- | InstitutionNameMismatch
- | PaymentVendorInactive
data FiatOrCryptoPaymentResponseBody = FiatOrCryptoPaymentResponseBody {
- fiatOrCryptoPaymentId :: !UUID
- fiatOrCryptoPaymentType :: !PaymentType
- fiatOrCryptoPaymentMerchantId :: !UUID
- fiatOrCryptoPaymentMerchantWalletId :: !WalletId
- fiatOrCryptoPaymentAmount :: !MoneyAmount
- fiatOrCryptoPaymentSource :: !PaymentSource
- fiatOrCryptoPaymentDescription :: !Text
- fiatOrCryptoPaymentStatus :: !PaymentStatus
- fiatOrCryptoPaymentPaymentIntentId :: !(Maybe UUID)
- fiatOrCryptoPaymentSettlementAmount :: !(Maybe MoneyAmount)
- fiatOrCryptoPaymentDepositAddress :: !(Maybe PaymentDepositAddress)
- fiatOrCryptoPaymentTransactionHash :: !(Maybe HexString)
- fiatOrCryptoPaymentVerification :: !(Maybe VerificationData)
- fiatOrCryptoPaymentCaptured :: !(Maybe Bool)
- fiatOrCryptoPaymentCaptureAmount :: !(Maybe MoneyAmount)
- fiatOrCryptoPaymentCaptureDate :: !(Maybe UTCTime)
- fiatOrCryptoPaymentRequiredAction :: !(Maybe PaymentActionRequired)
- fiatOrCryptoPaymentCancel :: !(Maybe FiatCancelOrRefundResponseBody)
- fiatOrCryptoPaymentRefunds :: !(Maybe [FiatCancelOrRefundResponseBody])
- fiatOrCryptoPaymentFees :: !(Maybe MoneyAmount)
- fiatOrCryptoPaymentChannel :: !(Maybe UUID)
- fiatOrCryptoPaymentCreateDate :: !(Maybe UTCTime)
- fiatOrCryptoPaymentUpdateDate :: !(Maybe UTCTime)
- fiatOrCryptoPaymentTrackingRef :: !(Maybe TrackingReference)
- fiatOrCryptoPaymentErrorCode :: !(Maybe PaymentErrorCode)
- fiatOrCryptoMetadata :: !(Maybe ResponseMetadata)
- fiatOrCryptoPaymentRiskEvaluation :: !(Maybe RiskEvaluation)
}
data ResponseMetadata = ResponseMetadata {
- responseMetadataEmail :: !Email
- responseMetadataPhoneNumber :: !(Maybe PhoneNumber)
}
data VerificationData = VerificationData {
- verificationAVS :: !AVS
- verificationCVV :: !CVV
}
data AVS
- = AVSNotRequested
- | AVSPending
- | Y
- | N
data CVV
- = CVVNotRequested
- | CVVPass
- | CVVFail
- | CVVUnavailable
- | CVVPending
data PaymentDepositAddress = PaymentDepositAddress {
- paymentDepositAddressChain :: !Chain
- paymentDepositAddressAddress :: !HexString
}
data FiatCancelOrRefundResponseBody = FiatCancelOrRefundResponseBody {
- fiatCancelOrRefundResponseBodyId :: !UUID
- fiatCancelOrRefundResponseBodyType :: !PaymentType
- fiatCancelOrRefundResponseBodyMerchantId :: !UUID
- fiatCancelOrRefundResponseBodyMerchantWalletId :: !WalletId
- fiatCancelOrRefundResponseBodyAmount :: !MoneyAmount
- fiatCancelOrRefundResponseBodySource :: !PaymentSource
- fiatCancelOrRefundResponseBodyDescription :: !Text
- fiatCancelOrRefundResponseBodyStatus :: !PaymentStatus
- fiatCancelOrRefundResponseBodyOriginalPayment :: !OriginalFiatPayment
- fiatCancelOrRefundResponseBodyFees :: !(Maybe MoneyAmount)
- fiatCancelOrRefundResponseBodyChannel :: !(Maybe Text)
- fiatCancelOrRefundResponseBodyReason :: !(Maybe CancelPaymentReason)
- fiatCancelOrRefundResponseBodyCreateDate :: !UTCTime
- fiatCancelOrRefundResponseBodyUpdateDate :: !UTCTime
}
data OriginalFiatPayment = OriginalFiatPayment {
- originalFiatPaymentId :: !UUID
- originalFiatPaymentType :: !PaymentType
- originalFiatPaymentStatus :: !PaymentStatus
- originalFiatPaymentCreateDate :: !UTCTime
- originalFiatPaymentUpdateDate :: !UTCTime
- originalFiatPaymentDescription :: !(Maybe Text)
- originalFiatPaymentAmount :: !(Maybe MoneyAmount)
- originalFiatPaymentFees :: !(Maybe MoneyAmount)
- originalFiatPaymentMerchantId :: !(Maybe UUID)
- originalFiatPaymentMerchantWalletId :: !(Maybe WalletId)
- originalFiatPaymentSource :: !(Maybe PaymentSource)
- originalFiatPaymentTrackingRef :: !(Maybe TrackingReference)
}
data PaymentSource = PaymentSource {
- paymentSourceId :: !UUID
- paymentSourceType :: !PaymentSourceType
}
data PaymentActionRequired = PaymentActionRequired {
- paymentActionRequiredType :: !ActionRequiredType
- paymentActionRequiredRedirectUrl :: !URL
}
data ActionRequiredType = ThreeDSecureRequired
data VerificationType
- = VerificationThreeDSecure
- | VerificationCVV
data PaymentType
- = Payment
- | Cancel
- | Refund
data PaymentSourceType
- = Card
- | ACH
- | WireSource
- | SEPA
data CancelPaymentRequestBody = CancelPaymentRequestBody {
- cancelPaymentIdempotencyKey :: !UUID
- cancelPaymentReason :: !(Maybe CancelPaymentReason)
}
data CancelPaymentReason
- = CancelPaymentReasonDuplicate
- | CancelPaymentReasonFraudulent
- | CancelPaymentReasonRequestedByCustomer
- | CancelPaymentReasonBankTransactionError
- | CancelPaymentReasonInvalidAccountNumber
- | CancelPaymentReasonInsufficientFunds
- | CancelPaymentReasonPaymentStoppedByIssuer
data RefundPaymentRequestBody = RefundPaymentRequestBody {
- refundPaymentIdempotencyKey :: !UUID
- refundPaymentAmount :: !MoneyAmount
- refundPaymentReason :: !(Maybe CancelPaymentReason)
}
data OnChainTransferRequest
data OnChainTransfersRequest
data OnChainAddressRequest
data OnChainTransferRequestBody = OnChainTransferRequestBody {
- onChainTransferRequestBodyIdempotencyKey :: !UUID
- onChainTransferRequestBodySource :: !SourceWallet
- onChainTransferRequestBodyDestination :: !(ThisOrThat DestinationWallet DestinationBlockchain)
- onChainTransferRequestBodyAmount :: !MoneyAmount
}
data CardsRequest
data CardRequest
data ListCardResponseBody = ListCardResponseBody {
- listCardId :: !UUID
- listCardStatus :: !Status
- listCardBillingDetails :: !ListCardBillingDetails
- listCardExpiryMonth :: !Int
- listCardExpiryYear :: !Int
- listCardNetwork :: !CardNetwork
- listCardBin :: !(Maybe Text)
- listCardIssuerCountry :: !(Maybe ISO3166Alpha2)
- listCardFingerprint :: !UUID
- listCardVerification :: !VerificationData
- listCardRiskEvaluation :: !(Maybe RiskEvaluation)
- listCardCreateDate :: !UTCTime
- listCardUpdateDate :: !UTCTime
}
data CardResponseBody = CardResponseBody {
- cardId :: !UUID
- cardStatus :: !Status
- cardBillingDetails :: !BillingDetails
- cardExpiryMonth :: !Int
- cardExpiryYear :: !Int
- cardNetwork :: !CardNetwork
- cardLast4 :: !Text
- cardBin :: !(Maybe Text)
- cardIssuerCountry :: !(Maybe ISO3166Alpha2)
- cardFundingType :: !(Maybe CardFundingType)
- cardFingerprint :: !UUID
- cardErrorCode :: !(Maybe VerificationErrorCode)
- cardVerification :: !VerificationData
- cardRiskEvaluation :: !(Maybe RiskEvaluation)
- cardMetadata :: !ResponseMetadata
- cardCreateDate :: !UTCTime
- cardUpdateDate :: !UTCTime
}
data CreateCardRequestBody = CreateCardRequestBody {
- createCardIdempotencyKey :: !UUID
- createCardKeyId :: !(Maybe Text)
- createCardEncryptedData :: !(Maybe Text)
- createCardBillingDetails :: !BillingDetails
- createCardExpiryMonth :: !Int
- createCardExpiryYear :: !Int
- createCardMetadata :: !RequestMetadata
}
data UpdateCardRequestBody = UpdateCardRequestBody {
- updateCardKeyId :: !(Maybe Text)
- updateCardEncryptedData :: !(Maybe Text)
- updateCardExpiryMonth :: !Int
- updateCardExpiryYear :: !Int
}
data ListCardBillingDetails = ListCardBillingDetails {
- listCardBillingDetailsCountry :: !ISO3166Alpha2
- listCardBillingDetailsDistrict :: !District
}
data CardNetwork
- = VISA
- | MASTERCARD
- | AMEX
- | UNKNOWN
data CardFundingType
- = Credit
- | Debit
- | Prepaid
- | Unknown
data VerificationErrorCode
- = VerificationFailed
- | VerificationFraudDetected
- | VerificationDenied
- | VerificationNotSupportedByIssuer
- | VerificationStoppedByIssuer
- | VerificationCardFailed
- | VerificationCardInvalid
- | VerificationCardAddressMismatch
- | VerificationCardZipMismatch
- | VerificationCardCvvInvalid
- | VerificationCardExpired
- | VerificationCardLimitViolated
- | VerificationCardNotHonored
- | VerificationCardCvvRequired
- | VerificationCreditCardNotAllowed
- | VerificationCardAccountIneligible
- | VerificationCardNetworkUnsupported
data ACHBankAccountRequest
data ACHBankAccountResponseBody = ACHBankAccountResponseBody {
- achBankAccountId :: !UUID
- achBankAccountStatus :: !Status
- achBankAccountAccountNumber :: !AccountNumber
- achBankAccountRoutingNumber :: !RoutingNumber
- achBankAccountBillingDetails :: !BillingDetails
- achBankAccountType :: !(Maybe ACHBankAccountType)
- achBankAccountBankAddress :: !BankAddress
- achBankAccountFingerprint :: !UUID
- achBankAccountErrorCode :: !(Maybe ACHBankAccountErrorCode)
- achBankAccountRiskEvaluation :: !(Maybe RiskEvaluation)
- achBankAccountMetadata :: !ResponseMetadata
- achBankAccountCreateDate :: !UTCTime
- achBankAccountUpdateDate :: !UTCTime
}
data ACHBankAccountErrorCode
- = ACHBankAccountAuthorizationExpired
- | ACHBankAccountError
- | ACHBankAccountIneligible
- | ACHBankAccountNotFound
- | ACHBankAccountUnauthorized
- | ACHBankAccountUnsupportedRoutingNumber
- | ACHBankAccountVerificationFailed
data CreateACHBankAccountRequestBody = CreateACHBankAccountRequestBody {
- achBankAccountBodyIdempotencyKey :: !UUID
- achBankAccountBodyPlaidProcessorToken :: !ProcessorToken
- achBankAccountBodyBillingDetails :: !BillingDetails
- achBankAccountBodyBankAccountType :: !(Maybe ACHBankAccountType)
- achBankAccountBodyMetadata :: !RequestMetadata
}
data MockAccountRequest
data CreateMockACHBankAccountRequestBody = CreateMockACHBankAccountRequestBody {
- mockACHBankAccountBodyAccount :: !MockACHBankAccount
- mockACHBankAccountBodyBalance :: !MoneyAmount
}
data MockACHBankAccountResponseBody = MockACHBankAccountResponseBody {
- mockACHBankAccountResponseBodyAccount :: !MockACHBankAccount
- mockACHBankAccountResponseBodyBalance :: !MoneyAmount
- mockACHBankAccountResponseBodyProcessorToken :: !ProcessorToken
}
data MockACHBankAccount = MockACHBankAccount {
- mockACHBankAccountAccountNumber :: !AccountNumber
- mockACHBankAccountRoutingNumber :: !MockRoutingNumber
- mockACHBankAccountDescription :: !Text
}
data MockRoutingNumber
- = MockRoutingNumber1
- | MockRoutingNumber2
- | MockRoutingNumber3
- | MockRoutingNumber4
- | MockRoutingNumber5
- | MockRoutingNumber6
- | MockRoutingNumber7
- | MockRoutingNumber8
- | MockRoutingNumber9
data SEPAAccountRequest
data SEPAInstructionsRequest
data SEPAAccountRequestBody = SEPAAccountRequestBody {
- sepaAccountRequestBodyIdempotencyKey :: !UUID
- sepaAccountRequestBodyIBAN :: !Iban
- sepaAccountRequestBodyBillingDetails :: !BillingDetails
}
data SEPAAccountResponseBody = SEPAAccountResponseBody {
- sepaAccountResponseBodyId :: !UUID
- sepaAccountResponseBodyStatus :: !Status
- sepaAccountResponseBodyDescription :: !Text
- sepaAccountResponseBodyTrackingRef :: !TrackingReference
- sepaAccountResponseBodyFingerprint :: !UUID
- sepaAccountResponseBodyRiskEvaluation :: !(Maybe RiskEvaluation)
- sepaAccountResponseBodyBillingDetails :: !BillingDetails
- sepaAccountResponseBodyCreateDate :: !UTCTime
- sepaAccountResponseBodyUpdateDate :: !UTCTime
}
data SettlementRequest
data SettlementsRequest
data SettlementResponseBody = SettlementResponseBody {
- settlementResponseBodyId :: !UUID
- settlementResponseBodyMerchantWalletId :: !UUID
- settlementResponseBodyWalletId :: !UUID
- settlementResponseBodyTotalDebits :: !MoneyAmount
- settlementResponseBodyTotalCredits :: !MoneyAmount
- settlementResponseBodyPaymentFees :: !MoneyAmount
- settlementResponseBodyChargebackFees :: !MoneyAmount
- settlementResponseBodyCreateDate :: !UTCTime
- settlementResponseBodyUpdateDate :: !UTCTime
}
data ChargebacksRequest
data ChargebackRequest
data MockChargebackRequest
data ChargebackResponseBody = ChargebackResponseBody {
- chargebackResponseBodyId :: !UUID
- chargebackResponseBodyPaymentId :: !UUID
- chargebackResponseBodyMerchantId :: !UUID
- chargebackResponseBodyReasonCode :: !Text
- chargebackResponseBodyCategory :: !(Maybe ChargebackCategory)
- chargebackResponseBodyHistory :: [ChargebackHistory]
}
data ChargebackCategory
- = CanceledRecurringPayment
- | CustomerDispute
- | Fraudulent
- | General
- | ProcessingError
- | NotDefined
data ChargebackHistory = ChargebackHistory {
- chargebackHistoryType :: !ChargebackHistoryType
- chargebackHistoryAmount :: !MoneyAmount
- chargebackHistoryFee :: !(Maybe MoneyAmount)
- chargebackHistoryDescription :: !Text
- chargebackHistorySettlementId :: !(Maybe UUID)
- chargebackHistoryCreateDate :: !UTCTime
}
data ChargebackHistoryType
- = FirstChargeback
- | SecondChargeback
- | ChargebackReversal
- | Representment
- | ChargebackSettlement
data ReversalsRequest
data ReversalResponseBody = ReversalResponseBody {
- reversalResponseBodyId :: !UUID
- reversalResponseBodyPaymentId :: !UUID
- reversalResponseBodyAmount :: !MoneyAmount
- reversalResponseBodyDescription :: !Text
- reversalResponseBodyStatus :: !Status
- reversalResponseBodyReason :: !ReversalReason
- reversalResponseBodyFees :: !MoneyAmount
- reversalResponseBodyCreateDate :: !UTCTime
- reversalResponseBodyUpdateDate :: !UTCTime
}
data ReversalReason
- = ReversalDuplicate
- | ReversalFraudulent
- | ReversalRequestedByCustomer
- | ReversalBankTransactionError
- | ReversalInvalidAccountNumber
- | ReversalInsufficientFunds
- | ReversalPaymentStoppedByIssuer
- | ReversalPaymentReturned
- | ReversalBankAccountIneligible
- | ReversalInvalidACHRTN
- | ReversalUnauthorizedTransaction
- | ReversalPaymentFailed
data PaymentIntentRequest
data PaymentIntentsRequest
data CreatePaymentIntentRequestBody = CreatePaymentIntentRequestBody {
- createPaymentIntentIdempotencyKey :: !UUID
- createPaymentIntentAmount :: !MoneyAmount
- createPaymentIntentSettlementCurrency :: !SupportedCurrencies
- createPaymentIntentPaymentMethods :: [PaymentMethodData]
}
data PaymentIntentResponseBody = PaymentIntentResponseBody {
- paymentIntentResponseBodyIdempotencyKey :: !UUID
- paymentIntentResponseBodyId :: !UUID
- paymentIntentResponseBodyAmount :: !MoneyAmount
- paymentIntentResponseBodyAmountPaid :: !MoneyAmount
- paymentIntentResponseBodySettlementCurrency :: !SupportedCurrencies
- paymentIntentResponseBodyPaymentMethods :: ![PaymentMethodData]
- paymentIntentResponseBodyFees :: ![BlockchainFeeMoneyAmount]
- paymentIntentResponseBodyPaymentIds :: ![UUID]
- paymentIntentResponseBodyTimeline :: ![TimelineData]
- paymentIntentResponseBodyExpiresOn :: !UTCTime
- paymentIntentResponseBodyUpdateDate :: !UTCTime
- paymentIntentResponseBodyCreateDate :: !UTCTime
}
data PaymentMethodData = PaymentMethodData {
- paymentMethodType :: !Text
- paymentMethodDataChain :: !Chain
- paymentMethodDataAddress :: !(Maybe HexString)
}
data TimelineData = TimelineData {
- timelineDataStatus :: !PaymentIntentStatus
- timelineDataContext :: !PaymentIntentContext
- timelineDataTime :: !UTCTime
}
data ReturnsRequest
data WalletRequest
data WalletsRequest
data WalletResponseBody = WalletResponseBody {
- walletResponseBodyWalletId :: !WalletId
- walletResponseBodyEntityId :: !UUID
- walletResponseBodyType :: !Text
- walletResponseBodyDescription :: !(Maybe Text)
- walletResponseBodyBalances :: [MoneyAmount]
}
data CreateWalletRequestBody = CreateWalletRequestBody {
- createWalletRequestBodyIdempotencyKey :: !UUID
- createWalletRequestBodyDescription :: !(Maybe Text)
}
utcToCircle :: UTCTime -> Text
tshow :: Show a => a -> Text
data ThisOrThat a b
- = This a
- | That b
catThises :: [ThisOrThat a b] -> [a]
catThats :: [ThisOrThat a b] -> [b]
thisOrThatToEither :: ThisOrThat a b -> Either a b
thisOrThat :: (a -> c) -> (b -> c) -> ThisOrThat a b -> c
data Status
- = Pending
- | Complete
- | Failed
data PaymentStatus
- = PaymentPending
- | Confirmed
- | Paid
- | PaymentFailed
- | ActionRequired
data PaymentIntentStatus
- = PaymentIntentCreated
- | PaymentIntentPending
- | PaymentIntentComplete
- | PaymentIntentExpired
- | PaymentIntentFailed
data PaymentIntentContext
- = ContextUnderpaid
- | ContextPaid
- | ContextOverpaid
data Address = Address {
- addressCity :: !(Maybe City)
- addressCountry :: !(Maybe ISO3166Alpha2)
- addressLine1 :: !(Maybe AddressLine)
- addressLine2 :: !(Maybe AddressLine)
- addressDistrict :: !(Maybe District)
}
data BankAccountType
- = Wire
- | Sen
data ACHBankAccountType
- = RetailType
- | BusinessType
data DestinationBankAccount = DestinationBankAccount {
- destinationBankAccountType :: !BankAccountType
- destinationBankAccountId :: !UUID
- destinationBankAccountName :: !(Maybe Text)
}
data SupportedCurrencies
- = USD
- | EUR
- | BTC
- | ETH
newtype Amount = Amount {
- unAmount :: Text
}
data BlockchainFeeType
- = BlockchainLeaseFee
- | TotalPaymentFees
data BlockchainFeeMoneyAmount = BlockchainFeeMoneyAmount {
- blockchainFeeMoneyAmountType :: !BlockchainFeeType
- blockchainFeeMoneyAmountAmount :: !Amount
- blockchainFeeMoneyAmountCurrency :: !SupportedCurrencies
}
data MoneyAmount = MoneyAmount {
- moneyAmountAmount :: !Amount
- moneyAmountCurrency :: !SupportedCurrencies
}
data TransferFeeAmount = TransferFeeAmount {
- transferFeeAmountAmount :: !Amount
- transferFeeAmountCurrency :: !SupportedCurrencies
- transferFeeAmountType :: !Text
}
data Decision
- = Approved
- | Denied
- | Review
data RiskEvaluation = RiskEvaluation {
- riskEvaluationDecision :: !Decision
- riskEvaluationReason :: !Text
}
data Adjustments = Adjustments {
- adjustmentsFXCredit :: !MoneyAmount
- adjustmentsFXDebit :: !MoneyAmount
}
data BillingDetails = BillingDetails {
- billingDetailsName :: !Text
- billingDetailsCity :: !City
- billingDetailsCountry :: !ISO3166Alpha2
- billingDetailsLine1 :: !AddressLine
- billingDetailsLine2 :: !(Maybe AddressLine)
- billingDetailsDistrict :: !(Maybe District)
- billingDetailsPostalCode :: !PostalCode
}
data BankAddress = BankAddress {
- bankAddressName :: !(Maybe Text)
- bankAddressCity :: !(Maybe City)
- bankAddressCountry :: !(Maybe ISO3166Alpha2)
- bankAddressLine1 :: !(Maybe AddressLine)
- bankAddressLine2 :: !(Maybe AddressLine)
- bankAddressDistrict :: !(Maybe District)
}
data BeneficiaryDetails = BeneficiaryDetails {
- beneficiaryDetailsName :: !Text
- beneficiaryDetailsAddress1 :: !(Maybe AddressLine)
- beneficiaryDetailsAddress2 :: !(Maybe AddressLine)
}
data BeneficiaryBankDetails = BeneficiaryBankDetails {
- beneficiaryBankDetailsName :: !Text
- beneficiaryBankDetailsSwiftCode :: !SwiftCode
- beneficiaryBankDetailsRoutingNumber :: !RoutingNumber
- beneficiaryBankDetailsAccountNumber :: !AccountNumber
- beneficiaryBankDetailsCurrency :: !SupportedCurrencies
- beneficiaryBankDetailsAddress :: !AddressLine
- beneficiaryBankDetailsCity :: !City
- beneficiaryBankDetailsPostalCode :: !PostalCode
- beneficiaryBankDetailsCountry :: !ISO3166Alpha2
}
newtype ProcessorToken = ProcessorToken {
- unProcessorToken :: Text
}
newtype AddressLine = AddressLine {
- unAddressLine :: Text
}
newtype URL = URL {
- unURL :: Text
}
urlRegex :: Regex
mkURL :: Text -> Maybe URL
urlToText :: URL -> Text
urlToByteString :: URL -> ByteString
newtype AccountNumber = AccountNumber {
- unAccountNumber :: Text
}
accountNumberRegex :: Regex
mkAccountNumber :: Text -> Maybe AccountNumber
accountNumberToText :: AccountNumber -> Text
type AccountNumberMask = Refined (SizeEqualTo 4) Text
accountNumberLastFour :: AccountNumber -> AccountNumberMask
accountNumberToByteString :: AccountNumber -> ByteString
compileAccountNumber :: QuasiQuoter
newtype RoutingNumber = RoutingNumber {
- unRoutingNumber :: Text
}
routingNumberRegex :: Regex
mkRoutingNumber :: Text -> Maybe RoutingNumber
routingNumberToText :: RoutingNumber -> Text
routingNumberToByteString :: RoutingNumber -> ByteString
compileRoutingNumber :: QuasiQuoter
newtype Iban = Iban {
- unIban :: Text
}
mkIban :: Text -> Maybe Iban
compileIban :: QuasiQuoter
ibanToText :: Iban -> Text
newtype Email = Email {
- getEmailText :: Text
}
emailRegex :: Regex
mkEmail :: Text -> Maybe Email
emailToText :: Email -> Text
emailToByteString :: Email -> ByteString
compileEmail :: QuasiQuoter
newtype City = City {
- unCity :: Text
}
newtype PostalCode = PostalCode {
- unPostalCode :: Text
}
newtype SwiftCode = SwiftCode {
- unSwiftCode :: Text
}
swiftCountryCodes :: Set Text
swiftCodeRegex :: Regex
mkSwiftCode :: Text -> Maybe SwiftCode
compileSwiftCode :: QuasiQuoter
swiftCodeToText :: SwiftCode -> Text
getCountryFromSwiftCodeText :: Text -> Text
getCountryFromSwiftCode :: SwiftCode -> Text
get8DigitSwiftCode :: SwiftCode -> SwiftCode
getBranchCodeFromSwiftCode :: SwiftCode -> Maybe Text
newtype District = District {
- unDistrict :: Text
}
newtype ISO3166Alpha2 = ISO3166Alpha2 {
- unISO3166Alpha2 :: Text
}
newtype TrackingReference = TrackingReference {
- unTrackingReference :: Text
}
newtype HexString = HexString {
- unHexString :: Text
}
newtype WalletId = WalletId {
- unWalletId :: Text
}

Documentation

newtype ApiToken Source #

Token type used for HTTP Bearer authentication.

Constructors

ApiToken
Fields unApiToken :: ByteString

Instances

Instances details

Eq ApiToken Source #
Instance details Defined in Circle.Types Methods (==) :: ApiToken -> ApiToken -> Bool # (/=) :: ApiToken -> ApiToken -> Bool #
Read ApiToken Source #
Instance details Defined in Circle.Types Methods readsPrec :: Int -> ReadS ApiToken # readList :: ReadS [ApiToken] # readPrec :: ReadPrec ApiToken # readListPrec :: ReadPrec [ApiToken] #
Show ApiToken Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ApiToken -> ShowS # show :: ApiToken -> String # showList :: [ApiToken] -> ShowS #

data CircleAPIRequest a b c Source #

Type to represent the 3 main components (method, endpoint, and params) needed to call Circle's API.

Constructors

CircleAPIRequest
Fields rMethod :: !Method Method of CircleAPIRequest endpoint :: !Text Endpoint of CircleAPIRequest params :: !(Params TupleBS8 ByteString) Request params of CircleAPIRequest

Instances

Instances details

Show (CircleAPIRequest a b c) Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CircleAPIRequest a b c -> ShowS # show :: CircleAPIRequest a b c -> String # showList :: [CircleAPIRequest a b c] -> ShowS #

mkCircleAPIRequest :: Method -> Text -> Params TupleBS8 ByteString -> CircleAPIRequest a b c Source #

Create a CircleAPIRequest

type family CircleRequest a :: * Source #

Instances

Instances details

type CircleRequest WalletsRequest Source #
Instance details Defined in Circle.Types type CircleRequest WalletsRequest = CircleResponseBody [WalletResponseBody]
type CircleRequest WalletRequest Source #
Instance details Defined in Circle.Types type CircleRequest WalletRequest = CircleResponseBody WalletResponseBody
type CircleRequest ReturnsRequest Source #
Instance details Defined in Circle.Types type CircleRequest ReturnsRequest = CircleResponseBody [PayoutReturnResponseBody]
type CircleRequest PaymentIntentsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentIntentsRequest = CircleResponseBody [PaymentIntentResponseBody]
type CircleRequest PaymentIntentRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentIntentRequest = CircleResponseBody PaymentIntentResponseBody
type CircleRequest ReversalsRequest Source #
Instance details Defined in Circle.Types type CircleRequest ReversalsRequest = CircleResponseBody [ReversalResponseBody]
type CircleRequest MockChargebackRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockChargebackRequest = CircleResponseBody ChargebackResponseBody
type CircleRequest ChargebackRequest Source #
Instance details Defined in Circle.Types type CircleRequest ChargebackRequest = CircleResponseBody ChargebackResponseBody
type CircleRequest ChargebacksRequest Source #
Instance details Defined in Circle.Types type CircleRequest ChargebacksRequest = CircleResponseBody [ChargebackResponseBody]
type CircleRequest SettlementsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SettlementsRequest = CircleResponseBody [SettlementResponseBody]
type CircleRequest SettlementRequest Source #
Instance details Defined in Circle.Types type CircleRequest SettlementRequest = CircleResponseBody SettlementResponseBody
type CircleRequest SEPAInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SEPAInstructionsRequest = CircleResponseBody WireInstructionsResponseData
type CircleRequest SEPAAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SEPAAccountRequest = CircleResponseBody SEPAAccountResponseBody
type CircleRequest MockAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockAccountRequest = CircleResponseBody MockACHBankAccountResponseBody
type CircleRequest ACHBankAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest ACHBankAccountRequest = CircleResponseBody ACHBankAccountResponseBody
type CircleRequest CardRequest Source #
Instance details Defined in Circle.Types type CircleRequest CardRequest = CircleResponseBody CardResponseBody
type CircleRequest CardsRequest Source #
Instance details Defined in Circle.Types type CircleRequest CardsRequest = CircleResponseBody [ListCardResponseBody]
type CircleRequest OnChainAddressRequest Source #
Instance details Defined in Circle.Types type CircleRequest OnChainAddressRequest = CircleResponseBody DepositAddressResponseBody
type CircleRequest OnChainTransfersRequest Source #
Instance details Defined in Circle.Types type CircleRequest OnChainTransfersRequest = CircleResponseBody [TransferResponseBody]
type CircleRequest OnChainTransferRequest Source #
Instance details Defined in Circle.Types type CircleRequest OnChainTransferRequest = CircleResponseBody TransferResponseBody
type CircleRequest PaymentsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentsRequest = CircleResponseBody [ThisOrThat FiatOrCryptoPaymentResponseBody FiatCancelOrRefundResponseBody]
type CircleRequest PaymentRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentRequest = CircleResponseBody (ThisOrThat FiatOrCryptoPaymentResponseBody FiatCancelOrRefundResponseBody)
type CircleRequest WireInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireInstructionsRequest = CircleResponseBody WireInstructionsResponseData
type CircleRequest WireAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireAccountsRequest = CircleResponseBody [WireAccountResponseBody]
type CircleRequest WireAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireAccountRequest = CircleResponseBody WireAccountResponseBody
type CircleRequest SignetBankInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankInstructionsRequest = CircleResponseBody SignetBankInstructionsResponseData
type CircleRequest SignetBankAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankAccountsRequest = CircleResponseBody [SignetBankAccountResponseData]
type CircleRequest SignetBankAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankAccountRequest = CircleResponseBody SignetBankAccountResponseData
type CircleRequest SENInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENInstructionsRequest = CircleResponseBody SENInstructionsResponseData
type CircleRequest SENAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENAccountsRequest = CircleResponseBody [SENAccountResponseBody]
type CircleRequest SENAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENAccountRequest = CircleResponseBody SENAccountResponseBody
type CircleRequest MockPaymentRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockPaymentRequest = CircleResponseBody MockPaymentResponseBody
type CircleRequest DepositsRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositsRequest = CircleResponseBody [DepositResponseBody]
type CircleRequest RecipientAddressRequest Source #
Instance details Defined in Circle.Types type CircleRequest RecipientAddressRequest = CircleResponseBody RecipientAddressResponseBody
type CircleRequest RecipientAddressesRequest Source #
Instance details Defined in Circle.Types type CircleRequest RecipientAddressesRequest = CircleResponseBody [RecipientAddressResponseBody]
type CircleRequest DepositAddressRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositAddressRequest = CircleResponseBody DepositAddressResponseBody
type CircleRequest DepositAddressesRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositAddressesRequest = CircleResponseBody [DepositAddressResponseBody]
type CircleRequest TransferRequest Source #
Instance details Defined in Circle.Types type CircleRequest TransferRequest = CircleResponseBody TransferResponseBody
type CircleRequest TransfersRequest Source #
Instance details Defined in Circle.Types type CircleRequest TransfersRequest = CircleResponseBody [TransferResponseBody]
type CircleRequest SubscriptionRequest Source #
Instance details Defined in Circle.Types type CircleRequest SubscriptionRequest = CircleResponseBody SubscriptionResponseBody
type CircleRequest SubscriptionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SubscriptionsRequest = CircleResponseBody [SubscriptionResponseBody]
type CircleRequest StablecoinsRequest Source #
Instance details Defined in Circle.Types type CircleRequest StablecoinsRequest = CircleResponseBody [StablecoinResponseBody]
type CircleRequest ChannelsRequest Source #
Instance details Defined in Circle.Types type CircleRequest ChannelsRequest = CircleResponseBody ChannelResponseBody
type CircleRequest EncryptionRequest Source #
Instance details Defined in Circle.Types type CircleRequest EncryptionRequest = CircleResponseBody EncryptionResponseBody
type CircleRequest ConfigurationRequest Source #
Instance details Defined in Circle.Types type CircleRequest ConfigurationRequest = CircleResponseBody ConfigurationResponseBody
type CircleRequest PayoutsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PayoutsRequest = CircleResponseBody [PayoutResponseBody]
type CircleRequest PayoutRequest Source #
Instance details Defined in Circle.Types type CircleRequest PayoutRequest = CircleResponseBody PayoutResponseBody
type CircleRequest BalanceRequest Source #
Instance details Defined in Circle.Types type CircleRequest BalanceRequest = CircleResponseBody BalanceResponseBody

data CircleError Source #

CircleErrors have contain both the error reason (parseError) and the full error response body as a ByteString.

Constructors

CircleError
Fields parseError :: !Text errorResponseBody :: !Reply

Instances

Instances details

Show CircleError Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CircleError -> ShowS # show :: CircleError -> String # showList :: [CircleError] -> ShowS #

data CircleResponseBody a Source #

The CircleResponseBody will have Nothing for the circleResponseCode and circleResponseMessage if the request succeeds, and Nothing for the circleResponseData if the request fails.

Constructors

CircleResponseBody
Fields circleResponseCode :: !(Maybe ResponseStatus) circleResponseMessage :: !(Maybe ResponseMessage) circleResponseData :: !(Maybe a)

Instances

Instances details

Eq a => Eq (CircleResponseBody a) Source #
Instance details Defined in Circle.Types Methods (==) :: CircleResponseBody a -> CircleResponseBody a -> Bool # (/=) :: CircleResponseBody a -> CircleResponseBody a -> Bool #
Show a => Show (CircleResponseBody a) Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CircleResponseBody a -> ShowS # show :: CircleResponseBody a -> String # showList :: [CircleResponseBody a] -> ShowS #
FromJSON a => FromJSON (CircleResponseBody a) Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser (CircleResponseBody a) # parseJSONList :: Value -> Parser [CircleResponseBody a] #

newtype ResponseStatus Source #

Constructors

ResponseStatus
Fields unResponseStatus :: Int

Instances

Instances details

Eq ResponseStatus Source #
Instance details Defined in Circle.Types Methods (==) :: ResponseStatus -> ResponseStatus -> Bool # (/=) :: ResponseStatus -> ResponseStatus -> Bool #
Show ResponseStatus Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ResponseStatus -> ShowS # show :: ResponseStatus -> String # showList :: [ResponseStatus] -> ShowS #
FromJSON ResponseStatus Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ResponseStatus # parseJSONList :: Value -> Parser [ResponseStatus] #
HasCodec ResponseStatus Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ResponseStatus # listCodecForStringCompatibility :: JSONCodec [ResponseStatus] #

newtype ResponseMessage Source #

Constructors

ResponseMessage
Fields unResponseMessage :: Text

Instances

Instances details

Eq ResponseMessage Source #
Instance details Defined in Circle.Types Methods (==) :: ResponseMessage -> ResponseMessage -> Bool # (/=) :: ResponseMessage -> ResponseMessage -> Bool #
Show ResponseMessage Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ResponseMessage -> ShowS # show :: ResponseMessage -> String # showList :: [ResponseMessage] -> ShowS #
FromJSON ResponseMessage Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ResponseMessage # parseJSONList :: Value -> Parser [ResponseMessage] #
HasCodec ResponseMessage Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ResponseMessage # listCodecForStringCompatibility :: JSONCodec [ResponseMessage] #

type Reply = Response ByteString Source #

type Method = Method Source #

type Host = Text Source #

Either production or sandbox API host

data CircleHost Source #

Constructors

CircleProduction
CircleSandbox

Instances

Instances details

Eq CircleHost Source #
Instance details Defined in Circle.Types Methods (==) :: CircleHost -> CircleHost -> Bool # (/=) :: CircleHost -> CircleHost -> Bool #
Show CircleHost Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CircleHost -> ShowS # show :: CircleHost -> String # showList :: [CircleHost] -> ShowS #

hostUri :: CircleHost -> Text Source #

data CircleConfig Source #

Constructors

CircleConfig
Fields host :: !CircleHost token :: !ApiToken

Instances

Instances details

Eq CircleConfig Source #
Instance details Defined in Circle.Types Methods (==) :: CircleConfig -> CircleConfig -> Bool # (/=) :: CircleConfig -> CircleConfig -> Bool #
Show CircleConfig Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CircleConfig -> ShowS # show :: CircleConfig -> String # showList :: [CircleConfig] -> ShowS #

credentialsEnv :: Maybe String -> IO ApiToken Source #

Creates an API token using a secrete stored at $CIRCLE_API_KEY (the default key for storing the Circle secret)

prodEnvConfig :: Maybe String -> IO CircleConfig Source #

Helper method for instantiating a Circle config that calls the production endpoint: https://api.circle.com/v1/ Example usage: @ import Circle.Client import Circle.Types import Network.HTTP.Client (newManager) import Network.HTTP.Client.TLS (tlsManagerSettings)

main :: IO () main = do manager <- newManager tlsManagerSettings config <- prodEnvConfig "CIRCLE_API_KEY" result <- circle config manager getConfigurationInfo case result of Right CircleResponseBody b -> print bs Left CircleError e -> print e @

sandboxEnvConfig :: Maybe String -> IO CircleConfig Source #

Helper method for instantiating a Circle config that calls the production endpoint: https://api-sandbox.circle.com/v1/ Example usage: @ import Circle.Client import Circle.Types import Network.HTTP.Client (newManager) import Network.HTTP.Client.TLS (tlsManagerSettings)

main :: IO () main = do manager <- newManager tlsManagerSettings config <- sandboxEnvConfig "CIRCLE_API_KEY" result <- circle config manager getConfigurationInfo case result of Right CircleResponseBody b -> print bs Left CircleError e -> print e @

newtype Query Source #

Constructors

Query
Fields unQuery :: TupleBS8

Instances

Instances details

Eq Query Source #
Instance details Defined in Circle.Types Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
Show Query Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #

newtype Body Source #

Constructors

Body
Fields unBody :: ByteString

Instances

Instances details

Eq Body Source #
Instance details Defined in Circle.Types Methods (==) :: Body -> Body -> Bool # (/=) :: Body -> Body -> Bool #
Show Body Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Body -> ShowS # show :: Body -> String # showList :: [Body] -> ShowS #

data Params b c Source #

Parameters for each request which include both the query and the body of a request

Constructors

Params
Fields paramsBody :: Maybe Body paramsQuery :: ![Query]

Instances

Instances details

Show (Params b c) Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Params b c -> ShowS # show :: Params b c -> String # showList :: [Params b c] -> ShowS #

joinQueryParams :: Params b c -> Params b c -> Params b c Source #

type TupleBS8 = (ByteString, ByteString) Source #

Type alias for query parameters

class ToCircleParam param where Source #

Convert a parameter to a key/value

Methods

toCircleParam :: param -> Params TupleBS8 c -> Params TupleBS8 c Source #

Instances

Instances details

ToCircleParam ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: ReturnIdentitiesQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: DestinationWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SourceWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam WalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: WalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIntentContextQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentStatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PaymentIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIntentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam SettlementIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SettlementIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam SourceQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SourceQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam CurrencyQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: CurrencyQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam TypeQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: TypeQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam DestinationQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: DestinationQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam StatusQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: StatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PageSizeQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PageSizeQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam ToQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: ToQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam FromQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: FromQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
ToCircleParam PaginationQueryParams Source #	Circle has some BS pagination where they let users supply some canonical collection ID, and then this pagination rule will return `n` entries before OR after that page, where `n` is controlled by the pageSize param. This type exists to prevent callers from providing both params, which would error out
Instance details Defined in Circle.Types Methods toCircleParam :: PaginationQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #

class ToCircleParam param => CircleHasParam request param Source #

Instances

Instances details

CircleHasParam WalletsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam WalletsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam WalletsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam WalletsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest PaymentIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam CardsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam CardsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest WalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransferRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest SettlementIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest SourceQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam WireInstructionsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam TransferRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest WalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest StatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types

(-&-) :: CircleHasParam r param => CircleAPIRequest r b c -> param -> CircleAPIRequest r b c Source #

Supports adding an optional query parameter. Example usage: @ import Circle.Client import Circle.Types import Network.HTTP.Client (newManager) import Network.HTTP.Client.TLS (tlsManagerSettings)

main :: IO () main = do manager <- newManager tlsManagerSettings config <- sandboxEnvConfig "CIRCLE_API_KEY" result <- circle config manager listAllBalances -&- PaginationQueryParams (PageBefore "a8899b8e-782a-4526-b674-0efe1e04526d") case result of Right CircleResponseBody b -> print bs Left CircleError e -> print e @

newtype PaginationQueryParams Source #

Constructors

PaginationQueryParams
Fields paginationQueryParams :: PaginationQueryParam

Instances

Instances details

Eq PaginationQueryParams Source #
Instance details Defined in Circle.Types Methods (==) :: PaginationQueryParams -> PaginationQueryParams -> Bool # (/=) :: PaginationQueryParams -> PaginationQueryParams -> Bool #
Show PaginationQueryParams Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaginationQueryParams -> ShowS # show :: PaginationQueryParams -> String # showList :: [PaginationQueryParams] -> ShowS #
ToCircleParam PaginationQueryParams Source #	Circle has some BS pagination where they let users supply some canonical collection ID, and then this pagination rule will return `n` entries before OR after that page, where `n` is controlled by the pageSize param. This type exists to prevent callers from providing both params, which would error out
Instance details Defined in Circle.Types Methods toCircleParam :: PaginationQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam WalletsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam CardsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam WireInstructionsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types

data PaginationQueryParam Source #

Depending on which endpoint is being called, the IDs after the PageBefore and PageAfter params could either be UUIDs or non-UUIDs. Let's just keep them as text for now. TODO maybe improve this one day.

Constructors

PageBefore !Text
PageAfter !Text

Instances

Instances details

Eq PaginationQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: PaginationQueryParam -> PaginationQueryParam -> Bool # (/=) :: PaginationQueryParam -> PaginationQueryParam -> Bool #
Show PaginationQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaginationQueryParam -> ShowS # show :: PaginationQueryParam -> String # showList :: [PaginationQueryParam] -> ShowS #

newtype FromQueryParam Source #

Constructors

FromQueryParam
Fields fromQueryParam :: UTCTime

Instances

Instances details

Eq FromQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: FromQueryParam -> FromQueryParam -> Bool # (/=) :: FromQueryParam -> FromQueryParam -> Bool #
Show FromQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> FromQueryParam -> ShowS # show :: FromQueryParam -> String # showList :: [FromQueryParam] -> ShowS #
ToCircleParam FromQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: FromQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam WalletsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest FromQueryParam Source #
Instance details Defined in Circle.Types

newtype ToQueryParam Source #

Constructors

ToQueryParam
Fields toQueryParam :: UTCTime

Instances

Instances details

Eq ToQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: ToQueryParam -> ToQueryParam -> Bool # (/=) :: ToQueryParam -> ToQueryParam -> Bool #
Show ToQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ToQueryParam -> ShowS # show :: ToQueryParam -> String # showList :: [ToQueryParam] -> ShowS #
ToCircleParam ToQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: ToQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam WalletsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest ToQueryParam Source #
Instance details Defined in Circle.Types

newtype PageSizeQueryParam Source #

Constructors

PageSizeQueryParam
Fields pageSizeQueryParam :: Integer

Instances

Instances details

Eq PageSizeQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: PageSizeQueryParam -> PageSizeQueryParam -> Bool # (/=) :: PageSizeQueryParam -> PageSizeQueryParam -> Bool #
Show PageSizeQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PageSizeQueryParam -> ShowS # show :: PageSizeQueryParam -> String # showList :: [PageSizeQueryParam] -> ShowS #
ToCircleParam PageSizeQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PageSizeQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam WalletsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReturnsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam ChargebacksRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam SettlementsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam CardsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransfersRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types

newtype StatusQueryParams Source #

Constructors

StatusQueryParams
Fields statusQueryParams :: [Status]

Instances

Instances details

Eq StatusQueryParams Source #
Instance details Defined in Circle.Types Methods (==) :: StatusQueryParams -> StatusQueryParams -> Bool # (/=) :: StatusQueryParams -> StatusQueryParams -> Bool #
Show StatusQueryParams Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> StatusQueryParams -> ShowS # show :: StatusQueryParams -> String # showList :: [StatusQueryParams] -> ShowS #
ToCircleParam StatusQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: StatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PayoutsRequest StatusQueryParams Source #
Instance details Defined in Circle.Types

statusToBS8 :: Status -> ByteString Source #

newtype DestinationQueryParam Source #

Constructors

DestinationQueryParam
Fields destinationQueryParam :: UUID

Instances

Instances details

Eq DestinationQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: DestinationQueryParam -> DestinationQueryParam -> Bool # (/=) :: DestinationQueryParam -> DestinationQueryParam -> Bool #
Show DestinationQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DestinationQueryParam -> ShowS # show :: DestinationQueryParam -> String # showList :: [DestinationQueryParam] -> ShowS #
ToCircleParam DestinationQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: DestinationQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types

newtype TypeQueryParam Source #

Constructors

TypeQueryParam
Fields typeQueryParam :: BankAccountType

Instances

Instances details

Eq TypeQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: TypeQueryParam -> TypeQueryParam -> Bool # (/=) :: TypeQueryParam -> TypeQueryParam -> Bool #
Show TypeQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TypeQueryParam -> ShowS # show :: TypeQueryParam -> String # showList :: [TypeQueryParam] -> ShowS #
ToCircleParam TypeQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: TypeQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types

bankAccountTypeToBS8 :: BankAccountType -> ByteString Source #

newtype CurrencyQueryParam Source #

Constructors

CurrencyQueryParam
Fields currencyQueryParam :: SupportedCurrencies

Instances

Instances details

Eq CurrencyQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: CurrencyQueryParam -> CurrencyQueryParam -> Bool # (/=) :: CurrencyQueryParam -> CurrencyQueryParam -> Bool #
Show CurrencyQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CurrencyQueryParam -> ShowS # show :: CurrencyQueryParam -> String # showList :: [CurrencyQueryParam] -> ShowS #
ToCircleParam CurrencyQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: CurrencyQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #

currencyToBS8 :: SupportedCurrencies -> ByteString Source #

newtype SourceQueryParam Source #

Constructors

SourceQueryParam
Fields sourceQueryParam :: UUID

Instances

Instances details

Eq SourceQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: SourceQueryParam -> SourceQueryParam -> Bool # (/=) :: SourceQueryParam -> SourceQueryParam -> Bool #
Show SourceQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SourceQueryParam -> ShowS # show :: SourceQueryParam -> String # showList :: [SourceQueryParam] -> ShowS #
ToCircleParam SourceQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SourceQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentsRequest SourceQueryParam Source #
Instance details Defined in Circle.Types

newtype SettlementIdQueryParam Source #

Constructors

SettlementIdQueryParam
Fields settlementIdQueryParam :: UUID

Instances

Instances details

Eq SettlementIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: SettlementIdQueryParam -> SettlementIdQueryParam -> Bool # (/=) :: SettlementIdQueryParam -> SettlementIdQueryParam -> Bool #
Show SettlementIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SettlementIdQueryParam -> ShowS # show :: SettlementIdQueryParam -> String # showList :: [SettlementIdQueryParam] -> ShowS #
ToCircleParam SettlementIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SettlementIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentsRequest SettlementIdQueryParam Source #
Instance details Defined in Circle.Types

newtype PaymentIntentIdQueryParam Source #

Constructors

PaymentIntentIdQueryParam
Fields paymentIntentIdQueryParam :: UUID

Instances

Instances details

Eq PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: PaymentIntentIdQueryParam -> PaymentIntentIdQueryParam -> Bool # (/=) :: PaymentIntentIdQueryParam -> PaymentIntentIdQueryParam -> Bool #
Show PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentIdQueryParam -> ShowS # show :: PaymentIntentIdQueryParam -> String # showList :: [PaymentIntentIdQueryParam] -> ShowS #
ToCircleParam PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIntentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentsRequest PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types

newtype PaymentIdQueryParam Source #

Constructors

PaymentIdQueryParam
Fields paymentIdQueryParam :: UUID

Instances

Instances details

Eq PaymentIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: PaymentIdQueryParam -> PaymentIdQueryParam -> Bool # (/=) :: PaymentIdQueryParam -> PaymentIdQueryParam -> Bool #
Show PaymentIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaymentIdQueryParam -> ShowS # show :: PaymentIdQueryParam -> String # showList :: [PaymentIdQueryParam] -> ShowS #
ToCircleParam PaymentIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam ChargebacksRequest PaymentIdQueryParam Source #
Instance details Defined in Circle.Types

newtype PaymentStatusQueryParams Source #

Constructors

PaymentStatusQueryParams
Fields paymentStatusQueryParams :: [PaymentStatus]

Instances

Instances details

Eq PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types Methods (==) :: PaymentStatusQueryParams -> PaymentStatusQueryParams -> Bool # (/=) :: PaymentStatusQueryParams -> PaymentStatusQueryParams -> Bool #
Show PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaymentStatusQueryParams -> ShowS # show :: PaymentStatusQueryParams -> String # showList :: [PaymentStatusQueryParams] -> ShowS #
ToCircleParam PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentStatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentIntentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam ReversalsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types

paymentStatusToBS8 :: PaymentStatus -> ByteString Source #

newtype PaymentIntentContextQueryParams Source #

Constructors

PaymentIntentContextQueryParams
Fields paymentIntentContextQueryParams :: [PaymentIntentContext]

Instances

Instances details

Eq PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types Methods (==) :: PaymentIntentContextQueryParams -> PaymentIntentContextQueryParams -> Bool # (/=) :: PaymentIntentContextQueryParams -> PaymentIntentContextQueryParams -> Bool #
Show PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentContextQueryParams -> ShowS # show :: PaymentIntentContextQueryParams -> String # showList :: [PaymentIntentContextQueryParams] -> ShowS #
ToCircleParam PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types Methods toCircleParam :: PaymentIntentContextQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam PaymentIntentsRequest PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types

paymentIntentContextToBS8 :: PaymentIntentContext -> ByteString Source #

newtype WalletIdQueryParam Source #

Constructors

WalletIdQueryParam
Fields walletIdQueryParam :: WalletId

Instances

Instances details

Eq WalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: WalletIdQueryParam -> WalletIdQueryParam -> Bool # (/=) :: WalletIdQueryParam -> WalletIdQueryParam -> Bool #
Show WalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> WalletIdQueryParam -> ShowS # show :: WalletIdQueryParam -> String # showList :: [WalletIdQueryParam] -> ShowS #
ToCircleParam WalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: WalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam OnChainTransfersRequest WalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest WalletIdQueryParam Source #
Instance details Defined in Circle.Types

newtype SourceWalletIdQueryParam Source #

Constructors

SourceWalletIdQueryParam
Fields sourceWalletIdQueryParam :: WalletId

Instances

Instances details

Eq SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: SourceWalletIdQueryParam -> SourceWalletIdQueryParam -> Bool # (/=) :: SourceWalletIdQueryParam -> SourceWalletIdQueryParam -> Bool #
Show SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SourceWalletIdQueryParam -> ShowS # show :: SourceWalletIdQueryParam -> String # showList :: [SourceWalletIdQueryParam] -> ShowS #
ToCircleParam SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: SourceWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam OnChainTransfersRequest SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types

newtype DestinationWalletIdQueryParam Source #

Constructors

DestinationWalletIdQueryParam
Fields destinationWalletIdQueryParam :: WalletId

Instances

Instances details

Eq DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: DestinationWalletIdQueryParam -> DestinationWalletIdQueryParam -> Bool # (/=) :: DestinationWalletIdQueryParam -> DestinationWalletIdQueryParam -> Bool #
Show DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DestinationWalletIdQueryParam -> ShowS # show :: DestinationWalletIdQueryParam -> String # showList :: [DestinationWalletIdQueryParam] -> ShowS #
ToCircleParam DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: DestinationWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam OnChainTransfersRequest DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types

newtype ReturnIdentitiesQueryParam Source #

Constructors

ReturnIdentitiesQueryParam
Fields returnIdentitiesQueryParam :: Bool

Instances

Instances details

Eq ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types Methods (==) :: ReturnIdentitiesQueryParam -> ReturnIdentitiesQueryParam -> Bool # (/=) :: ReturnIdentitiesQueryParam -> ReturnIdentitiesQueryParam -> Bool #
Show ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ReturnIdentitiesQueryParam -> ShowS # show :: ReturnIdentitiesQueryParam -> String # showList :: [ReturnIdentitiesQueryParam] -> ShowS #
ToCircleParam ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types Methods toCircleParam :: ReturnIdentitiesQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source #
CircleHasParam OnChainTransfersRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam OnChainTransferRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransferRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types

data BalanceRequest Source #

Instances

Instances details

type CircleRequest BalanceRequest Source #
Instance details Defined in Circle.Types type CircleRequest BalanceRequest = CircleResponseBody BalanceResponseBody

data BalanceResponseBody Source #

Response body for the "businessAccount/balances" and "/balances" endpoints

Constructors

BalanceResponseBody
Fields balanceResponseBodyAvailable :: ![MoneyAmount] balanceResponseBodyUnsettled :: ![MoneyAmount]

Instances

Instances details

Eq BalanceResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: BalanceResponseBody -> BalanceResponseBody -> Bool # (/=) :: BalanceResponseBody -> BalanceResponseBody -> Bool #
Show BalanceResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> BalanceResponseBody -> ShowS # show :: BalanceResponseBody -> String # showList :: [BalanceResponseBody] -> ShowS #
Generic BalanceResponseBody Source #
Instance details Defined in Circle.Types Associated Types type Rep BalanceResponseBody :: Type -> Type # Methods from :: BalanceResponseBody -> Rep BalanceResponseBody x # to :: Rep BalanceResponseBody x -> BalanceResponseBody #
ToJSON BalanceResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: BalanceResponseBody -> Value # toEncoding :: BalanceResponseBody -> Encoding # toJSONList :: [BalanceResponseBody] -> Value # toEncodingList :: [BalanceResponseBody] -> Encoding #
FromJSON BalanceResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser BalanceResponseBody # parseJSONList :: Value -> Parser [BalanceResponseBody] #
HasCodec BalanceResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec BalanceResponseBody # listCodecForStringCompatibility :: JSONCodec [BalanceResponseBody] #
type Rep BalanceResponseBody Source #
Instance details Defined in Circle.Types type Rep BalanceResponseBody = D1 ('MetaData "BalanceResponseBody" "Circle.Types" "circle-0.1.0.0-inplace" 'False) (C1 ('MetaCons "BalanceResponseBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "balanceResponseBodyAvailable") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [MoneyAmount]) :*: S1 ('MetaSel ('Just "balanceResponseBodyUnsettled") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [MoneyAmount])))

data PayoutRequest Source #

Instances

Instances details

type CircleRequest PayoutRequest Source #
Instance details Defined in Circle.Types type CircleRequest PayoutRequest = CircleResponseBody PayoutResponseBody

data PayoutsRequest Source #

Instances

Instances details

CircleHasParam PayoutsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest StatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PayoutsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest PayoutsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PayoutsRequest = CircleResponseBody [PayoutResponseBody]

data PayoutResponseBody Source #

Response body for methods that call "businessAccount/payouts" or "payouts" endpoints

Instances

Instances details

Eq PayoutResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: PayoutResponseBody -> PayoutResponseBody -> Bool # (/=) :: PayoutResponseBody -> PayoutResponseBody -> Bool #
Show PayoutResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PayoutResponseBody -> ShowS # show :: PayoutResponseBody -> String # showList :: [PayoutResponseBody] -> ShowS #
ToJSON PayoutResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: PayoutResponseBody -> Value # toEncoding :: PayoutResponseBody -> Encoding # toJSONList :: [PayoutResponseBody] -> Value # toEncodingList :: [PayoutResponseBody] -> Encoding #
FromJSON PayoutResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutResponseBody # parseJSONList :: Value -> Parser [PayoutResponseBody] #
HasCodec PayoutResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PayoutResponseBody # listCodecForStringCompatibility :: JSONCodec [PayoutResponseBody] #

data BusinessPayoutRequestBody Source #

Request body for creating a new business account payout

Constructors

BusinessPayoutRequestBody
Fields businessPayoutIdempotencyKey :: !UUID businessPayoutDestination :: !DestinationBankAccount businessPayoutAmount :: !MoneyAmount

Instances

Instances details

Eq BusinessPayoutRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: BusinessPayoutRequestBody -> BusinessPayoutRequestBody -> Bool # (/=) :: BusinessPayoutRequestBody -> BusinessPayoutRequestBody -> Bool #
Show BusinessPayoutRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> BusinessPayoutRequestBody -> ShowS # show :: BusinessPayoutRequestBody -> String # showList :: [BusinessPayoutRequestBody] -> ShowS #
ToJSON BusinessPayoutRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: BusinessPayoutRequestBody -> Value # toEncoding :: BusinessPayoutRequestBody -> Encoding # toJSONList :: [BusinessPayoutRequestBody] -> Value # toEncodingList :: [BusinessPayoutRequestBody] -> Encoding #
FromJSON BusinessPayoutRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser BusinessPayoutRequestBody # parseJSONList :: Value -> Parser [BusinessPayoutRequestBody] #
HasCodec BusinessPayoutRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec BusinessPayoutRequestBody # listCodecForStringCompatibility :: JSONCodec [BusinessPayoutRequestBody] #

newtype PayoutMetadata Source #

Constructors

PayoutMetadata
Fields payoutMetadataBeneficiaryEmail :: Email

Instances

Instances details

Eq PayoutMetadata Source #
Instance details Defined in Circle.Types Methods (==) :: PayoutMetadata -> PayoutMetadata -> Bool # (/=) :: PayoutMetadata -> PayoutMetadata -> Bool #
Show PayoutMetadata Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PayoutMetadata -> ShowS # show :: PayoutMetadata -> String # showList :: [PayoutMetadata] -> ShowS #
ToJSON PayoutMetadata Source #
Instance details Defined in Circle.Types Methods toJSON :: PayoutMetadata -> Value # toEncoding :: PayoutMetadata -> Encoding # toJSONList :: [PayoutMetadata] -> Value # toEncodingList :: [PayoutMetadata] -> Encoding #
FromJSON PayoutMetadata Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutMetadata # parseJSONList :: Value -> Parser [PayoutMetadata] #
HasCodec PayoutMetadata Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PayoutMetadata # listCodecForStringCompatibility :: JSONCodec [PayoutMetadata] #

data PayoutRequestBody Source #

Request body to create a payout.

Constructors

PayoutRequestBody
Fields payoutIdempotencyKey :: !UUID payoutSource :: !(Maybe PaymentSource) payoutDestination :: !DestinationBankAccount payoutAmount :: !MoneyAmount payoutMetadata :: !PayoutMetadata

Instances

Instances details

Eq PayoutRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: PayoutRequestBody -> PayoutRequestBody -> Bool # (/=) :: PayoutRequestBody -> PayoutRequestBody -> Bool #
Show PayoutRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PayoutRequestBody -> ShowS # show :: PayoutRequestBody -> String # showList :: [PayoutRequestBody] -> ShowS #
ToJSON PayoutRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: PayoutRequestBody -> Value # toEncoding :: PayoutRequestBody -> Encoding # toJSONList :: [PayoutRequestBody] -> Value # toEncodingList :: [PayoutRequestBody] -> Encoding #
FromJSON PayoutRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutRequestBody # parseJSONList :: Value -> Parser [PayoutRequestBody] #
HasCodec PayoutRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PayoutRequestBody # listCodecForStringCompatibility :: JSONCodec [PayoutRequestBody] #

data PayoutReturnResponseBody Source #

Response body for methods that call the "returns" endpoint

Constructors

PayoutReturnResponseBody
Fields payoutReturnResponseBodyId :: !UUID payoutReturnResponseBodyOriginalPayoutId :: !UUID payoutReturnResponseBodyAmount :: !MoneyAmount payoutReturnResponseBodyFees :: !MoneyAmount payoutReturnResponseBodyReason :: !Text payoutReturnResponseBodyStatus :: !Status payoutReturnResponseBodyCreateDate :: !UTCTime payoutReturnResponseBodyUpdateDate :: !UTCTime

Instances

Instances details

Eq PayoutReturnResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: PayoutReturnResponseBody -> PayoutReturnResponseBody -> Bool # (/=) :: PayoutReturnResponseBody -> PayoutReturnResponseBody -> Bool #
Show PayoutReturnResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PayoutReturnResponseBody -> ShowS # show :: PayoutReturnResponseBody -> String # showList :: [PayoutReturnResponseBody] -> ShowS #
ToJSON PayoutReturnResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: PayoutReturnResponseBody -> Value # toEncoding :: PayoutReturnResponseBody -> Encoding # toJSONList :: [PayoutReturnResponseBody] -> Value # toEncodingList :: [PayoutReturnResponseBody] -> Encoding #
FromJSON PayoutReturnResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutReturnResponseBody # parseJSONList :: Value -> Parser [PayoutReturnResponseBody] #
HasCodec PayoutReturnResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PayoutReturnResponseBody # listCodecForStringCompatibility :: JSONCodec [PayoutReturnResponseBody] #

data PayoutErrorCode Source #

Constructors

InsufficientFunds
TransactionDenied
TransactionFailed
TransactionReturned
BankTransactionError
FiatAccountLimitExceeded
InvalidBankAccountNumber
InvalidACHRoutingTransitNumber
InvalidWireRoutingTransitNumber
VendorInactive

Instances

Instances details

Eq PayoutErrorCode Source #
Instance details Defined in Circle.Types Methods (==) :: PayoutErrorCode -> PayoutErrorCode -> Bool # (/=) :: PayoutErrorCode -> PayoutErrorCode -> Bool #
Show PayoutErrorCode Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PayoutErrorCode -> ShowS # show :: PayoutErrorCode -> String # showList :: [PayoutErrorCode] -> ShowS #
ToJSON PayoutErrorCode Source #
Instance details Defined in Circle.Types Methods toJSON :: PayoutErrorCode -> Value # toEncoding :: PayoutErrorCode -> Encoding # toJSONList :: [PayoutErrorCode] -> Value # toEncodingList :: [PayoutErrorCode] -> Encoding #
FromJSON PayoutErrorCode Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutErrorCode # parseJSONList :: Value -> Parser [PayoutErrorCode] #
HasCodec PayoutErrorCode Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PayoutErrorCode # listCodecForStringCompatibility :: JSONCodec [PayoutErrorCode] #

data ConfigurationRequest Source #

Instances

Instances details

type CircleRequest ConfigurationRequest Source #
Instance details Defined in Circle.Types type CircleRequest ConfigurationRequest = CircleResponseBody ConfigurationResponseBody

newtype ConfigurationResponseBody Source #

Response body for the "/configuration" endpoint

Constructors

ConfigurationResponseBody
Fields configurationResponseBodyPayments :: WalletConfig

Instances

Instances details

Eq ConfigurationResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: ConfigurationResponseBody -> ConfigurationResponseBody -> Bool # (/=) :: ConfigurationResponseBody -> ConfigurationResponseBody -> Bool #
Show ConfigurationResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ConfigurationResponseBody -> ShowS # show :: ConfigurationResponseBody -> String # showList :: [ConfigurationResponseBody] -> ShowS #
ToJSON ConfigurationResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: ConfigurationResponseBody -> Value # toEncoding :: ConfigurationResponseBody -> Encoding # toJSONList :: [ConfigurationResponseBody] -> Value # toEncodingList :: [ConfigurationResponseBody] -> Encoding #
FromJSON ConfigurationResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ConfigurationResponseBody # parseJSONList :: Value -> Parser [ConfigurationResponseBody] #
HasCodec ConfigurationResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ConfigurationResponseBody # listCodecForStringCompatibility :: JSONCodec [ConfigurationResponseBody] #

newtype WalletConfig Source #

Constructors

WalletConfig
Fields masterWalletId :: WalletId

Instances

Instances details

Eq WalletConfig Source #
Instance details Defined in Circle.Types Methods (==) :: WalletConfig -> WalletConfig -> Bool # (/=) :: WalletConfig -> WalletConfig -> Bool #
Show WalletConfig Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> WalletConfig -> ShowS # show :: WalletConfig -> String # showList :: [WalletConfig] -> ShowS #
ToJSON WalletConfig Source #
Instance details Defined in Circle.Types Methods toJSON :: WalletConfig -> Value # toEncoding :: WalletConfig -> Encoding # toJSONList :: [WalletConfig] -> Value # toEncodingList :: [WalletConfig] -> Encoding #
FromJSON WalletConfig Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser WalletConfig # parseJSONList :: Value -> Parser [WalletConfig] #
HasCodec WalletConfig Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec WalletConfig # listCodecForStringCompatibility :: JSONCodec [WalletConfig] #

data EncryptionRequest Source #

Instances

Instances details

type CircleRequest EncryptionRequest Source #
Instance details Defined in Circle.Types type CircleRequest EncryptionRequest = CircleResponseBody EncryptionResponseBody

data EncryptionResponseBody Source #

Response body for the "/encryption/public" endpoint

Constructors

EncryptionResponseBody
Fields encryptionResponseBodyKeyId :: !Text encryptionResponseBodyPublicKey :: !PGPKey

Instances

Instances details

Eq EncryptionResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: EncryptionResponseBody -> EncryptionResponseBody -> Bool # (/=) :: EncryptionResponseBody -> EncryptionResponseBody -> Bool #
Show EncryptionResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> EncryptionResponseBody -> ShowS # show :: EncryptionResponseBody -> String # showList :: [EncryptionResponseBody] -> ShowS #
ToJSON EncryptionResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: EncryptionResponseBody -> Value # toEncoding :: EncryptionResponseBody -> Encoding # toJSONList :: [EncryptionResponseBody] -> Value # toEncodingList :: [EncryptionResponseBody] -> Encoding #
FromJSON EncryptionResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser EncryptionResponseBody # parseJSONList :: Value -> Parser [EncryptionResponseBody] #
HasCodec EncryptionResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec EncryptionResponseBody # listCodecForStringCompatibility :: JSONCodec [EncryptionResponseBody] #

newtype PGPKey Source #

Constructors

PGPKey
Fields unPGPKey :: Text

Instances

Instances details

Eq PGPKey Source #
Instance details Defined in Circle.Types Methods (==) :: PGPKey -> PGPKey -> Bool # (/=) :: PGPKey -> PGPKey -> Bool #
Show PGPKey Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> PGPKey -> ShowS # show :: PGPKey -> String # showList :: [PGPKey] -> ShowS #
ToJSON PGPKey Source #
Instance details Defined in Circle.Types Methods toJSON :: PGPKey -> Value # toEncoding :: PGPKey -> Encoding # toJSONList :: [PGPKey] -> Value # toEncodingList :: [PGPKey] -> Encoding #
FromJSON PGPKey Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser PGPKey # parseJSONList :: Value -> Parser [PGPKey] #
HasCodec PGPKey Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec PGPKey # listCodecForStringCompatibility :: JSONCodec [PGPKey] #

data ChannelsRequest Source #

Instances

Instances details

type CircleRequest ChannelsRequest Source #
Instance details Defined in Circle.Types type CircleRequest ChannelsRequest = CircleResponseBody ChannelResponseBody

newtype ChannelResponseBody Source #

Response body for the "/channels" endpoint

Constructors

ChannelResponseBody
Fields channels :: [Channel]

Instances

Instances details

Eq ChannelResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: ChannelResponseBody -> ChannelResponseBody -> Bool # (/=) :: ChannelResponseBody -> ChannelResponseBody -> Bool #
Show ChannelResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ChannelResponseBody -> ShowS # show :: ChannelResponseBody -> String # showList :: [ChannelResponseBody] -> ShowS #
ToJSON ChannelResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: ChannelResponseBody -> Value # toEncoding :: ChannelResponseBody -> Encoding # toJSONList :: [ChannelResponseBody] -> Value # toEncodingList :: [ChannelResponseBody] -> Encoding #
FromJSON ChannelResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ChannelResponseBody # parseJSONList :: Value -> Parser [ChannelResponseBody] #
HasCodec ChannelResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ChannelResponseBody # listCodecForStringCompatibility :: JSONCodec [ChannelResponseBody] #

data Channel Source #

Constructors

Channel
Fields channelId :: !UUID channelDefault :: !Bool channelCardDescriptor :: !Text channelAchDescriptor :: !Text

Instances

Instances details

Eq Channel Source #
Instance details Defined in Circle.Types Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Show Channel Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Channel -> ShowS # show :: Channel -> String # showList :: [Channel] -> ShowS #
ToJSON Channel Source #
Instance details Defined in Circle.Types Methods toJSON :: Channel -> Value # toEncoding :: Channel -> Encoding # toJSONList :: [Channel] -> Value # toEncodingList :: [Channel] -> Encoding #
FromJSON Channel Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #
HasCodec Channel Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Channel # listCodecForStringCompatibility :: JSONCodec [Channel] #

data StablecoinsRequest Source #

Instances

Instances details

type CircleRequest StablecoinsRequest Source #
Instance details Defined in Circle.Types type CircleRequest StablecoinsRequest = CircleResponseBody [StablecoinResponseBody]

data StablecoinResponseBody Source #

Response body for the "/stablecoins" endpoint

Constructors

StablecoinResponseBody
Fields stablecoinResponseBodyName :: !Text stablecoinResponseBodySymbol :: !Stablecoin stablecoinResponseBodyTotalAmount :: !Text stablecoinResponseBodyChains :: ![ChainAmount]

Instances

Instances details

Eq StablecoinResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: StablecoinResponseBody -> StablecoinResponseBody -> Bool # (/=) :: StablecoinResponseBody -> StablecoinResponseBody -> Bool #
Show StablecoinResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> StablecoinResponseBody -> ShowS # show :: StablecoinResponseBody -> String # showList :: [StablecoinResponseBody] -> ShowS #
ToJSON StablecoinResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: StablecoinResponseBody -> Value # toEncoding :: StablecoinResponseBody -> Encoding # toJSONList :: [StablecoinResponseBody] -> Value # toEncodingList :: [StablecoinResponseBody] -> Encoding #
FromJSON StablecoinResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser StablecoinResponseBody # parseJSONList :: Value -> Parser [StablecoinResponseBody] #
HasCodec StablecoinResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec StablecoinResponseBody # listCodecForStringCompatibility :: JSONCodec [StablecoinResponseBody] #

data ChainAmount Source #

Constructors

ChainAmount
Fields chainAmountAmount :: !Text chainAmountChain :: !Chain chainAmountUpdateDate :: !UTCTime

Instances

Instances details

Eq ChainAmount Source #
Instance details Defined in Circle.Types Methods (==) :: ChainAmount -> ChainAmount -> Bool # (/=) :: ChainAmount -> ChainAmount -> Bool #
Show ChainAmount Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ChainAmount -> ShowS # show :: ChainAmount -> String # showList :: [ChainAmount] -> ShowS #
ToJSON ChainAmount Source #
Instance details Defined in Circle.Types Methods toJSON :: ChainAmount -> Value # toEncoding :: ChainAmount -> Encoding # toJSONList :: [ChainAmount] -> Value # toEncodingList :: [ChainAmount] -> Encoding #
FromJSON ChainAmount Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ChainAmount # parseJSONList :: Value -> Parser [ChainAmount] #
HasCodec ChainAmount Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ChainAmount # listCodecForStringCompatibility :: JSONCodec [ChainAmount] #

data Chain Source #

Constructors

ALGO
ARB
AVAX
ChainBTC
ChainETH
FLOW
HBAR
MATIC
NEAR
OP
SOL
TRX
XLM

Instances

Instances details

Eq Chain Source #
Instance details Defined in Circle.Types Methods (==) :: Chain -> Chain -> Bool # (/=) :: Chain -> Chain -> Bool #
Show Chain Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Chain -> ShowS # show :: Chain -> String # showList :: [Chain] -> ShowS #
ToJSON Chain Source #
Instance details Defined in Circle.Types Methods toJSON :: Chain -> Value # toEncoding :: Chain -> Encoding # toJSONList :: [Chain] -> Value # toEncodingList :: [Chain] -> Encoding #
FromJSON Chain Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Chain # parseJSONList :: Value -> Parser [Chain] #
HasCodec Chain Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Chain # listCodecForStringCompatibility :: JSONCodec [Chain] #

data Stablecoin Source #

Constructors

USDC
EUROC
USDT

Instances

Instances details

Eq Stablecoin Source #
Instance details Defined in Circle.Types Methods (==) :: Stablecoin -> Stablecoin -> Bool # (/=) :: Stablecoin -> Stablecoin -> Bool #
Show Stablecoin Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Stablecoin -> ShowS # show :: Stablecoin -> String # showList :: [Stablecoin] -> ShowS #
ToJSON Stablecoin Source #
Instance details Defined in Circle.Types Methods toJSON :: Stablecoin -> Value # toEncoding :: Stablecoin -> Encoding # toJSONList :: [Stablecoin] -> Value # toEncodingList :: [Stablecoin] -> Encoding #
FromJSON Stablecoin Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Stablecoin # parseJSONList :: Value -> Parser [Stablecoin] #
HasCodec Stablecoin Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Stablecoin # listCodecForStringCompatibility :: JSONCodec [Stablecoin] #

data SubscriptionsRequest Source #

Instances

Instances details

type CircleRequest SubscriptionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SubscriptionsRequest = CircleResponseBody [SubscriptionResponseBody]

data SubscriptionRequest Source #

Instances

Instances details

type CircleRequest SubscriptionRequest Source #
Instance details Defined in Circle.Types type CircleRequest SubscriptionRequest = CircleResponseBody SubscriptionResponseBody

data SubscriptionResponseBody Source #

Response body for methods that call "notifications/subscriptions"

Constructors

SubscriptionResponseBody
Fields subscriptionResponseBodyId :: !UUID subscriptionResponseBodyEndpoint :: !URL subscriptionResponseBodySubscriptionDetails :: ![SubscriptionDetails]

Instances

Instances details

Eq SubscriptionResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: SubscriptionResponseBody -> SubscriptionResponseBody -> Bool # (/=) :: SubscriptionResponseBody -> SubscriptionResponseBody -> Bool #
Show SubscriptionResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionResponseBody -> ShowS # show :: SubscriptionResponseBody -> String # showList :: [SubscriptionResponseBody] -> ShowS #
ToJSON SubscriptionResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: SubscriptionResponseBody -> Value # toEncoding :: SubscriptionResponseBody -> Encoding # toJSONList :: [SubscriptionResponseBody] -> Value # toEncodingList :: [SubscriptionResponseBody] -> Encoding #
FromJSON SubscriptionResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionResponseBody # parseJSONList :: Value -> Parser [SubscriptionResponseBody] #
HasCodec SubscriptionResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SubscriptionResponseBody # listCodecForStringCompatibility :: JSONCodec [SubscriptionResponseBody] #

data SubscriptionDetails Source #

Constructors

SubscriptionDetails
Fields subscriptionDetailsUrl :: !URL subscriptionDetailsStatus :: !Status

Instances

Instances details

Eq SubscriptionDetails Source #
Instance details Defined in Circle.Types Methods (==) :: SubscriptionDetails -> SubscriptionDetails -> Bool # (/=) :: SubscriptionDetails -> SubscriptionDetails -> Bool #
Show SubscriptionDetails Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionDetails -> ShowS # show :: SubscriptionDetails -> String # showList :: [SubscriptionDetails] -> ShowS #
ToJSON SubscriptionDetails Source #
Instance details Defined in Circle.Types Methods toJSON :: SubscriptionDetails -> Value # toEncoding :: SubscriptionDetails -> Encoding # toJSONList :: [SubscriptionDetails] -> Value # toEncodingList :: [SubscriptionDetails] -> Encoding #
FromJSON SubscriptionDetails Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionDetails # parseJSONList :: Value -> Parser [SubscriptionDetails] #
HasCodec SubscriptionDetails Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SubscriptionDetails # listCodecForStringCompatibility :: JSONCodec [SubscriptionDetails] #

newtype SubscriptionRequestBody Source #

Request body for creating a new subscription

Constructors

SubscriptionRequestBody
Fields subscriptionRequestBodyEndpoint :: Text

Instances

Instances details

Eq SubscriptionRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: SubscriptionRequestBody -> SubscriptionRequestBody -> Bool # (/=) :: SubscriptionRequestBody -> SubscriptionRequestBody -> Bool #
Show SubscriptionRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionRequestBody -> ShowS # show :: SubscriptionRequestBody -> String # showList :: [SubscriptionRequestBody] -> ShowS #
ToJSON SubscriptionRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: SubscriptionRequestBody -> Value # toEncoding :: SubscriptionRequestBody -> Encoding # toJSONList :: [SubscriptionRequestBody] -> Value # toEncodingList :: [SubscriptionRequestBody] -> Encoding #
FromJSON SubscriptionRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionRequestBody # parseJSONList :: Value -> Parser [SubscriptionRequestBody] #
HasCodec SubscriptionRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SubscriptionRequestBody # listCodecForStringCompatibility :: JSONCodec [SubscriptionRequestBody] #

data TransfersRequest Source #

Instances

Instances details

CircleHasParam TransfersRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest DestinationWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest SourceWalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest WalletIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam TransfersRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest TransfersRequest Source #
Instance details Defined in Circle.Types type CircleRequest TransfersRequest = CircleResponseBody [TransferResponseBody]

data TransferRequest Source #

Instances

Instances details

CircleHasParam TransferRequest ReturnIdentitiesQueryParam Source #
Instance details Defined in Circle.Types
type CircleRequest TransferRequest Source #
Instance details Defined in Circle.Types type CircleRequest TransferRequest = CircleResponseBody TransferResponseBody

data BusinessTransferRequestBody Source #

Request body for creating a new business account transfer

Constructors

BusinessTransferRequestBody
Fields businessTransferRequestBodyIdempotencyKey :: !UUID businessTransferRequestBodyDestination :: !TransferDestination businessTransferRequestBodyAmount :: !MoneyAmount

Instances

Instances details

Eq BusinessTransferRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: BusinessTransferRequestBody -> BusinessTransferRequestBody -> Bool # (/=) :: BusinessTransferRequestBody -> BusinessTransferRequestBody -> Bool #
Show BusinessTransferRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> BusinessTransferRequestBody -> ShowS # show :: BusinessTransferRequestBody -> String # showList :: [BusinessTransferRequestBody] -> ShowS #
ToJSON BusinessTransferRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: BusinessTransferRequestBody -> Value # toEncoding :: BusinessTransferRequestBody -> Encoding # toJSONList :: [BusinessTransferRequestBody] -> Value # toEncodingList :: [BusinessTransferRequestBody] -> Encoding #
FromJSON BusinessTransferRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser BusinessTransferRequestBody # parseJSONList :: Value -> Parser [BusinessTransferRequestBody] #
HasCodec BusinessTransferRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec BusinessTransferRequestBody # listCodecForStringCompatibility :: JSONCodec [BusinessTransferRequestBody] #

data TransferRequestBody Source #

Request body for creating a new transfer

Constructors

TransferRequestBody
Fields transferRequestBodyIdempotencyKey :: !UUID transferRequestBodySource :: !PaymentSource transferRequestBodyDestination :: !TransferDestination transferRequestBodyAmount :: !MoneyAmount

Instances

Instances details

Eq TransferRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: TransferRequestBody -> TransferRequestBody -> Bool # (/=) :: TransferRequestBody -> TransferRequestBody -> Bool #
Show TransferRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TransferRequestBody -> ShowS # show :: TransferRequestBody -> String # showList :: [TransferRequestBody] -> ShowS #
ToJSON TransferRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: TransferRequestBody -> Value # toEncoding :: TransferRequestBody -> Encoding # toJSONList :: [TransferRequestBody] -> Value # toEncodingList :: [TransferRequestBody] -> Encoding #
FromJSON TransferRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferRequestBody # parseJSONList :: Value -> Parser [TransferRequestBody] #
HasCodec TransferRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec TransferRequestBody # listCodecForStringCompatibility :: JSONCodec [TransferRequestBody] #

data TransferDestination Source #

Constructors

TransferDestination
Fields transferDestinationType :: !DestinationType transferDestinationAddressId :: !UUID

Instances

Instances details

Eq TransferDestination Source #
Instance details Defined in Circle.Types Methods (==) :: TransferDestination -> TransferDestination -> Bool # (/=) :: TransferDestination -> TransferDestination -> Bool #
Show TransferDestination Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TransferDestination -> ShowS # show :: TransferDestination -> String # showList :: [TransferDestination] -> ShowS #
ToJSON TransferDestination Source #
Instance details Defined in Circle.Types Methods toJSON :: TransferDestination -> Value # toEncoding :: TransferDestination -> Encoding # toJSONList :: [TransferDestination] -> Value # toEncodingList :: [TransferDestination] -> Encoding #
FromJSON TransferDestination Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferDestination # parseJSONList :: Value -> Parser [TransferDestination] #
HasCodec TransferDestination Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec TransferDestination # listCodecForStringCompatibility :: JSONCodec [TransferDestination] #

data DestinationType Source #

Constructors

VerifiedBlockchain

Instances

Instances details

Eq DestinationType Source #
Instance details Defined in Circle.Types Methods (==) :: DestinationType -> DestinationType -> Bool # (/=) :: DestinationType -> DestinationType -> Bool #
Show DestinationType Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DestinationType -> ShowS # show :: DestinationType -> String # showList :: [DestinationType] -> ShowS #
ToJSON DestinationType Source #
Instance details Defined in Circle.Types Methods toJSON :: DestinationType -> Value # toEncoding :: DestinationType -> Encoding # toJSONList :: [DestinationType] -> Value # toEncodingList :: [DestinationType] -> Encoding #
FromJSON DestinationType Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationType # parseJSONList :: Value -> Parser [DestinationType] #
HasCodec DestinationType Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DestinationType # listCodecForStringCompatibility :: JSONCodec [DestinationType] #

data TransferResponseBody Source #

Response body for methods that call the "businessAccount/transfers" and "transfers" endpoints

Instances

Instances details

Eq TransferResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: TransferResponseBody -> TransferResponseBody -> Bool # (/=) :: TransferResponseBody -> TransferResponseBody -> Bool #
Show TransferResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TransferResponseBody -> ShowS # show :: TransferResponseBody -> String # showList :: [TransferResponseBody] -> ShowS #
FromJSON TransferResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferResponseBody # parseJSONList :: Value -> Parser [TransferResponseBody] #

data SourceWallet Source #

Constructors

SourceWallet
Fields sourceWalletType :: !TransferType sourceWalletId :: !WalletId sourceWalletIdentities :: ![Identity]

Instances

Instances details

Eq SourceWallet Source #
Instance details Defined in Circle.Types Methods (==) :: SourceWallet -> SourceWallet -> Bool # (/=) :: SourceWallet -> SourceWallet -> Bool #
Show SourceWallet Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SourceWallet -> ShowS # show :: SourceWallet -> String # showList :: [SourceWallet] -> ShowS #
ToJSON SourceWallet Source #
Instance details Defined in Circle.Types Methods toJSON :: SourceWallet -> Value # toEncoding :: SourceWallet -> Encoding # toJSONList :: [SourceWallet] -> Value # toEncodingList :: [SourceWallet] -> Encoding #
FromJSON SourceWallet Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SourceWallet # parseJSONList :: Value -> Parser [SourceWallet] #
HasCodec SourceWallet Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SourceWallet # listCodecForStringCompatibility :: JSONCodec [SourceWallet] #

data SourceBlockchain Source #

Constructors

SourceBlockchain
Fields sourceBlockchainType :: !TransferType sourceBlockchainChain :: !Chain sourceBlockChainIdentities :: ![Identity]

Instances

Instances details

Eq SourceBlockchain Source #
Instance details Defined in Circle.Types Methods (==) :: SourceBlockchain -> SourceBlockchain -> Bool # (/=) :: SourceBlockchain -> SourceBlockchain -> Bool #
Show SourceBlockchain Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SourceBlockchain -> ShowS # show :: SourceBlockchain -> String # showList :: [SourceBlockchain] -> ShowS #
ToJSON SourceBlockchain Source #
Instance details Defined in Circle.Types Methods toJSON :: SourceBlockchain -> Value # toEncoding :: SourceBlockchain -> Encoding # toJSONList :: [SourceBlockchain] -> Value # toEncodingList :: [SourceBlockchain] -> Encoding #
FromJSON SourceBlockchain Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SourceBlockchain # parseJSONList :: Value -> Parser [SourceBlockchain] #
HasCodec SourceBlockchain Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SourceBlockchain # listCodecForStringCompatibility :: JSONCodec [SourceBlockchain] #

data DestinationWallet Source #

Constructors

DestinationWallet
Fields destinationWalletType :: !TransferType destinationWalletId :: !WalletId destinationWalletAddress :: !(Maybe Text) destinationWalletAddressTag :: !(Maybe Text)

Instances

Instances details

Eq DestinationWallet Source #
Instance details Defined in Circle.Types Methods (==) :: DestinationWallet -> DestinationWallet -> Bool # (/=) :: DestinationWallet -> DestinationWallet -> Bool #
Show DestinationWallet Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DestinationWallet -> ShowS # show :: DestinationWallet -> String # showList :: [DestinationWallet] -> ShowS #
ToJSON DestinationWallet Source #
Instance details Defined in Circle.Types Methods toJSON :: DestinationWallet -> Value # toEncoding :: DestinationWallet -> Encoding # toJSONList :: [DestinationWallet] -> Value # toEncodingList :: [DestinationWallet] -> Encoding #
FromJSON DestinationWallet Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationWallet # parseJSONList :: Value -> Parser [DestinationWallet] #
HasCodec DestinationWallet Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DestinationWallet # listCodecForStringCompatibility :: JSONCodec [DestinationWallet] #

data DestinationBlockchain Source #

Constructors

DestinationBlockchain
Fields destinationBlockchainType :: !TransferType destinationBlockchainAddress :: !HexString destinationBlockchainAddressTag :: !(Maybe Text) destinationBlockchainAddressChain :: !Chain

Instances

Instances details

Eq DestinationBlockchain Source #
Instance details Defined in Circle.Types Methods (==) :: DestinationBlockchain -> DestinationBlockchain -> Bool # (/=) :: DestinationBlockchain -> DestinationBlockchain -> Bool #
Show DestinationBlockchain Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DestinationBlockchain -> ShowS # show :: DestinationBlockchain -> String # showList :: [DestinationBlockchain] -> ShowS #
ToJSON DestinationBlockchain Source #
Instance details Defined in Circle.Types Methods toJSON :: DestinationBlockchain -> Value # toEncoding :: DestinationBlockchain -> Encoding # toJSONList :: [DestinationBlockchain] -> Value # toEncodingList :: [DestinationBlockchain] -> Encoding #
FromJSON DestinationBlockchain Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationBlockchain # parseJSONList :: Value -> Parser [DestinationBlockchain] #
HasCodec DestinationBlockchain Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DestinationBlockchain # listCodecForStringCompatibility :: JSONCodec [DestinationBlockchain] #

data Identity Source #

Constructors

Identity
Fields identityType :: !IdentityType identityName :: !Text identityAddresses :: ![Address]

Instances

Instances details

Eq Identity Source #
Instance details Defined in Circle.Types Methods (==) :: Identity -> Identity -> Bool # (/=) :: Identity -> Identity -> Bool #
Show Identity Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Identity -> ShowS # show :: Identity -> String # showList :: [Identity] -> ShowS #
ToJSON Identity Source #
Instance details Defined in Circle.Types Methods toJSON :: Identity -> Value # toEncoding :: Identity -> Encoding # toJSONList :: [Identity] -> Value # toEncodingList :: [Identity] -> Encoding #
FromJSON Identity Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Identity # parseJSONList :: Value -> Parser [Identity] #
HasCodec Identity Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Identity # listCodecForStringCompatibility :: JSONCodec [Identity] #

data IdentityType Source #

Constructors

Individual
Business

Instances

Instances details

Eq IdentityType Source #
Instance details Defined in Circle.Types Methods (==) :: IdentityType -> IdentityType -> Bool # (/=) :: IdentityType -> IdentityType -> Bool #
Show IdentityType Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> IdentityType -> ShowS # show :: IdentityType -> String # showList :: [IdentityType] -> ShowS #
ToJSON IdentityType Source #
Instance details Defined in Circle.Types Methods toJSON :: IdentityType -> Value # toEncoding :: IdentityType -> Encoding # toJSONList :: [IdentityType] -> Value # toEncodingList :: [IdentityType] -> Encoding #
FromJSON IdentityType Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser IdentityType # parseJSONList :: Value -> Parser [IdentityType] #
HasCodec IdentityType Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec IdentityType # listCodecForStringCompatibility :: JSONCodec [IdentityType] #

data TransferType Source #

Constructors

Wallet
Blockchain

Instances

Instances details

Eq TransferType Source #
Instance details Defined in Circle.Types Methods (==) :: TransferType -> TransferType -> Bool # (/=) :: TransferType -> TransferType -> Bool #
Show TransferType Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TransferType -> ShowS # show :: TransferType -> String # showList :: [TransferType] -> ShowS #
ToJSON TransferType Source #
Instance details Defined in Circle.Types Methods toJSON :: TransferType -> Value # toEncoding :: TransferType -> Encoding # toJSONList :: [TransferType] -> Value # toEncodingList :: [TransferType] -> Encoding #
FromJSON TransferType Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferType # parseJSONList :: Value -> Parser [TransferType] #
HasCodec TransferType Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec TransferType # listCodecForStringCompatibility :: JSONCodec [TransferType] #

data TransferErrorCode Source #

Constructors

TransferInsufficientFunds
BlockchainError
TransferDenied
TransferFailed

Instances

Instances details

Eq TransferErrorCode Source #
Instance details Defined in Circle.Types Methods (==) :: TransferErrorCode -> TransferErrorCode -> Bool # (/=) :: TransferErrorCode -> TransferErrorCode -> Bool #
Show TransferErrorCode Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> TransferErrorCode -> ShowS # show :: TransferErrorCode -> String # showList :: [TransferErrorCode] -> ShowS #
ToJSON TransferErrorCode Source #
Instance details Defined in Circle.Types Methods toJSON :: TransferErrorCode -> Value # toEncoding :: TransferErrorCode -> Encoding # toJSONList :: [TransferErrorCode] -> Value # toEncodingList :: [TransferErrorCode] -> Encoding #
FromJSON TransferErrorCode Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferErrorCode # parseJSONList :: Value -> Parser [TransferErrorCode] #
HasCodec TransferErrorCode Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec TransferErrorCode # listCodecForStringCompatibility :: JSONCodec [TransferErrorCode] #

data DepositAddressesRequest Source #

Instances

Instances details

type CircleRequest DepositAddressesRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositAddressesRequest = CircleResponseBody [DepositAddressResponseBody]

data DepositAddressRequest Source #

Instances

Instances details

type CircleRequest DepositAddressRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositAddressRequest = CircleResponseBody DepositAddressResponseBody

data DepositAddressResponseBody Source #

Response body for methods that call the "businessAccount/wallets/addresses/deposit" endpoint

Constructors

DepositAddressResponseBody
Fields depositAddressResponseBodyAddress :: !HexString depositAddressResponseBodyAddressTag :: !(Maybe Text) depositAddressResponseBodyCurrency :: !SupportedCurrencies depositAddressResponseBodyChain :: !Chain

Instances

Instances details

Eq DepositAddressResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: DepositAddressResponseBody -> DepositAddressResponseBody -> Bool # (/=) :: DepositAddressResponseBody -> DepositAddressResponseBody -> Bool #
Show DepositAddressResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DepositAddressResponseBody -> ShowS # show :: DepositAddressResponseBody -> String # showList :: [DepositAddressResponseBody] -> ShowS #
ToJSON DepositAddressResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: DepositAddressResponseBody -> Value # toEncoding :: DepositAddressResponseBody -> Encoding # toJSONList :: [DepositAddressResponseBody] -> Value # toEncodingList :: [DepositAddressResponseBody] -> Encoding #
FromJSON DepositAddressResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DepositAddressResponseBody # parseJSONList :: Value -> Parser [DepositAddressResponseBody] #
HasCodec DepositAddressResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DepositAddressResponseBody # listCodecForStringCompatibility :: JSONCodec [DepositAddressResponseBody] #

data DepositAddressRequestBody Source #

Request body for creating a new deposit address

Constructors

DepositAddressRequestBody
Fields depositAddressRequestBodyIdempotencyKey :: !UUID depositAddressRequestBodyCurrency :: !SupportedCurrencies depositAddressRequestBodyChain :: !Chain

Instances

Instances details

Eq DepositAddressRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: DepositAddressRequestBody -> DepositAddressRequestBody -> Bool # (/=) :: DepositAddressRequestBody -> DepositAddressRequestBody -> Bool #
Show DepositAddressRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DepositAddressRequestBody -> ShowS # show :: DepositAddressRequestBody -> String # showList :: [DepositAddressRequestBody] -> ShowS #
ToJSON DepositAddressRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: DepositAddressRequestBody -> Value # toEncoding :: DepositAddressRequestBody -> Encoding # toJSONList :: [DepositAddressRequestBody] -> Value # toEncodingList :: [DepositAddressRequestBody] -> Encoding #
FromJSON DepositAddressRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DepositAddressRequestBody # parseJSONList :: Value -> Parser [DepositAddressRequestBody] #
HasCodec DepositAddressRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DepositAddressRequestBody # listCodecForStringCompatibility :: JSONCodec [DepositAddressRequestBody] #

data RecipientAddressesRequest Source #

Instances

Instances details

CircleHasParam RecipientAddressesRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam RecipientAddressesRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest RecipientAddressesRequest Source #
Instance details Defined in Circle.Types type CircleRequest RecipientAddressesRequest = CircleResponseBody [RecipientAddressResponseBody]

data RecipientAddressRequest Source #

Instances

Instances details

type CircleRequest RecipientAddressRequest Source #
Instance details Defined in Circle.Types type CircleRequest RecipientAddressRequest = CircleResponseBody RecipientAddressResponseBody

data RecipientAddressResponseBody Source #

Response body for methods that call the "businessAccount/wallets/addresses/recipient" endpoint

Constructors

RecipientAddressResponseBody
Fields recipientAddressResponseBodyId :: !UUID recipientAddressResponseBodyAddress :: !HexString recipientAddressResponseBodyAddressTag :: !(Maybe Text) recipientAddressResponseBodyChain :: !Chain recipientAddressResponseBodyCurrency :: !SupportedCurrencies recipientAddressResponseBodyDescription :: !Text

Instances

Instances details

Eq RecipientAddressResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: RecipientAddressResponseBody -> RecipientAddressResponseBody -> Bool # (/=) :: RecipientAddressResponseBody -> RecipientAddressResponseBody -> Bool #
Show RecipientAddressResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> RecipientAddressResponseBody -> ShowS # show :: RecipientAddressResponseBody -> String # showList :: [RecipientAddressResponseBody] -> ShowS #
ToJSON RecipientAddressResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: RecipientAddressResponseBody -> Value # toEncoding :: RecipientAddressResponseBody -> Encoding # toJSONList :: [RecipientAddressResponseBody] -> Value # toEncodingList :: [RecipientAddressResponseBody] -> Encoding #
FromJSON RecipientAddressResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser RecipientAddressResponseBody # parseJSONList :: Value -> Parser [RecipientAddressResponseBody] #
HasCodec RecipientAddressResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec RecipientAddressResponseBody # listCodecForStringCompatibility :: JSONCodec [RecipientAddressResponseBody] #

data RecipientAddressRequestBody Source #

Request body for creating a new recipient address

Constructors

RecipientAddressRequestBody
Fields recipientAddressRequestBodyIdempotencyKey :: !UUID recipientAddressRequestBodyAddress :: !HexString recipientAddressRequestBodyAddressTag :: !(Maybe Text) recipientAddressRequestBodyChain :: !Chain recipientAddressRequestBodyCurrency :: !SupportedCurrencies recipientAddressRequestBodyDescription :: !Text

Instances

Instances details

Eq RecipientAddressRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: RecipientAddressRequestBody -> RecipientAddressRequestBody -> Bool # (/=) :: RecipientAddressRequestBody -> RecipientAddressRequestBody -> Bool #
Show RecipientAddressRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> RecipientAddressRequestBody -> ShowS # show :: RecipientAddressRequestBody -> String # showList :: [RecipientAddressRequestBody] -> ShowS #
ToJSON RecipientAddressRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: RecipientAddressRequestBody -> Value # toEncoding :: RecipientAddressRequestBody -> Encoding # toJSONList :: [RecipientAddressRequestBody] -> Value # toEncodingList :: [RecipientAddressRequestBody] -> Encoding #
FromJSON RecipientAddressRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser RecipientAddressRequestBody # parseJSONList :: Value -> Parser [RecipientAddressRequestBody] #
HasCodec RecipientAddressRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec RecipientAddressRequestBody # listCodecForStringCompatibility :: JSONCodec [RecipientAddressRequestBody] #

data DepositsRequest Source #

Instances

Instances details

CircleHasParam DepositsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam DepositsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest DepositsRequest Source #
Instance details Defined in Circle.Types type CircleRequest DepositsRequest = CircleResponseBody [DepositResponseBody]

data DepositResponseBody Source #

Response body for methods that call the "businessAccount/deposits" endpoint

Instances

Instances details

Eq DepositResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: DepositResponseBody -> DepositResponseBody -> Bool # (/=) :: DepositResponseBody -> DepositResponseBody -> Bool #
Show DepositResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> DepositResponseBody -> ShowS # show :: DepositResponseBody -> String # showList :: [DepositResponseBody] -> ShowS #
ToJSON DepositResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: DepositResponseBody -> Value # toEncoding :: DepositResponseBody -> Encoding # toJSONList :: [DepositResponseBody] -> Value # toEncodingList :: [DepositResponseBody] -> Encoding #
FromJSON DepositResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser DepositResponseBody # parseJSONList :: Value -> Parser [DepositResponseBody] #
HasCodec DepositResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec DepositResponseBody # listCodecForStringCompatibility :: JSONCodec [DepositResponseBody] #

data MockPaymentRequest Source #

Instances

Instances details

type CircleRequest MockPaymentRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockPaymentRequest = CircleResponseBody MockPaymentResponseBody

data MockPaymentResponseBody Source #

Response body for methods that call the "mock/payments/*" endpoint

Constructors

MockPaymentResponseBody
Fields mockPaymentResponseBodyTrackingRef :: !(Maybe TrackingReference) mockPaymentResponseBodyAmount :: !(Maybe MoneyAmount) mockPaymentResponseBodyBeneficiaryBank :: !(Maybe BeneficiaryBankDetails) mockPaymentResponseBodyStatus :: !(Maybe Status)

Instances

Instances details

Eq MockPaymentResponseBody Source #
Instance details Defined in Circle.Types Methods (==) :: MockPaymentResponseBody -> MockPaymentResponseBody -> Bool # (/=) :: MockPaymentResponseBody -> MockPaymentResponseBody -> Bool #
Show MockPaymentResponseBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> MockPaymentResponseBody -> ShowS # show :: MockPaymentResponseBody -> String # showList :: [MockPaymentResponseBody] -> ShowS #
ToJSON MockPaymentResponseBody Source #
Instance details Defined in Circle.Types Methods toJSON :: MockPaymentResponseBody -> Value # toEncoding :: MockPaymentResponseBody -> Encoding # toJSONList :: [MockPaymentResponseBody] -> Value # toEncodingList :: [MockPaymentResponseBody] -> Encoding #
FromJSON MockPaymentResponseBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser MockPaymentResponseBody # parseJSONList :: Value -> Parser [MockPaymentResponseBody] #
HasCodec MockPaymentResponseBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec MockPaymentResponseBody # listCodecForStringCompatibility :: JSONCodec [MockPaymentResponseBody] #

data MockSenOrWirePaymentRequestBody Source #

Request body to create a mock SEN or Wire payment (in the sandbox only).

Constructors

MockSenOrWirePaymentRequestBody
Fields mockSenOrWirePaymentRequestBodyTrackingRef :: !TrackingReference mockSenOrWirePaymentRequestBodyAmount :: !MoneyAmount mockSenOrWirePaymentRequestBodyBeneficiaryBank :: !MockBeneficiaryBankDetails

Instances

Instances details

Eq MockSenOrWirePaymentRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: MockSenOrWirePaymentRequestBody -> MockSenOrWirePaymentRequestBody -> Bool # (/=) :: MockSenOrWirePaymentRequestBody -> MockSenOrWirePaymentRequestBody -> Bool #
Show MockSenOrWirePaymentRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> MockSenOrWirePaymentRequestBody -> ShowS # show :: MockSenOrWirePaymentRequestBody -> String # showList :: [MockSenOrWirePaymentRequestBody] -> ShowS #
ToJSON MockSenOrWirePaymentRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: MockSenOrWirePaymentRequestBody -> Value # toEncoding :: MockSenOrWirePaymentRequestBody -> Encoding # toJSONList :: [MockSenOrWirePaymentRequestBody] -> Value # toEncodingList :: [MockSenOrWirePaymentRequestBody] -> Encoding #
FromJSON MockSenOrWirePaymentRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser MockSenOrWirePaymentRequestBody # parseJSONList :: Value -> Parser [MockSenOrWirePaymentRequestBody] #
HasCodec MockSenOrWirePaymentRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec MockSenOrWirePaymentRequestBody # listCodecForStringCompatibility :: JSONCodec [MockSenOrWirePaymentRequestBody] #

data MockSEPAPaymentRequestBody Source #

Request body to create a mock SEPA payment (in the sandbox only).

Constructors

MockSEPAPaymentRequestBody
Fields mockSEPAPaymentRequestBodyTrackingRef :: !TrackingReference mockSEPAPaymentRequestBodyAmount :: !MoneyAmount

Instances

Instances details

Eq MockSEPAPaymentRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: MockSEPAPaymentRequestBody -> MockSEPAPaymentRequestBody -> Bool # (/=) :: MockSEPAPaymentRequestBody -> MockSEPAPaymentRequestBody -> Bool #
Show MockSEPAPaymentRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> MockSEPAPaymentRequestBody -> ShowS # show :: MockSEPAPaymentRequestBody -> String # showList :: [MockSEPAPaymentRequestBody] -> ShowS #
ToJSON MockSEPAPaymentRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: MockSEPAPaymentRequestBody -> Value # toEncoding :: MockSEPAPaymentRequestBody -> Encoding # toJSONList :: [MockSEPAPaymentRequestBody] -> Value # toEncodingList :: [MockSEPAPaymentRequestBody] -> Encoding #
FromJSON MockSEPAPaymentRequestBody Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser MockSEPAPaymentRequestBody # parseJSONList :: Value -> Parser [MockSEPAPaymentRequestBody] #
HasCodec MockSEPAPaymentRequestBody Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec MockSEPAPaymentRequestBody # listCodecForStringCompatibility :: JSONCodec [MockSEPAPaymentRequestBody] #

newtype MockBeneficiaryBankDetails Source #

Constructors

MockBeneficiaryBankDetails
Fields mockBeneficiaryBankDetailsAccountNumber :: AccountNumber

Instances

Instances details

Eq MockBeneficiaryBankDetails Source #
Instance details Defined in Circle.Types Methods (==) :: MockBeneficiaryBankDetails -> MockBeneficiaryBankDetails -> Bool # (/=) :: MockBeneficiaryBankDetails -> MockBeneficiaryBankDetails -> Bool #
Show MockBeneficiaryBankDetails Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> MockBeneficiaryBankDetails -> ShowS # show :: MockBeneficiaryBankDetails -> String # showList :: [MockBeneficiaryBankDetails] -> ShowS #
ToJSON MockBeneficiaryBankDetails Source #
Instance details Defined in Circle.Types Methods toJSON :: MockBeneficiaryBankDetails -> Value # toEncoding :: MockBeneficiaryBankDetails -> Encoding # toJSONList :: [MockBeneficiaryBankDetails] -> Value # toEncodingList :: [MockBeneficiaryBankDetails] -> Encoding #
FromJSON MockBeneficiaryBankDetails Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser MockBeneficiaryBankDetails # parseJSONList :: Value -> Parser [MockBeneficiaryBankDetails] #
HasCodec MockBeneficiaryBankDetails Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec MockBeneficiaryBankDetails # listCodecForStringCompatibility :: JSONCodec [MockBeneficiaryBankDetails] #

data SENAccountRequest Source #

Instances

Instances details

type CircleRequest SENAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENAccountRequest = CircleResponseBody SENAccountResponseBody

data SENAccountsRequest Source #

Instances

Instances details

type CircleRequest SENAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENAccountsRequest = CircleResponseBody [SENAccountResponseBody]

data SENInstructionsRequest Source #

Instances

Instances details

type CircleRequest SENInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SENInstructionsRequest = CircleResponseBody SENInstructionsResponseData

data SENAccountRequestBody Source #

Request body to create a Silvergate SEN account.

Constructors

SENAccountRequestBody
Fields senAccountRequestBodyIdempotencyKey :: !UUID senAccountRequestBodyAccountNumber :: !AccountNumber senAccountRequestBodyCurrency :: !(Maybe SupportedCurrencies)

Instances

Instances details

Eq SENAccountRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: SENAccountRequestBody -> SENAccountRequestBody -> Bool # (/=) :: SENAccountRequestBody -> SENAccountRequestBody -> Bool #
Show