| Copyright | (c) Dylan Martin 2022 |
|---|---|
| Maintainer | dmarticus@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Circle.Types
Contents
Synopsis
- newtype ApiToken = ApiToken {}
- data CircleAPIRequest a b c = CircleAPIRequest {}
- 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 {}
- newtype ResponseStatus = ResponseStatus {}
- newtype ResponseMessage = ResponseMessage {}
- type Reply = Response ByteString
- type Method = Method
- type Host = Text
- data CircleHost
- 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 {}
- 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 {}
- data PaginationQueryParam
- = PageBefore !Text
- | PageAfter !Text
- newtype FromQueryParam = FromQueryParam {}
- newtype ToQueryParam = ToQueryParam {}
- newtype PageSizeQueryParam = PageSizeQueryParam {}
- newtype StatusQueryParams = StatusQueryParams {
- statusQueryParams :: [Status]
- statusToBS8 :: Status -> ByteString
- newtype DestinationQueryParam = DestinationQueryParam {}
- newtype TypeQueryParam = TypeQueryParam {}
- bankAccountTypeToBS8 :: BankAccountType -> ByteString
- newtype CurrencyQueryParam = CurrencyQueryParam {}
- currencyToBS8 :: SupportedCurrencies -> ByteString
- newtype SourceQueryParam = SourceQueryParam {}
- newtype SettlementIdQueryParam = SettlementIdQueryParam {}
- newtype PaymentIntentIdQueryParam = PaymentIntentIdQueryParam {}
- newtype PaymentIdQueryParam = PaymentIdQueryParam {}
- newtype PaymentStatusQueryParams = PaymentStatusQueryParams {}
- paymentStatusToBS8 :: PaymentStatus -> ByteString
- newtype PaymentIntentContextQueryParams = PaymentIntentContextQueryParams {}
- paymentIntentContextToBS8 :: PaymentIntentContext -> ByteString
- newtype WalletIdQueryParam = WalletIdQueryParam {}
- newtype SourceWalletIdQueryParam = SourceWalletIdQueryParam {}
- newtype DestinationWalletIdQueryParam = DestinationWalletIdQueryParam {}
- newtype ReturnIdentitiesQueryParam = ReturnIdentitiesQueryParam {}
- data BalanceRequest
- data BalanceResponseBody = BalanceResponseBody {}
- 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 {}
- newtype PayoutMetadata = PayoutMetadata {}
- data PayoutRequestBody = PayoutRequestBody {}
- data PayoutReturnResponseBody = PayoutReturnResponseBody {
- payoutReturnResponseBodyId :: !UUID
- payoutReturnResponseBodyOriginalPayoutId :: !UUID
- payoutReturnResponseBodyAmount :: !MoneyAmount
- payoutReturnResponseBodyFees :: !MoneyAmount
- payoutReturnResponseBodyReason :: !Text
- payoutReturnResponseBodyStatus :: !Status
- payoutReturnResponseBodyCreateDate :: !UTCTime
- payoutReturnResponseBodyUpdateDate :: !UTCTime
- data PayoutErrorCode
- data ConfigurationRequest
- newtype ConfigurationResponseBody = ConfigurationResponseBody {}
- newtype WalletConfig = WalletConfig {}
- data EncryptionRequest
- data EncryptionResponseBody = EncryptionResponseBody {}
- newtype PGPKey = PGPKey {}
- data ChannelsRequest
- newtype ChannelResponseBody = ChannelResponseBody {}
- data Channel = Channel {
- channelId :: !UUID
- channelDefault :: !Bool
- channelCardDescriptor :: !Text
- channelAchDescriptor :: !Text
- data StablecoinsRequest
- data StablecoinResponseBody = StablecoinResponseBody {}
- data ChainAmount = ChainAmount {}
- data Chain
- data Stablecoin
- data SubscriptionsRequest
- data SubscriptionRequest
- data SubscriptionResponseBody = SubscriptionResponseBody {}
- data SubscriptionDetails = SubscriptionDetails {}
- newtype SubscriptionRequestBody = SubscriptionRequestBody {}
- data TransfersRequest
- data TransferRequest
- data BusinessTransferRequestBody = BusinessTransferRequestBody {}
- data TransferRequestBody = TransferRequestBody {}
- data TransferDestination = TransferDestination {}
- 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 {}
- data SourceBlockchain = SourceBlockchain {}
- data DestinationWallet = DestinationWallet {}
- data DestinationBlockchain = DestinationBlockchain {}
- data Identity = Identity {
- identityType :: !IdentityType
- identityName :: !Text
- identityAddresses :: ![Address]
- data IdentityType
- data TransferType
- = Wallet
- | Blockchain
- data TransferErrorCode
- data DepositAddressesRequest
- data DepositAddressRequest
- data DepositAddressResponseBody = DepositAddressResponseBody {}
- data DepositAddressRequestBody = DepositAddressRequestBody {}
- data RecipientAddressesRequest
- data RecipientAddressRequest
- data RecipientAddressResponseBody = RecipientAddressResponseBody {}
- 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 {}
- data MockSenOrWirePaymentRequestBody = MockSenOrWirePaymentRequestBody {}
- data MockSEPAPaymentRequestBody = MockSEPAPaymentRequestBody {}
- newtype MockBeneficiaryBankDetails = MockBeneficiaryBankDetails {}
- data SENAccountRequest
- data SENAccountsRequest
- data SENInstructionsRequest
- data SENAccountRequestBody = SENAccountRequestBody {}
- data SENAccountResponseBody = SENAccountResponseBody {
- senAccountResponseBodyId :: !UUID
- senAccountResponseBodyStatus :: !Status
- senAccountResponseBodyDescription :: !Text
- senAccountResponseBodyTrackingRef :: !TrackingReference
- senAccountResponseBodyCreateDate :: !UTCTime
- senAccountResponseBodyUpdateDate :: !UTCTime
- senAccountResponseBodyCurrency :: !(Maybe SupportedCurrencies)
- data SENInstructionsResponseData = SENInstructionsResponseData {}
- data SignetBankAccountRequest
- data SignetBankAccountsRequest
- data SignetBankInstructionsRequest
- data SignetBankAccountRequestBody = SignetBankAccountRequestBody {}
- data SignetBankAccountResponseData = SignetBankAccountResponseData {}
- data SignetBankInstructionsResponseData = SignetBankInstructionsResponseData {}
- data WireAccountRequest
- data WireAccountsRequest
- data WireInstructionsRequest
- data WireAccountRequestBody
- data USBankAccountRequestBody = USBankAccountRequestBody {}
- data IBANBankAccountRequestBody = IBANBankAccountRequestBody {}
- data NonIBANBankAccountRequestBody = NonIBANBankAccountRequestBody {}
- data WireInstructionsResponseData = WireInstructionsResponseData {}
- 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 {}
- newtype SessionId = SessionId {
- unSessionId :: Text
- newtype IPAddress = IPAddress {
- unIPAddress :: Text
- newtype PhoneNumber = PhoneNumber {}
- 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 {}
- data VerificationData = VerificationData {
- verificationAVS :: !AVS
- verificationCVV :: !CVV
- data AVS
- = AVSNotRequested
- | AVSPending
- | Y
- | N
- data CVV
- data PaymentDepositAddress = PaymentDepositAddress {}
- 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 {}
- data PaymentActionRequired = PaymentActionRequired {}
- data ActionRequiredType = ThreeDSecureRequired
- data VerificationType
- data PaymentType
- data PaymentSourceType
- = Card
- | ACH
- | WireSource
- | SEPA
- data CancelPaymentRequestBody = CancelPaymentRequestBody {}
- data CancelPaymentReason
- data RefundPaymentRequestBody = RefundPaymentRequestBody {}
- data OnChainTransferRequest
- data OnChainTransfersRequest
- data OnChainAddressRequest
- data OnChainTransferRequestBody = OnChainTransferRequestBody {}
- 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 {}
- data UpdateCardRequestBody = UpdateCardRequestBody {
- updateCardKeyId :: !(Maybe Text)
- updateCardEncryptedData :: !(Maybe Text)
- updateCardExpiryMonth :: !Int
- updateCardExpiryYear :: !Int
- data ListCardBillingDetails = ListCardBillingDetails {}
- data CardNetwork
- = VISA
- | MASTERCARD
- | AMEX
- | UNKNOWN
- data CardFundingType
- 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
- data CreateACHBankAccountRequestBody = CreateACHBankAccountRequestBody {}
- data MockAccountRequest
- data CreateMockACHBankAccountRequestBody = CreateMockACHBankAccountRequestBody {}
- data MockACHBankAccountResponseBody = MockACHBankAccountResponseBody {}
- data MockACHBankAccount = MockACHBankAccount {}
- data MockRoutingNumber
- data SEPAAccountRequest
- data SEPAInstructionsRequest
- data SEPAAccountRequestBody = SEPAAccountRequestBody {}
- 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 {}
- data ChargebackCategory
- data ChargebackHistory = ChargebackHistory {}
- data ChargebackHistoryType
- 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 {}
- 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 {}
- data TimelineData = TimelineData {}
- data ReturnsRequest
- data WalletRequest
- data WalletsRequest
- data WalletResponseBody = WalletResponseBody {}
- data CreateWalletRequestBody = CreateWalletRequestBody {}
- utcToCircle :: UTCTime -> Text
- tshow :: Show a => a -> Text
- data ThisOrThat a 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
- data PaymentStatus
- data PaymentIntentStatus
- data PaymentIntentContext
- data Address = Address {
- addressCity :: !(Maybe City)
- addressCountry :: !(Maybe ISO3166Alpha2)
- addressLine1 :: !(Maybe AddressLine)
- addressLine2 :: !(Maybe AddressLine)
- addressDistrict :: !(Maybe District)
- data BankAccountType
- data ACHBankAccountType
- data DestinationBankAccount = DestinationBankAccount {}
- data SupportedCurrencies
- newtype Amount = Amount {}
- data BlockchainFeeType
- data BlockchainFeeMoneyAmount = BlockchainFeeMoneyAmount {}
- data MoneyAmount = MoneyAmount {}
- data TransferFeeAmount = TransferFeeAmount {}
- data Decision
- data RiskEvaluation = RiskEvaluation {}
- data Adjustments = Adjustments {}
- data BillingDetails = BillingDetails {}
- data BankAddress = BankAddress {
- bankAddressName :: !(Maybe Text)
- bankAddressCity :: !(Maybe City)
- bankAddressCountry :: !(Maybe ISO3166Alpha2)
- bankAddressLine1 :: !(Maybe AddressLine)
- bankAddressLine2 :: !(Maybe AddressLine)
- bankAddressDistrict :: !(Maybe District)
- data BeneficiaryDetails = BeneficiaryDetails {}
- data BeneficiaryBankDetails = BeneficiaryBankDetails {
- beneficiaryBankDetailsName :: !Text
- beneficiaryBankDetailsSwiftCode :: !SwiftCode
- beneficiaryBankDetailsRoutingNumber :: !RoutingNumber
- beneficiaryBankDetailsAccountNumber :: !AccountNumber
- beneficiaryBankDetailsCurrency :: !SupportedCurrencies
- beneficiaryBankDetailsAddress :: !AddressLine
- beneficiaryBankDetailsCity :: !City
- beneficiaryBankDetailsPostalCode :: !PostalCode
- beneficiaryBankDetailsCountry :: !ISO3166Alpha2
- newtype ProcessorToken = ProcessorToken {}
- newtype AddressLine = AddressLine {}
- newtype URL = URL {}
- urlRegex :: Regex
- mkURL :: Text -> Maybe URL
- urlToText :: URL -> Text
- urlToByteString :: URL -> ByteString
- newtype AccountNumber = AccountNumber {}
- 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 {}
- routingNumberRegex :: Regex
- mkRoutingNumber :: Text -> Maybe RoutingNumber
- routingNumberToText :: RoutingNumber -> Text
- routingNumberToByteString :: RoutingNumber -> ByteString
- compileRoutingNumber :: QuasiQuoter
- newtype Iban = Iban {}
- 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 {}
- 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 {}
- newtype TrackingReference = TrackingReference {}
- newtype HexString = HexString {
- unHexString :: Text
- newtype WalletId = WalletId {
- unWalletId :: Text
Documentation
Token type used for HTTP Bearer authentication.
Constructors
| ApiToken | |
Fields | |
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 | |
Instances
| Show (CircleAPIRequest a b c) Source # | |
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
data CircleError Source #
CircleErrors have contain both the error reason (parseError) and the
full error response body as a ByteString.
Constructors
| CircleError | |
Fields
| |
Instances
| Show CircleError Source # | |
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
| |
Instances
| Eq a => Eq (CircleResponseBody a) Source # | |
Defined in Circle.Types Methods (==) :: CircleResponseBody a -> CircleResponseBody a -> Bool # (/=) :: CircleResponseBody a -> CircleResponseBody a -> Bool # | |
| Show a => Show (CircleResponseBody a) Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CircleResponseBody a -> ShowS # show :: CircleResponseBody a -> String # showList :: [CircleResponseBody a] -> ShowS # | |
| FromJSON a => FromJSON (CircleResponseBody a) Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser (CircleResponseBody a) # parseJSONList :: Value -> Parser [CircleResponseBody a] # | |
newtype ResponseStatus Source #
Constructors
| ResponseStatus | |
Fields | |
Instances
| Eq ResponseStatus Source # | |
Defined in Circle.Types Methods (==) :: ResponseStatus -> ResponseStatus -> Bool # (/=) :: ResponseStatus -> ResponseStatus -> Bool # | |
| Show ResponseStatus Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ResponseStatus -> ShowS # show :: ResponseStatus -> String # showList :: [ResponseStatus] -> ShowS # | |
| FromJSON ResponseStatus Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ResponseStatus # parseJSONList :: Value -> Parser [ResponseStatus] # | |
| HasCodec ResponseStatus Source # | |
Defined in Circle.Types Methods codec :: JSONCodec ResponseStatus # listCodecForStringCompatibility :: JSONCodec [ResponseStatus] # | |
newtype ResponseMessage Source #
Constructors
| ResponseMessage | |
Fields | |
Instances
| Eq ResponseMessage Source # | |
Defined in Circle.Types Methods (==) :: ResponseMessage -> ResponseMessage -> Bool # (/=) :: ResponseMessage -> ResponseMessage -> Bool # | |
| Show ResponseMessage Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ResponseMessage -> ShowS # show :: ResponseMessage -> String # showList :: [ResponseMessage] -> ShowS # | |
| FromJSON ResponseMessage Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ResponseMessage # parseJSONList :: Value -> Parser [ResponseMessage] # | |
| HasCodec ResponseMessage Source # | |
Defined in Circle.Types | |
type Reply = Response ByteString Source #
data CircleHost Source #
Constructors
| CircleProduction | |
| CircleSandbox |
Instances
| Eq CircleHost Source # | |
Defined in Circle.Types | |
| Show CircleHost Source # | |
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
| |
Instances
| Eq CircleConfig Source # | |
Defined in Circle.Types | |
| Show CircleConfig Source # | |
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 @
Constructors
| Body | |
Fields
| |
Parameters for each request which include both the query and the body of a request
Constructors
| Params | |
Fields
| |
type TupleBS8 = (ByteString, ByteString) Source #
Type alias for query parameters
class ToCircleParam param where Source #
Convert a parameter to a key/value
Instances
class ToCircleParam param => CircleHasParam request param Source #
Instances
(-&-) :: 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 | |
Instances
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
| Eq PaginationQueryParam Source # | |
Defined in Circle.Types Methods (==) :: PaginationQueryParam -> PaginationQueryParam -> Bool # (/=) :: PaginationQueryParam -> PaginationQueryParam -> Bool # | |
| Show PaginationQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaginationQueryParam -> ShowS # show :: PaginationQueryParam -> String # showList :: [PaginationQueryParam] -> ShowS # | |
newtype FromQueryParam Source #
Constructors
| FromQueryParam | |
Fields | |
Instances
newtype ToQueryParam Source #
Constructors
| ToQueryParam | |
Fields | |
Instances
newtype PageSizeQueryParam Source #
Constructors
| PageSizeQueryParam | |
Fields | |
Instances
newtype StatusQueryParams Source #
Constructors
| StatusQueryParams | |
Fields
| |
Instances
| Eq StatusQueryParams Source # | |
Defined in Circle.Types Methods (==) :: StatusQueryParams -> StatusQueryParams -> Bool # (/=) :: StatusQueryParams -> StatusQueryParams -> Bool # | |
| Show StatusQueryParams Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> StatusQueryParams -> ShowS # show :: StatusQueryParams -> String # showList :: [StatusQueryParams] -> ShowS # | |
| ToCircleParam StatusQueryParams Source # | |
Defined in Circle.Types Methods toCircleParam :: StatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PayoutsRequest StatusQueryParams Source # | |
Defined in Circle.Types | |
statusToBS8 :: Status -> ByteString Source #
newtype DestinationQueryParam Source #
Constructors
| DestinationQueryParam | |
Fields | |
Instances
| Eq DestinationQueryParam Source # | |
Defined in Circle.Types Methods (==) :: DestinationQueryParam -> DestinationQueryParam -> Bool # (/=) :: DestinationQueryParam -> DestinationQueryParam -> Bool # | |
| Show DestinationQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationQueryParam -> ShowS # show :: DestinationQueryParam -> String # showList :: [DestinationQueryParam] -> ShowS # | |
| ToCircleParam DestinationQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: DestinationQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentsRequest DestinationQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest DestinationQueryParam Source # | |
Defined in Circle.Types | |
newtype TypeQueryParam Source #
Constructors
| TypeQueryParam | |
Fields | |
Instances
| Eq TypeQueryParam Source # | |
Defined in Circle.Types Methods (==) :: TypeQueryParam -> TypeQueryParam -> Bool # (/=) :: TypeQueryParam -> TypeQueryParam -> Bool # | |
| Show TypeQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TypeQueryParam -> ShowS # show :: TypeQueryParam -> String # showList :: [TypeQueryParam] -> ShowS # | |
| ToCircleParam TypeQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: TypeQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam DepositsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
newtype CurrencyQueryParam Source #
Constructors
| CurrencyQueryParam | |
Fields | |
Instances
| Eq CurrencyQueryParam Source # | |
Defined in Circle.Types Methods (==) :: CurrencyQueryParam -> CurrencyQueryParam -> Bool # (/=) :: CurrencyQueryParam -> CurrencyQueryParam -> Bool # | |
| Show CurrencyQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CurrencyQueryParam -> ShowS # show :: CurrencyQueryParam -> String # showList :: [CurrencyQueryParam] -> ShowS # | |
| ToCircleParam CurrencyQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: CurrencyQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
newtype SourceQueryParam Source #
Constructors
| SourceQueryParam | |
Fields | |
Instances
| Eq SourceQueryParam Source # | |
Defined in Circle.Types Methods (==) :: SourceQueryParam -> SourceQueryParam -> Bool # (/=) :: SourceQueryParam -> SourceQueryParam -> Bool # | |
| Show SourceQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SourceQueryParam -> ShowS # show :: SourceQueryParam -> String # showList :: [SourceQueryParam] -> ShowS # | |
| ToCircleParam SourceQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: SourceQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentsRequest SourceQueryParam Source # | |
Defined in Circle.Types | |
newtype SettlementIdQueryParam Source #
Constructors
| SettlementIdQueryParam | |
Fields | |
Instances
| Eq SettlementIdQueryParam Source # | |
Defined in Circle.Types Methods (==) :: SettlementIdQueryParam -> SettlementIdQueryParam -> Bool # (/=) :: SettlementIdQueryParam -> SettlementIdQueryParam -> Bool # | |
| Show SettlementIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SettlementIdQueryParam -> ShowS # show :: SettlementIdQueryParam -> String # showList :: [SettlementIdQueryParam] -> ShowS # | |
| ToCircleParam SettlementIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: SettlementIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentsRequest SettlementIdQueryParam Source # | |
Defined in Circle.Types | |
newtype PaymentIntentIdQueryParam Source #
Constructors
| PaymentIntentIdQueryParam | |
Fields | |
Instances
| Eq PaymentIntentIdQueryParam Source # | |
Defined in Circle.Types Methods (==) :: PaymentIntentIdQueryParam -> PaymentIntentIdQueryParam -> Bool # (/=) :: PaymentIntentIdQueryParam -> PaymentIntentIdQueryParam -> Bool # | |
| Show PaymentIntentIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentIdQueryParam -> ShowS # show :: PaymentIntentIdQueryParam -> String # showList :: [PaymentIntentIdQueryParam] -> ShowS # | |
| ToCircleParam PaymentIntentIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: PaymentIntentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentsRequest PaymentIntentIdQueryParam Source # | |
Defined in Circle.Types | |
newtype PaymentIdQueryParam Source #
Constructors
| PaymentIdQueryParam | |
Fields | |
Instances
| Eq PaymentIdQueryParam Source # | |
Defined in Circle.Types Methods (==) :: PaymentIdQueryParam -> PaymentIdQueryParam -> Bool # (/=) :: PaymentIdQueryParam -> PaymentIdQueryParam -> Bool # | |
| Show PaymentIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIdQueryParam -> ShowS # show :: PaymentIdQueryParam -> String # showList :: [PaymentIdQueryParam] -> ShowS # | |
| ToCircleParam PaymentIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: PaymentIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam ChargebacksRequest PaymentIdQueryParam Source # | |
Defined in Circle.Types | |
newtype PaymentStatusQueryParams Source #
Constructors
| PaymentStatusQueryParams | |
Fields | |
Instances
| Eq PaymentStatusQueryParams Source # | |
Defined in Circle.Types Methods (==) :: PaymentStatusQueryParams -> PaymentStatusQueryParams -> Bool # (/=) :: PaymentStatusQueryParams -> PaymentStatusQueryParams -> Bool # | |
| Show PaymentStatusQueryParams Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentStatusQueryParams -> ShowS # show :: PaymentStatusQueryParams -> String # showList :: [PaymentStatusQueryParams] -> ShowS # | |
| ToCircleParam PaymentStatusQueryParams Source # | |
Defined in Circle.Types Methods toCircleParam :: PaymentStatusQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentIntentsRequest PaymentStatusQueryParams Source # | |
Defined in Circle.Types | |
| CircleHasParam ReversalsRequest PaymentStatusQueryParams Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest PaymentStatusQueryParams Source # | |
Defined in Circle.Types | |
newtype PaymentIntentContextQueryParams Source #
Constructors
| PaymentIntentContextQueryParams | |
Instances
| Eq PaymentIntentContextQueryParams Source # | |
Defined in Circle.Types | |
| Show PaymentIntentContextQueryParams Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentContextQueryParams -> ShowS # | |
| ToCircleParam PaymentIntentContextQueryParams Source # | |
Defined in Circle.Types Methods toCircleParam :: PaymentIntentContextQueryParams -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam PaymentIntentsRequest PaymentIntentContextQueryParams Source # | |
Defined in Circle.Types | |
newtype WalletIdQueryParam Source #
Constructors
| WalletIdQueryParam | |
Fields | |
Instances
| Eq WalletIdQueryParam Source # | |
Defined in Circle.Types Methods (==) :: WalletIdQueryParam -> WalletIdQueryParam -> Bool # (/=) :: WalletIdQueryParam -> WalletIdQueryParam -> Bool # | |
| Show WalletIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> WalletIdQueryParam -> ShowS # show :: WalletIdQueryParam -> String # showList :: [WalletIdQueryParam] -> ShowS # | |
| ToCircleParam WalletIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: WalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam OnChainTransfersRequest WalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest WalletIdQueryParam Source # | |
Defined in Circle.Types | |
newtype SourceWalletIdQueryParam Source #
Constructors
| SourceWalletIdQueryParam | |
Fields | |
Instances
| Eq SourceWalletIdQueryParam Source # | |
Defined in Circle.Types Methods (==) :: SourceWalletIdQueryParam -> SourceWalletIdQueryParam -> Bool # (/=) :: SourceWalletIdQueryParam -> SourceWalletIdQueryParam -> Bool # | |
| Show SourceWalletIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SourceWalletIdQueryParam -> ShowS # show :: SourceWalletIdQueryParam -> String # showList :: [SourceWalletIdQueryParam] -> ShowS # | |
| ToCircleParam SourceWalletIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: SourceWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam OnChainTransfersRequest SourceWalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest SourceWalletIdQueryParam Source # | |
Defined in Circle.Types | |
newtype DestinationWalletIdQueryParam Source #
Constructors
| DestinationWalletIdQueryParam | |
Fields | |
Instances
| Eq DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types | |
| Show DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationWalletIdQueryParam -> ShowS # show :: DestinationWalletIdQueryParam -> String # showList :: [DestinationWalletIdQueryParam] -> ShowS # | |
| ToCircleParam DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types Methods toCircleParam :: DestinationWalletIdQueryParam -> Params TupleBS8 c -> Params TupleBS8 c Source # | |
| CircleHasParam OnChainTransfersRequest DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types | |
newtype ReturnIdentitiesQueryParam Source #
Constructors
| ReturnIdentitiesQueryParam | |
Fields | |
Instances
data BalanceRequest Source #
Instances
| type CircleRequest BalanceRequest Source # | |
Defined in Circle.Types | |
data BalanceResponseBody Source #
Response body for the "businessAccount/balances" and "/balances" endpoints
Constructors
| BalanceResponseBody | |
Fields | |
Instances
data PayoutRequest Source #
Instances
| type CircleRequest PayoutRequest Source # | |
Defined in Circle.Types | |
data PayoutsRequest Source #
Instances
| CircleHasParam PayoutsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest DestinationQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest StatusQueryParams Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PayoutsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest PayoutsRequest Source # | |
Defined in Circle.Types | |
data PayoutResponseBody Source #
Response body for methods that call "businessAccount/payouts" or "payouts" endpoints
Constructors
Instances
| Eq PayoutResponseBody Source # | |
Defined in Circle.Types Methods (==) :: PayoutResponseBody -> PayoutResponseBody -> Bool # (/=) :: PayoutResponseBody -> PayoutResponseBody -> Bool # | |
| Show PayoutResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PayoutResponseBody -> ShowS # show :: PayoutResponseBody -> String # showList :: [PayoutResponseBody] -> ShowS # | |
| ToJSON PayoutResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: PayoutResponseBody -> Value # toEncoding :: PayoutResponseBody -> Encoding # toJSONList :: [PayoutResponseBody] -> Value # toEncodingList :: [PayoutResponseBody] -> Encoding # | |
| FromJSON PayoutResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutResponseBody # parseJSONList :: Value -> Parser [PayoutResponseBody] # | |
| HasCodec PayoutResponseBody Source # | |
Defined in Circle.Types | |
data BusinessPayoutRequestBody Source #
Request body for creating a new business account payout
Constructors
| BusinessPayoutRequestBody | |
Instances
| Eq BusinessPayoutRequestBody Source # | |
Defined in Circle.Types Methods (==) :: BusinessPayoutRequestBody -> BusinessPayoutRequestBody -> Bool # (/=) :: BusinessPayoutRequestBody -> BusinessPayoutRequestBody -> Bool # | |
| Show BusinessPayoutRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BusinessPayoutRequestBody -> ShowS # show :: BusinessPayoutRequestBody -> String # showList :: [BusinessPayoutRequestBody] -> ShowS # | |
| ToJSON BusinessPayoutRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: BusinessPayoutRequestBody -> Value # toEncoding :: BusinessPayoutRequestBody -> Encoding # toJSONList :: [BusinessPayoutRequestBody] -> Value # | |
| FromJSON BusinessPayoutRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser BusinessPayoutRequestBody # parseJSONList :: Value -> Parser [BusinessPayoutRequestBody] # | |
| HasCodec BusinessPayoutRequestBody Source # | |
Defined in Circle.Types | |
newtype PayoutMetadata Source #
Constructors
| PayoutMetadata | |
Fields | |
Instances
| Eq PayoutMetadata Source # | |
Defined in Circle.Types Methods (==) :: PayoutMetadata -> PayoutMetadata -> Bool # (/=) :: PayoutMetadata -> PayoutMetadata -> Bool # | |
| Show PayoutMetadata Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PayoutMetadata -> ShowS # show :: PayoutMetadata -> String # showList :: [PayoutMetadata] -> ShowS # | |
| ToJSON PayoutMetadata Source # | |
Defined in Circle.Types Methods toJSON :: PayoutMetadata -> Value # toEncoding :: PayoutMetadata -> Encoding # toJSONList :: [PayoutMetadata] -> Value # toEncodingList :: [PayoutMetadata] -> Encoding # | |
| FromJSON PayoutMetadata Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutMetadata # parseJSONList :: Value -> Parser [PayoutMetadata] # | |
| HasCodec PayoutMetadata Source # | |
Defined in Circle.Types Methods codec :: JSONCodec PayoutMetadata # listCodecForStringCompatibility :: JSONCodec [PayoutMetadata] # | |
data PayoutRequestBody Source #
Request body to create a payout.
Constructors
| PayoutRequestBody | |
Fields | |
Instances
| Eq PayoutRequestBody Source # | |
Defined in Circle.Types Methods (==) :: PayoutRequestBody -> PayoutRequestBody -> Bool # (/=) :: PayoutRequestBody -> PayoutRequestBody -> Bool # | |
| Show PayoutRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PayoutRequestBody -> ShowS # show :: PayoutRequestBody -> String # showList :: [PayoutRequestBody] -> ShowS # | |
| ToJSON PayoutRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: PayoutRequestBody -> Value # toEncoding :: PayoutRequestBody -> Encoding # toJSONList :: [PayoutRequestBody] -> Value # toEncodingList :: [PayoutRequestBody] -> Encoding # | |
| FromJSON PayoutRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutRequestBody # parseJSONList :: Value -> Parser [PayoutRequestBody] # | |
| HasCodec PayoutRequestBody Source # | |
Defined in Circle.Types | |
data PayoutReturnResponseBody Source #
Response body for methods that call the "returns" endpoint
Constructors
Instances
| Eq PayoutReturnResponseBody Source # | |
Defined in Circle.Types Methods (==) :: PayoutReturnResponseBody -> PayoutReturnResponseBody -> Bool # (/=) :: PayoutReturnResponseBody -> PayoutReturnResponseBody -> Bool # | |
| Show PayoutReturnResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PayoutReturnResponseBody -> ShowS # show :: PayoutReturnResponseBody -> String # showList :: [PayoutReturnResponseBody] -> ShowS # | |
| ToJSON PayoutReturnResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: PayoutReturnResponseBody -> Value # toEncoding :: PayoutReturnResponseBody -> Encoding # toJSONList :: [PayoutReturnResponseBody] -> Value # | |
| FromJSON PayoutReturnResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutReturnResponseBody # parseJSONList :: Value -> Parser [PayoutReturnResponseBody] # | |
| HasCodec PayoutReturnResponseBody Source # | |
Defined in Circle.Types | |
data PayoutErrorCode Source #
Constructors
Instances
| Eq PayoutErrorCode Source # | |
Defined in Circle.Types Methods (==) :: PayoutErrorCode -> PayoutErrorCode -> Bool # (/=) :: PayoutErrorCode -> PayoutErrorCode -> Bool # | |
| Show PayoutErrorCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PayoutErrorCode -> ShowS # show :: PayoutErrorCode -> String # showList :: [PayoutErrorCode] -> ShowS # | |
| ToJSON PayoutErrorCode Source # | |
Defined in Circle.Types Methods toJSON :: PayoutErrorCode -> Value # toEncoding :: PayoutErrorCode -> Encoding # toJSONList :: [PayoutErrorCode] -> Value # toEncodingList :: [PayoutErrorCode] -> Encoding # | |
| FromJSON PayoutErrorCode Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PayoutErrorCode # parseJSONList :: Value -> Parser [PayoutErrorCode] # | |
| HasCodec PayoutErrorCode Source # | |
Defined in Circle.Types | |
data ConfigurationRequest Source #
Instances
newtype ConfigurationResponseBody Source #
Response body for the "/configuration" endpoint
Constructors
| ConfigurationResponseBody | |
Instances
| Eq ConfigurationResponseBody Source # | |
Defined in Circle.Types Methods (==) :: ConfigurationResponseBody -> ConfigurationResponseBody -> Bool # (/=) :: ConfigurationResponseBody -> ConfigurationResponseBody -> Bool # | |
| Show ConfigurationResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ConfigurationResponseBody -> ShowS # show :: ConfigurationResponseBody -> String # showList :: [ConfigurationResponseBody] -> ShowS # | |
| ToJSON ConfigurationResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: ConfigurationResponseBody -> Value # toEncoding :: ConfigurationResponseBody -> Encoding # toJSONList :: [ConfigurationResponseBody] -> Value # | |
| FromJSON ConfigurationResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ConfigurationResponseBody # parseJSONList :: Value -> Parser [ConfigurationResponseBody] # | |
| HasCodec ConfigurationResponseBody Source # | |
Defined in Circle.Types | |
newtype WalletConfig Source #
Constructors
| WalletConfig | |
Fields | |
Instances
| Eq WalletConfig Source # | |
Defined in Circle.Types | |
| Show WalletConfig Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> WalletConfig -> ShowS # show :: WalletConfig -> String # showList :: [WalletConfig] -> ShowS # | |
| ToJSON WalletConfig Source # | |
Defined in Circle.Types Methods toJSON :: WalletConfig -> Value # toEncoding :: WalletConfig -> Encoding # toJSONList :: [WalletConfig] -> Value # toEncodingList :: [WalletConfig] -> Encoding # | |
| FromJSON WalletConfig Source # | |
Defined in Circle.Types | |
| HasCodec WalletConfig Source # | |
Defined in Circle.Types Methods codec :: JSONCodec WalletConfig # listCodecForStringCompatibility :: JSONCodec [WalletConfig] # | |
data EncryptionRequest Source #
Instances
| type CircleRequest EncryptionRequest Source # | |
Defined in Circle.Types | |
data EncryptionResponseBody Source #
Response body for the "/encryption/public" endpoint
Constructors
| EncryptionResponseBody | |
Fields | |
Instances
| Eq EncryptionResponseBody Source # | |
Defined in Circle.Types Methods (==) :: EncryptionResponseBody -> EncryptionResponseBody -> Bool # (/=) :: EncryptionResponseBody -> EncryptionResponseBody -> Bool # | |
| Show EncryptionResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> EncryptionResponseBody -> ShowS # show :: EncryptionResponseBody -> String # showList :: [EncryptionResponseBody] -> ShowS # | |
| ToJSON EncryptionResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: EncryptionResponseBody -> Value # toEncoding :: EncryptionResponseBody -> Encoding # toJSONList :: [EncryptionResponseBody] -> Value # | |
| FromJSON EncryptionResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser EncryptionResponseBody # parseJSONList :: Value -> Parser [EncryptionResponseBody] # | |
| HasCodec EncryptionResponseBody Source # | |
Defined in Circle.Types | |
data ChannelsRequest Source #
Instances
| type CircleRequest ChannelsRequest Source # | |
Defined in Circle.Types | |
newtype ChannelResponseBody Source #
Response body for the "/channels" endpoint
Constructors
| ChannelResponseBody | |
Instances
| Eq ChannelResponseBody Source # | |
Defined in Circle.Types Methods (==) :: ChannelResponseBody -> ChannelResponseBody -> Bool # (/=) :: ChannelResponseBody -> ChannelResponseBody -> Bool # | |
| Show ChannelResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ChannelResponseBody -> ShowS # show :: ChannelResponseBody -> String # showList :: [ChannelResponseBody] -> ShowS # | |
| ToJSON ChannelResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: ChannelResponseBody -> Value # toEncoding :: ChannelResponseBody -> Encoding # toJSONList :: [ChannelResponseBody] -> Value # toEncodingList :: [ChannelResponseBody] -> Encoding # | |
| FromJSON ChannelResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ChannelResponseBody # parseJSONList :: Value -> Parser [ChannelResponseBody] # | |
| HasCodec ChannelResponseBody Source # | |
Defined in Circle.Types | |
Constructors
| Channel | |
Fields
| |
data StablecoinsRequest Source #
Instances
| type CircleRequest StablecoinsRequest Source # | |
Defined in Circle.Types | |
data StablecoinResponseBody Source #
Response body for the "/stablecoins" endpoint
Constructors
| StablecoinResponseBody | |
Instances
| Eq StablecoinResponseBody Source # | |
Defined in Circle.Types Methods (==) :: StablecoinResponseBody -> StablecoinResponseBody -> Bool # (/=) :: StablecoinResponseBody -> StablecoinResponseBody -> Bool # | |
| Show StablecoinResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> StablecoinResponseBody -> ShowS # show :: StablecoinResponseBody -> String # showList :: [StablecoinResponseBody] -> ShowS # | |
| ToJSON StablecoinResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: StablecoinResponseBody -> Value # toEncoding :: StablecoinResponseBody -> Encoding # toJSONList :: [StablecoinResponseBody] -> Value # | |
| FromJSON StablecoinResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser StablecoinResponseBody # parseJSONList :: Value -> Parser [StablecoinResponseBody] # | |
| HasCodec StablecoinResponseBody Source # | |
Defined in Circle.Types | |
data ChainAmount Source #
Constructors
| ChainAmount | |
Fields | |
Instances
| Eq ChainAmount Source # | |
Defined in Circle.Types | |
| Show ChainAmount Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ChainAmount -> ShowS # show :: ChainAmount -> String # showList :: [ChainAmount] -> ShowS # | |
| ToJSON ChainAmount Source # | |
Defined in Circle.Types Methods toJSON :: ChainAmount -> Value # toEncoding :: ChainAmount -> Encoding # toJSONList :: [ChainAmount] -> Value # toEncodingList :: [ChainAmount] -> Encoding # | |
| FromJSON ChainAmount Source # | |
Defined in Circle.Types | |
| HasCodec ChainAmount Source # | |
Defined in Circle.Types | |
data Stablecoin Source #
Instances
| Eq Stablecoin Source # | |
Defined in Circle.Types | |
| Show Stablecoin Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> Stablecoin -> ShowS # show :: Stablecoin -> String # showList :: [Stablecoin] -> ShowS # | |
| ToJSON Stablecoin Source # | |
Defined in Circle.Types Methods toJSON :: Stablecoin -> Value # toEncoding :: Stablecoin -> Encoding # toJSONList :: [Stablecoin] -> Value # toEncodingList :: [Stablecoin] -> Encoding # | |
| FromJSON Stablecoin Source # | |
Defined in Circle.Types | |
| HasCodec Stablecoin Source # | |
Defined in Circle.Types | |
data SubscriptionsRequest Source #
Instances
| type CircleRequest SubscriptionsRequest Source # | |
Defined in Circle.Types | |
data SubscriptionRequest Source #
Instances
data SubscriptionResponseBody Source #
Response body for methods that call "notifications/subscriptions"
Constructors
| SubscriptionResponseBody | |
Instances
| Eq SubscriptionResponseBody Source # | |
Defined in Circle.Types Methods (==) :: SubscriptionResponseBody -> SubscriptionResponseBody -> Bool # (/=) :: SubscriptionResponseBody -> SubscriptionResponseBody -> Bool # | |
| Show SubscriptionResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionResponseBody -> ShowS # show :: SubscriptionResponseBody -> String # showList :: [SubscriptionResponseBody] -> ShowS # | |
| ToJSON SubscriptionResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: SubscriptionResponseBody -> Value # toEncoding :: SubscriptionResponseBody -> Encoding # toJSONList :: [SubscriptionResponseBody] -> Value # | |
| FromJSON SubscriptionResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionResponseBody # parseJSONList :: Value -> Parser [SubscriptionResponseBody] # | |
| HasCodec SubscriptionResponseBody Source # | |
Defined in Circle.Types | |
data SubscriptionDetails Source #
Constructors
| SubscriptionDetails | |
Fields | |
Instances
| Eq SubscriptionDetails Source # | |
Defined in Circle.Types Methods (==) :: SubscriptionDetails -> SubscriptionDetails -> Bool # (/=) :: SubscriptionDetails -> SubscriptionDetails -> Bool # | |
| Show SubscriptionDetails Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionDetails -> ShowS # show :: SubscriptionDetails -> String # showList :: [SubscriptionDetails] -> ShowS # | |
| ToJSON SubscriptionDetails Source # | |
Defined in Circle.Types Methods toJSON :: SubscriptionDetails -> Value # toEncoding :: SubscriptionDetails -> Encoding # toJSONList :: [SubscriptionDetails] -> Value # toEncodingList :: [SubscriptionDetails] -> Encoding # | |
| FromJSON SubscriptionDetails Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionDetails # parseJSONList :: Value -> Parser [SubscriptionDetails] # | |
| HasCodec SubscriptionDetails Source # | |
Defined in Circle.Types | |
newtype SubscriptionRequestBody Source #
Request body for creating a new subscription
Constructors
| SubscriptionRequestBody | |
Fields | |
Instances
| Eq SubscriptionRequestBody Source # | |
Defined in Circle.Types Methods (==) :: SubscriptionRequestBody -> SubscriptionRequestBody -> Bool # (/=) :: SubscriptionRequestBody -> SubscriptionRequestBody -> Bool # | |
| Show SubscriptionRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SubscriptionRequestBody -> ShowS # show :: SubscriptionRequestBody -> String # showList :: [SubscriptionRequestBody] -> ShowS # | |
| ToJSON SubscriptionRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: SubscriptionRequestBody -> Value # toEncoding :: SubscriptionRequestBody -> Encoding # toJSONList :: [SubscriptionRequestBody] -> Value # | |
| FromJSON SubscriptionRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SubscriptionRequestBody # parseJSONList :: Value -> Parser [SubscriptionRequestBody] # | |
| HasCodec SubscriptionRequestBody Source # | |
Defined in Circle.Types | |
data TransfersRequest Source #
Instances
| CircleHasParam TransfersRequest ReturnIdentitiesQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest DestinationWalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest SourceWalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest WalletIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam TransfersRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest TransfersRequest Source # | |
Defined in Circle.Types | |
data TransferRequest Source #
Instances
| CircleHasParam TransferRequest ReturnIdentitiesQueryParam Source # | |
Defined in Circle.Types | |
| type CircleRequest TransferRequest Source # | |
Defined in Circle.Types | |
data BusinessTransferRequestBody Source #
Request body for creating a new business account transfer
Constructors
| BusinessTransferRequestBody | |
Instances
data TransferRequestBody Source #
Request body for creating a new transfer
Constructors
| TransferRequestBody | |
Instances
| Eq TransferRequestBody Source # | |
Defined in Circle.Types Methods (==) :: TransferRequestBody -> TransferRequestBody -> Bool # (/=) :: TransferRequestBody -> TransferRequestBody -> Bool # | |
| Show TransferRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TransferRequestBody -> ShowS # show :: TransferRequestBody -> String # showList :: [TransferRequestBody] -> ShowS # | |
| ToJSON TransferRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: TransferRequestBody -> Value # toEncoding :: TransferRequestBody -> Encoding # toJSONList :: [TransferRequestBody] -> Value # toEncodingList :: [TransferRequestBody] -> Encoding # | |
| FromJSON TransferRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferRequestBody # parseJSONList :: Value -> Parser [TransferRequestBody] # | |
| HasCodec TransferRequestBody Source # | |
Defined in Circle.Types | |
data TransferDestination Source #
Constructors
| TransferDestination | |
Instances
| Eq TransferDestination Source # | |
Defined in Circle.Types Methods (==) :: TransferDestination -> TransferDestination -> Bool # (/=) :: TransferDestination -> TransferDestination -> Bool # | |
| Show TransferDestination Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TransferDestination -> ShowS # show :: TransferDestination -> String # showList :: [TransferDestination] -> ShowS # | |
| ToJSON TransferDestination Source # | |
Defined in Circle.Types Methods toJSON :: TransferDestination -> Value # toEncoding :: TransferDestination -> Encoding # toJSONList :: [TransferDestination] -> Value # toEncodingList :: [TransferDestination] -> Encoding # | |
| FromJSON TransferDestination Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferDestination # parseJSONList :: Value -> Parser [TransferDestination] # | |
| HasCodec TransferDestination Source # | |
Defined in Circle.Types | |
data DestinationType Source #
Constructors
| VerifiedBlockchain |
Instances
| Eq DestinationType Source # | |
Defined in Circle.Types Methods (==) :: DestinationType -> DestinationType -> Bool # (/=) :: DestinationType -> DestinationType -> Bool # | |
| Show DestinationType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationType -> ShowS # show :: DestinationType -> String # showList :: [DestinationType] -> ShowS # | |
| ToJSON DestinationType Source # | |
Defined in Circle.Types Methods toJSON :: DestinationType -> Value # toEncoding :: DestinationType -> Encoding # toJSONList :: [DestinationType] -> Value # toEncodingList :: [DestinationType] -> Encoding # | |
| FromJSON DestinationType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationType # parseJSONList :: Value -> Parser [DestinationType] # | |
| HasCodec DestinationType Source # | |
Defined in Circle.Types | |
data TransferResponseBody Source #
Response body for methods that call the "businessAccount/transfers" and "transfers" endpoints
Constructors
Instances
| Eq TransferResponseBody Source # | |
Defined in Circle.Types Methods (==) :: TransferResponseBody -> TransferResponseBody -> Bool # (/=) :: TransferResponseBody -> TransferResponseBody -> Bool # | |
| Show TransferResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TransferResponseBody -> ShowS # show :: TransferResponseBody -> String # showList :: [TransferResponseBody] -> ShowS # | |
| FromJSON TransferResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferResponseBody # parseJSONList :: Value -> Parser [TransferResponseBody] # | |
data SourceWallet Source #
Constructors
| SourceWallet | |
Fields | |
Instances
| Eq SourceWallet Source # | |
Defined in Circle.Types | |
| Show SourceWallet Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SourceWallet -> ShowS # show :: SourceWallet -> String # showList :: [SourceWallet] -> ShowS # | |
| ToJSON SourceWallet Source # | |
Defined in Circle.Types Methods toJSON :: SourceWallet -> Value # toEncoding :: SourceWallet -> Encoding # toJSONList :: [SourceWallet] -> Value # toEncodingList :: [SourceWallet] -> Encoding # | |
| FromJSON SourceWallet Source # | |
Defined in Circle.Types | |
| HasCodec SourceWallet Source # | |
Defined in Circle.Types Methods codec :: JSONCodec SourceWallet # listCodecForStringCompatibility :: JSONCodec [SourceWallet] # | |
data SourceBlockchain Source #
Constructors
| SourceBlockchain | |
Fields | |
Instances
| Eq SourceBlockchain Source # | |
Defined in Circle.Types Methods (==) :: SourceBlockchain -> SourceBlockchain -> Bool # (/=) :: SourceBlockchain -> SourceBlockchain -> Bool # | |
| Show SourceBlockchain Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SourceBlockchain -> ShowS # show :: SourceBlockchain -> String # showList :: [SourceBlockchain] -> ShowS # | |
| ToJSON SourceBlockchain Source # | |
Defined in Circle.Types Methods toJSON :: SourceBlockchain -> Value # toEncoding :: SourceBlockchain -> Encoding # toJSONList :: [SourceBlockchain] -> Value # toEncodingList :: [SourceBlockchain] -> Encoding # | |
| FromJSON SourceBlockchain Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SourceBlockchain # parseJSONList :: Value -> Parser [SourceBlockchain] # | |
| HasCodec SourceBlockchain Source # | |
Defined in Circle.Types | |
data DestinationWallet Source #
Constructors
| DestinationWallet | |
Fields | |
Instances
| Eq DestinationWallet Source # | |
Defined in Circle.Types Methods (==) :: DestinationWallet -> DestinationWallet -> Bool # (/=) :: DestinationWallet -> DestinationWallet -> Bool # | |
| Show DestinationWallet Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationWallet -> ShowS # show :: DestinationWallet -> String # showList :: [DestinationWallet] -> ShowS # | |
| ToJSON DestinationWallet Source # | |
Defined in Circle.Types Methods toJSON :: DestinationWallet -> Value # toEncoding :: DestinationWallet -> Encoding # toJSONList :: [DestinationWallet] -> Value # toEncodingList :: [DestinationWallet] -> Encoding # | |
| FromJSON DestinationWallet Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationWallet # parseJSONList :: Value -> Parser [DestinationWallet] # | |
| HasCodec DestinationWallet Source # | |
Defined in Circle.Types | |
data DestinationBlockchain Source #
Constructors
| DestinationBlockchain | |
Instances
| Eq DestinationBlockchain Source # | |
Defined in Circle.Types Methods (==) :: DestinationBlockchain -> DestinationBlockchain -> Bool # (/=) :: DestinationBlockchain -> DestinationBlockchain -> Bool # | |
| Show DestinationBlockchain Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationBlockchain -> ShowS # show :: DestinationBlockchain -> String # showList :: [DestinationBlockchain] -> ShowS # | |
| ToJSON DestinationBlockchain Source # | |
Defined in Circle.Types Methods toJSON :: DestinationBlockchain -> Value # toEncoding :: DestinationBlockchain -> Encoding # toJSONList :: [DestinationBlockchain] -> Value # toEncodingList :: [DestinationBlockchain] -> Encoding # | |
| FromJSON DestinationBlockchain Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationBlockchain # parseJSONList :: Value -> Parser [DestinationBlockchain] # | |
| HasCodec DestinationBlockchain Source # | |
Defined in Circle.Types | |
Constructors
| Identity | |
Fields
| |
data IdentityType Source #
Constructors
| Individual | |
| Business |
Instances
| Eq IdentityType Source # | |
Defined in Circle.Types | |
| Show IdentityType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> IdentityType -> ShowS # show :: IdentityType -> String # showList :: [IdentityType] -> ShowS # | |
| ToJSON IdentityType Source # | |
Defined in Circle.Types Methods toJSON :: IdentityType -> Value # toEncoding :: IdentityType -> Encoding # toJSONList :: [IdentityType] -> Value # toEncodingList :: [IdentityType] -> Encoding # | |
| FromJSON IdentityType Source # | |
Defined in Circle.Types | |
| HasCodec IdentityType Source # | |
Defined in Circle.Types Methods codec :: JSONCodec IdentityType # listCodecForStringCompatibility :: JSONCodec [IdentityType] # | |
data TransferType Source #
Constructors
| Wallet | |
| Blockchain |
Instances
| Eq TransferType Source # | |
Defined in Circle.Types | |
| Show TransferType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TransferType -> ShowS # show :: TransferType -> String # showList :: [TransferType] -> ShowS # | |
| ToJSON TransferType Source # | |
Defined in Circle.Types Methods toJSON :: TransferType -> Value # toEncoding :: TransferType -> Encoding # toJSONList :: [TransferType] -> Value # toEncodingList :: [TransferType] -> Encoding # | |
| FromJSON TransferType Source # | |
Defined in Circle.Types | |
| HasCodec TransferType Source # | |
Defined in Circle.Types Methods codec :: JSONCodec TransferType # listCodecForStringCompatibility :: JSONCodec [TransferType] # | |
data TransferErrorCode Source #
Instances
| Eq TransferErrorCode Source # | |
Defined in Circle.Types Methods (==) :: TransferErrorCode -> TransferErrorCode -> Bool # (/=) :: TransferErrorCode -> TransferErrorCode -> Bool # | |
| Show TransferErrorCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TransferErrorCode -> ShowS # show :: TransferErrorCode -> String # showList :: [TransferErrorCode] -> ShowS # | |
| ToJSON TransferErrorCode Source # | |
Defined in Circle.Types Methods toJSON :: TransferErrorCode -> Value # toEncoding :: TransferErrorCode -> Encoding # toJSONList :: [TransferErrorCode] -> Value # toEncodingList :: [TransferErrorCode] -> Encoding # | |
| FromJSON TransferErrorCode Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser TransferErrorCode # parseJSONList :: Value -> Parser [TransferErrorCode] # | |
| HasCodec TransferErrorCode Source # | |
Defined in Circle.Types | |
data DepositAddressesRequest Source #
Instances
data DepositAddressRequest Source #
Instances
data DepositAddressResponseBody Source #
Response body for methods that call the "businessAccount/wallets/addresses/deposit" endpoint
Constructors
| DepositAddressResponseBody | |
Instances
data DepositAddressRequestBody Source #
Request body for creating a new deposit address
Constructors
| DepositAddressRequestBody | |
Instances
| Eq DepositAddressRequestBody Source # | |
Defined in Circle.Types Methods (==) :: DepositAddressRequestBody -> DepositAddressRequestBody -> Bool # (/=) :: DepositAddressRequestBody -> DepositAddressRequestBody -> Bool # | |
| Show DepositAddressRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DepositAddressRequestBody -> ShowS # show :: DepositAddressRequestBody -> String # showList :: [DepositAddressRequestBody] -> ShowS # | |
| ToJSON DepositAddressRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: DepositAddressRequestBody -> Value # toEncoding :: DepositAddressRequestBody -> Encoding # toJSONList :: [DepositAddressRequestBody] -> Value # | |
| FromJSON DepositAddressRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DepositAddressRequestBody # parseJSONList :: Value -> Parser [DepositAddressRequestBody] # | |
| HasCodec DepositAddressRequestBody Source # | |
Defined in Circle.Types | |
data RecipientAddressesRequest Source #
Instances
data RecipientAddressRequest Source #
Instances
data RecipientAddressResponseBody Source #
Response body for methods that call the "businessAccount/wallets/addresses/recipient" endpoint
Constructors
| RecipientAddressResponseBody | |
Fields | |
Instances
data RecipientAddressRequestBody Source #
Request body for creating a new recipient address
Constructors
Instances
data DepositsRequest Source #
Instances
| CircleHasParam DepositsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam DepositsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam DepositsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam DepositsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam DepositsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest DepositsRequest Source # | |
Defined in Circle.Types | |
data DepositResponseBody Source #
Response body for methods that call the "businessAccount/deposits" endpoint
Constructors
Instances
| Eq DepositResponseBody Source # | |
Defined in Circle.Types Methods (==) :: DepositResponseBody -> DepositResponseBody -> Bool # (/=) :: DepositResponseBody -> DepositResponseBody -> Bool # | |
| Show DepositResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DepositResponseBody -> ShowS # show :: DepositResponseBody -> String # showList :: [DepositResponseBody] -> ShowS # | |
| ToJSON DepositResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: DepositResponseBody -> Value # toEncoding :: DepositResponseBody -> Encoding # toJSONList :: [DepositResponseBody] -> Value # toEncodingList :: [DepositResponseBody] -> Encoding # | |
| FromJSON DepositResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DepositResponseBody # parseJSONList :: Value -> Parser [DepositResponseBody] # | |
| HasCodec DepositResponseBody Source # | |
Defined in Circle.Types | |
data MockPaymentRequest Source #
Instances
| type CircleRequest MockPaymentRequest Source # | |
Defined in Circle.Types | |
data MockPaymentResponseBody Source #
Response body for methods that call the "mock/payments/*" endpoint
Constructors
| MockPaymentResponseBody | |
Instances
| Eq MockPaymentResponseBody Source # | |
Defined in Circle.Types Methods (==) :: MockPaymentResponseBody -> MockPaymentResponseBody -> Bool # (/=) :: MockPaymentResponseBody -> MockPaymentResponseBody -> Bool # | |
| Show MockPaymentResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> MockPaymentResponseBody -> ShowS # show :: MockPaymentResponseBody -> String # showList :: [MockPaymentResponseBody] -> ShowS # | |
| ToJSON MockPaymentResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: MockPaymentResponseBody -> Value # toEncoding :: MockPaymentResponseBody -> Encoding # toJSONList :: [MockPaymentResponseBody] -> Value # | |
| FromJSON MockPaymentResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser MockPaymentResponseBody # parseJSONList :: Value -> Parser [MockPaymentResponseBody] # | |
| HasCodec MockPaymentResponseBody Source # | |
Defined in Circle.Types | |
data MockSenOrWirePaymentRequestBody Source #
Request body to create a mock SEN or Wire payment (in the sandbox only).
Constructors
| MockSenOrWirePaymentRequestBody | |
Instances
| Eq MockSenOrWirePaymentRequestBody Source # | |
Defined in Circle.Types | |
| Show MockSenOrWirePaymentRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> MockSenOrWirePaymentRequestBody -> ShowS # | |
| ToJSON MockSenOrWirePaymentRequestBody Source # | |
Defined in Circle.Types | |
| FromJSON MockSenOrWirePaymentRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser MockSenOrWirePaymentRequestBody # parseJSONList :: Value -> Parser [MockSenOrWirePaymentRequestBody] # | |
| HasCodec MockSenOrWirePaymentRequestBody Source # | |
Defined in Circle.Types | |
data MockSEPAPaymentRequestBody Source #
Request body to create a mock SEPA payment (in the sandbox only).
Constructors
| MockSEPAPaymentRequestBody | |
Instances
newtype MockBeneficiaryBankDetails Source #
Constructors
| MockBeneficiaryBankDetails | |
Instances
data SENAccountRequest Source #
Instances
| type CircleRequest SENAccountRequest Source # | |
Defined in Circle.Types | |
data SENAccountsRequest Source #
Instances
| type CircleRequest SENAccountsRequest Source # | |
Defined in Circle.Types | |
data SENInstructionsRequest Source #
Instances
data SENAccountRequestBody Source #
Request body to create a Silvergate SEN account.
Constructors
| SENAccountRequestBody | |
Instances
| Eq SENAccountRequestBody Source # | |
Defined in Circle.Types Methods (==) :: SENAccountRequestBody -> SENAccountRequestBody -> Bool # (/=) :: SENAccountRequestBody -> SENAccountRequestBody -> Bool # | |
| Show SENAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SENAccountRequestBody -> ShowS # show :: SENAccountRequestBody -> String # showList :: [SENAccountRequestBody] -> ShowS # | |
| ToJSON SENAccountRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: SENAccountRequestBody -> Value # toEncoding :: SENAccountRequestBody -> Encoding # toJSONList :: [SENAccountRequestBody] -> Value # toEncodingList :: [SENAccountRequestBody] -> Encoding # | |
| FromJSON SENAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SENAccountRequestBody # parseJSONList :: Value -> Parser [SENAccountRequestBody] # | |
| HasCodec SENAccountRequestBody Source # | |
Defined in Circle.Types | |
data SENAccountResponseBody Source #
Response body for methods that call the "businessAccount/banks/sen" endpoint
Constructors
Instances
| Eq SENAccountResponseBody Source # | |
Defined in Circle.Types Methods (==) :: SENAccountResponseBody -> SENAccountResponseBody -> Bool # (/=) :: SENAccountResponseBody -> SENAccountResponseBody -> Bool # | |
| Show SENAccountResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SENAccountResponseBody -> ShowS # show :: SENAccountResponseBody -> String # showList :: [SENAccountResponseBody] -> ShowS # | |
| ToJSON SENAccountResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: SENAccountResponseBody -> Value # toEncoding :: SENAccountResponseBody -> Encoding # toJSONList :: [SENAccountResponseBody] -> Value # | |
| FromJSON SENAccountResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SENAccountResponseBody # parseJSONList :: Value -> Parser [SENAccountResponseBody] # | |
| HasCodec SENAccountResponseBody Source # | |
Defined in Circle.Types | |
data SENInstructionsResponseData Source #
Constructors
| SENInstructionsResponseData | |
Instances
data SignetBankAccountRequest Source #
Instances
data SignetBankAccountsRequest Source #
Instances
data SignetBankInstructionsRequest Source #
Instances
data SignetBankAccountRequestBody Source #
Request body to create Signet Bank bank account.
Constructors
| SignetBankAccountRequestBody | |
Instances
data SignetBankAccountResponseData Source #
Response body for methods that call the "businessAccount/banks/signet" endpoint
Constructors
| SignetBankAccountResponseData | |
Instances
| Eq SignetBankAccountResponseData Source # | |
Defined in Circle.Types | |
| Show SignetBankAccountResponseData Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SignetBankAccountResponseData -> ShowS # show :: SignetBankAccountResponseData -> String # showList :: [SignetBankAccountResponseData] -> ShowS # | |
| ToJSON SignetBankAccountResponseData Source # | |
Defined in Circle.Types Methods toJSON :: SignetBankAccountResponseData -> Value # toEncoding :: SignetBankAccountResponseData -> Encoding # toJSONList :: [SignetBankAccountResponseData] -> Value # toEncodingList :: [SignetBankAccountResponseData] -> Encoding # | |
| FromJSON SignetBankAccountResponseData Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SignetBankAccountResponseData # parseJSONList :: Value -> Parser [SignetBankAccountResponseData] # | |
| HasCodec SignetBankAccountResponseData Source # | |
Defined in Circle.Types | |
data SignetBankInstructionsResponseData Source #
Constructors
| SignetBankInstructionsResponseData | |
Instances
| Eq SignetBankInstructionsResponseData Source # | |
Defined in Circle.Types | |
| Show SignetBankInstructionsResponseData Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SignetBankInstructionsResponseData -> ShowS # | |
| ToJSON SignetBankInstructionsResponseData Source # | |
Defined in Circle.Types | |
| FromJSON SignetBankInstructionsResponseData Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SignetBankInstructionsResponseData # parseJSONList :: Value -> Parser [SignetBankInstructionsResponseData] # | |
| HasCodec SignetBankInstructionsResponseData Source # | |
data WireAccountRequest Source #
Instances
| type CircleRequest WireAccountRequest Source # | |
Defined in Circle.Types | |
data WireAccountsRequest Source #
Instances
| type CircleRequest WireAccountsRequest Source # | |
Defined in Circle.Types | |
data WireInstructionsRequest Source #
Instances
data WireAccountRequestBody Source #
Request body to create a wire account. Sum type because this endpoint supports several different types of wire accounts.
Constructors
| USBankAccount !USBankAccountRequestBody | |
| IBANBankAccount !IBANBankAccountRequestBody | |
| NonIBANBankAccount !NonIBANBankAccountRequestBody |
Instances
| Eq WireAccountRequestBody Source # | |
Defined in Circle.Types Methods (==) :: WireAccountRequestBody -> WireAccountRequestBody -> Bool # (/=) :: WireAccountRequestBody -> WireAccountRequestBody -> Bool # | |
| Show WireAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> WireAccountRequestBody -> ShowS # show :: WireAccountRequestBody -> String # showList :: [WireAccountRequestBody] -> ShowS # | |
data USBankAccountRequestBody Source #
Constructors
| USBankAccountRequestBody | |
Instances
| Eq USBankAccountRequestBody Source # | |
Defined in Circle.Types Methods (==) :: USBankAccountRequestBody -> USBankAccountRequestBody -> Bool # (/=) :: USBankAccountRequestBody -> USBankAccountRequestBody -> Bool # | |
| Show USBankAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> USBankAccountRequestBody -> ShowS # show :: USBankAccountRequestBody -> String # showList :: [USBankAccountRequestBody] -> ShowS # | |
| ToJSON USBankAccountRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: USBankAccountRequestBody -> Value # toEncoding :: USBankAccountRequestBody -> Encoding # toJSONList :: [USBankAccountRequestBody] -> Value # | |
| FromJSON USBankAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser USBankAccountRequestBody # parseJSONList :: Value -> Parser [USBankAccountRequestBody] # | |
| HasCodec USBankAccountRequestBody Source # | |
Defined in Circle.Types | |
data IBANBankAccountRequestBody Source #
Constructors
| IBANBankAccountRequestBody | |
Instances
data NonIBANBankAccountRequestBody Source #
Constructors
| NonIBANBankAccountRequestBody | |
Instances
| Eq NonIBANBankAccountRequestBody Source # | |
Defined in Circle.Types | |
| Show NonIBANBankAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> NonIBANBankAccountRequestBody -> ShowS # show :: NonIBANBankAccountRequestBody -> String # showList :: [NonIBANBankAccountRequestBody] -> ShowS # | |
| ToJSON NonIBANBankAccountRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: NonIBANBankAccountRequestBody -> Value # toEncoding :: NonIBANBankAccountRequestBody -> Encoding # toJSONList :: [NonIBANBankAccountRequestBody] -> Value # toEncodingList :: [NonIBANBankAccountRequestBody] -> Encoding # | |
| FromJSON NonIBANBankAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser NonIBANBankAccountRequestBody # parseJSONList :: Value -> Parser [NonIBANBankAccountRequestBody] # | |
| HasCodec NonIBANBankAccountRequestBody Source # | |
Defined in Circle.Types | |
data WireInstructionsResponseData Source #
Response body for getWireAccountInstructions
Constructors
| WireInstructionsResponseData | |
Instances
data WireAccountResponseBody Source #
Response body for methods that call the "/wires" or "businessAccount/wires" endpoints
Constructors
Instances
| Eq WireAccountResponseBody Source # | |
Defined in Circle.Types Methods (==) :: WireAccountResponseBody -> WireAccountResponseBody -> Bool # (/=) :: WireAccountResponseBody -> WireAccountResponseBody -> Bool # | |
| Show WireAccountResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> WireAccountResponseBody -> ShowS # show :: WireAccountResponseBody -> String # showList :: [WireAccountResponseBody] -> ShowS # | |
| ToJSON WireAccountResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: WireAccountResponseBody -> Value # toEncoding :: WireAccountResponseBody -> Encoding # toJSONList :: [WireAccountResponseBody] -> Value # | |
| FromJSON WireAccountResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser WireAccountResponseBody # parseJSONList :: Value -> Parser [WireAccountResponseBody] # | |
| HasCodec WireAccountResponseBody Source # | |
Defined in Circle.Types | |
data PaymentRequest Source #
Instances
data PaymentsRequest Source #
Instances
| CircleHasParam PaymentsRequest PaymentStatusQueryParams Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest PaymentIntentIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest SettlementIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest SourceQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest TypeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest DestinationQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam PaymentsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest PaymentsRequest Source # | |
data CreatePaymentRequestBody Source #
Request body to create any kind of payment.
Constructors
| CreatePaymentRequestBody | |
Fields
| |
Instances
| Eq CreatePaymentRequestBody Source # | |
Defined in Circle.Types Methods (==) :: CreatePaymentRequestBody -> CreatePaymentRequestBody -> Bool # (/=) :: CreatePaymentRequestBody -> CreatePaymentRequestBody -> Bool # | |
| Show CreatePaymentRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreatePaymentRequestBody -> ShowS # show :: CreatePaymentRequestBody -> String # showList :: [CreatePaymentRequestBody] -> ShowS # | |
| ToJSON CreatePaymentRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: CreatePaymentRequestBody -> Value # toEncoding :: CreatePaymentRequestBody -> Encoding # toJSONList :: [CreatePaymentRequestBody] -> Value # | |
| FromJSON CreatePaymentRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreatePaymentRequestBody # parseJSONList :: Value -> Parser [CreatePaymentRequestBody] # | |
| HasCodec CreatePaymentRequestBody Source # | |
Defined in Circle.Types | |
data RequestMetadata Source #
Constructors
| RequestMetadata | |
Instances
| Eq RequestMetadata Source # | |
Defined in Circle.Types Methods (==) :: RequestMetadata -> RequestMetadata -> Bool # (/=) :: RequestMetadata -> RequestMetadata -> Bool # | |
| Show RequestMetadata Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> RequestMetadata -> ShowS # show :: RequestMetadata -> String # showList :: [RequestMetadata] -> ShowS # | |
| ToJSON RequestMetadata Source # | |
Defined in Circle.Types Methods toJSON :: RequestMetadata -> Value # toEncoding :: RequestMetadata -> Encoding # toJSONList :: [RequestMetadata] -> Value # toEncodingList :: [RequestMetadata] -> Encoding # | |
| FromJSON RequestMetadata Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser RequestMetadata # parseJSONList :: Value -> Parser [RequestMetadata] # | |
| HasCodec RequestMetadata Source # | |
Defined in Circle.Types | |
Constructors
| SessionId | |
Fields
| |
Constructors
| IPAddress | |
Fields
| |
newtype PhoneNumber Source #
Constructors
| PhoneNumber | |
Fields | |
Instances
| Eq PhoneNumber Source # | |
Defined in Circle.Types | |
| Show PhoneNumber Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PhoneNumber -> ShowS # show :: PhoneNumber -> String # showList :: [PhoneNumber] -> ShowS # | |
| ToJSON PhoneNumber Source # | |
Defined in Circle.Types Methods toJSON :: PhoneNumber -> Value # toEncoding :: PhoneNumber -> Encoding # toJSONList :: [PhoneNumber] -> Value # toEncodingList :: [PhoneNumber] -> Encoding # | |
| FromJSON PhoneNumber Source # | |
Defined in Circle.Types | |
| HasCodec PhoneNumber Source # | |
Defined in Circle.Types | |
data PaymentErrorCode Source #
Constructors
Instances
| Eq PaymentErrorCode Source # | |
Defined in Circle.Types Methods (==) :: PaymentErrorCode -> PaymentErrorCode -> Bool # (/=) :: PaymentErrorCode -> PaymentErrorCode -> Bool # | |
| Show PaymentErrorCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentErrorCode -> ShowS # show :: PaymentErrorCode -> String # showList :: [PaymentErrorCode] -> ShowS # | |
| ToJSON PaymentErrorCode Source # | |
Defined in Circle.Types Methods toJSON :: PaymentErrorCode -> Value # toEncoding :: PaymentErrorCode -> Encoding # toJSONList :: [PaymentErrorCode] -> Value # toEncodingList :: [PaymentErrorCode] -> Encoding # | |
| FromJSON PaymentErrorCode Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentErrorCode # parseJSONList :: Value -> Parser [PaymentErrorCode] # | |
| HasCodec PaymentErrorCode Source # | |
Defined in Circle.Types | |
data FiatOrCryptoPaymentResponseBody Source #
A FiatOrCryptoPaymentResponseBody object represents a fiat or crypto payment. These payments look identical except for the Description field, and the fact that a FiatPayment could have response verification data, whereas a crypto payment could have info about the deposit address, transaction hash etc. I'd love to differentiate these fields based on what I can parse from JSON, but there's enough overlap between the two response bodies that I can cheat for now.
Constructors
Instances
| Eq FiatOrCryptoPaymentResponseBody Source # | |
Defined in Circle.Types | |
| Show FiatOrCryptoPaymentResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> FiatOrCryptoPaymentResponseBody -> ShowS # | |
| ToJSON FiatOrCryptoPaymentResponseBody Source # | |
Defined in Circle.Types | |
| FromJSON FiatOrCryptoPaymentResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser FiatOrCryptoPaymentResponseBody # parseJSONList :: Value -> Parser [FiatOrCryptoPaymentResponseBody] # | |
| HasCodec FiatOrCryptoPaymentResponseBody Source # | |
Defined in Circle.Types | |
data ResponseMetadata Source #
Constructors
| ResponseMetadata | |
Fields | |
Instances
| Eq ResponseMetadata Source # | |
Defined in Circle.Types Methods (==) :: ResponseMetadata -> ResponseMetadata -> Bool # (/=) :: ResponseMetadata -> ResponseMetadata -> Bool # | |
| Show ResponseMetadata Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ResponseMetadata -> ShowS # show :: ResponseMetadata -> String # showList :: [ResponseMetadata] -> ShowS # | |
| ToJSON ResponseMetadata Source # | |
Defined in Circle.Types Methods toJSON :: ResponseMetadata -> Value # toEncoding :: ResponseMetadata -> Encoding # toJSONList :: [ResponseMetadata] -> Value # toEncodingList :: [ResponseMetadata] -> Encoding # | |
| FromJSON ResponseMetadata Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ResponseMetadata # parseJSONList :: Value -> Parser [ResponseMetadata] # | |
| HasCodec ResponseMetadata Source # | |
Defined in Circle.Types | |
data VerificationData Source #
Constructors
| VerificationData | |
Fields
| |
Instances
Constructors
| AVSNotRequested | |
| AVSPending | |
| Y | |
| N |
Constructors
| CVVNotRequested | |
| CVVPass | |
| CVVFail | |
| CVVUnavailable | |
| CVVPending |
data PaymentDepositAddress Source #
Constructors
| PaymentDepositAddress | |
Fields | |
Instances
| Eq PaymentDepositAddress Source # | |
Defined in Circle.Types Methods (==) :: PaymentDepositAddress -> PaymentDepositAddress -> Bool # (/=) :: PaymentDepositAddress -> PaymentDepositAddress -> Bool # | |
| Show PaymentDepositAddress Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentDepositAddress -> ShowS # show :: PaymentDepositAddress -> String # showList :: [PaymentDepositAddress] -> ShowS # | |
| ToJSON PaymentDepositAddress Source # | |
Defined in Circle.Types Methods toJSON :: PaymentDepositAddress -> Value # toEncoding :: PaymentDepositAddress -> Encoding # toJSONList :: [PaymentDepositAddress] -> Value # toEncodingList :: [PaymentDepositAddress] -> Encoding # | |
| FromJSON PaymentDepositAddress Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentDepositAddress # parseJSONList :: Value -> Parser [PaymentDepositAddress] # | |
| HasCodec PaymentDepositAddress Source # | |
Defined in Circle.Types | |
data FiatCancelOrRefundResponseBody Source #
A FiatCancelOrRefundResponseBody object represents an attempt at canceling or refunding a payment. Cancellations apply only to card payments, and its presence doesn't necessarily mean that the cancellation was successful. A successful cancellation has a status of paid, a successful refund has a status of confirmed.
Constructors
Instances
| Eq FiatCancelOrRefundResponseBody Source # | |
Defined in Circle.Types | |
| Show FiatCancelOrRefundResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> FiatCancelOrRefundResponseBody -> ShowS # show :: FiatCancelOrRefundResponseBody -> String # showList :: [FiatCancelOrRefundResponseBody] -> ShowS # | |
| ToJSON FiatCancelOrRefundResponseBody Source # | |
Defined in Circle.Types | |
| FromJSON FiatCancelOrRefundResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser FiatCancelOrRefundResponseBody # parseJSONList :: Value -> Parser [FiatCancelOrRefundResponseBody] # | |
| HasCodec FiatCancelOrRefundResponseBody Source # | |
Defined in Circle.Types | |
data OriginalFiatPayment Source #
Constructors
Instances
data PaymentSource Source #
Constructors
| PaymentSource | |
Fields | |
Instances
| Eq PaymentSource Source # | |
Defined in Circle.Types Methods (==) :: PaymentSource -> PaymentSource -> Bool # (/=) :: PaymentSource -> PaymentSource -> Bool # | |
| Show PaymentSource Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentSource -> ShowS # show :: PaymentSource -> String # showList :: [PaymentSource] -> ShowS # | |
| ToJSON PaymentSource Source # | |
Defined in Circle.Types Methods toJSON :: PaymentSource -> Value # toEncoding :: PaymentSource -> Encoding # toJSONList :: [PaymentSource] -> Value # toEncodingList :: [PaymentSource] -> Encoding # | |
| FromJSON PaymentSource Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentSource # parseJSONList :: Value -> Parser [PaymentSource] # | |
| HasCodec PaymentSource Source # | |
Defined in Circle.Types Methods codec :: JSONCodec PaymentSource # listCodecForStringCompatibility :: JSONCodec [PaymentSource] # | |
data PaymentActionRequired Source #
Constructors
| PaymentActionRequired | |
Instances
| Eq PaymentActionRequired Source # | |
Defined in Circle.Types Methods (==) :: PaymentActionRequired -> PaymentActionRequired -> Bool # (/=) :: PaymentActionRequired -> PaymentActionRequired -> Bool # | |
| Show PaymentActionRequired Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentActionRequired -> ShowS # show :: PaymentActionRequired -> String # showList :: [PaymentActionRequired] -> ShowS # | |
| ToJSON PaymentActionRequired Source # | |
Defined in Circle.Types Methods toJSON :: PaymentActionRequired -> Value # toEncoding :: PaymentActionRequired -> Encoding # toJSONList :: [PaymentActionRequired] -> Value # toEncodingList :: [PaymentActionRequired] -> Encoding # | |
| FromJSON PaymentActionRequired Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentActionRequired # parseJSONList :: Value -> Parser [PaymentActionRequired] # | |
| HasCodec PaymentActionRequired Source # | |
Defined in Circle.Types | |
data ActionRequiredType Source #
Constructors
| ThreeDSecureRequired |
Instances
| Eq ActionRequiredType Source # | |
Defined in Circle.Types Methods (==) :: ActionRequiredType -> ActionRequiredType -> Bool # (/=) :: ActionRequiredType -> ActionRequiredType -> Bool # | |
| Show ActionRequiredType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ActionRequiredType -> ShowS # show :: ActionRequiredType -> String # showList :: [ActionRequiredType] -> ShowS # | |
| ToJSON ActionRequiredType Source # | |
Defined in Circle.Types Methods toJSON :: ActionRequiredType -> Value # toEncoding :: ActionRequiredType -> Encoding # toJSONList :: [ActionRequiredType] -> Value # toEncodingList :: [ActionRequiredType] -> Encoding # | |
| FromJSON ActionRequiredType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ActionRequiredType # parseJSONList :: Value -> Parser [ActionRequiredType] # | |
| HasCodec ActionRequiredType Source # | |
Defined in Circle.Types | |
data VerificationType Source #
Constructors
| VerificationThreeDSecure | |
| VerificationCVV |
Instances
| Eq VerificationType Source # | |
Defined in Circle.Types Methods (==) :: VerificationType -> VerificationType -> Bool # (/=) :: VerificationType -> VerificationType -> Bool # | |
| Show VerificationType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> VerificationType -> ShowS # show :: VerificationType -> String # showList :: [VerificationType] -> ShowS # | |
| ToJSON VerificationType Source # | |
Defined in Circle.Types Methods toJSON :: VerificationType -> Value # toEncoding :: VerificationType -> Encoding # toJSONList :: [VerificationType] -> Value # toEncodingList :: [VerificationType] -> Encoding # | |
| FromJSON VerificationType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser VerificationType # parseJSONList :: Value -> Parser [VerificationType] # | |
| HasCodec VerificationType Source # | |
Defined in Circle.Types | |
data PaymentType Source #
Instances
| Eq PaymentType Source # | |
Defined in Circle.Types | |
| Show PaymentType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentType -> ShowS # show :: PaymentType -> String # showList :: [PaymentType] -> ShowS # | |
| ToJSON PaymentType Source # | |
Defined in Circle.Types Methods toJSON :: PaymentType -> Value # toEncoding :: PaymentType -> Encoding # toJSONList :: [PaymentType] -> Value # toEncodingList :: [PaymentType] -> Encoding # | |
| FromJSON PaymentType Source # | |
Defined in Circle.Types | |
| HasCodec PaymentType Source # | |
Defined in Circle.Types | |
data PaymentSourceType Source #
Constructors
| Card | |
| ACH | |
| WireSource | |
| SEPA |
Instances
| Eq PaymentSourceType Source # | |
Defined in Circle.Types Methods (==) :: PaymentSourceType -> PaymentSourceType -> Bool # (/=) :: PaymentSourceType -> PaymentSourceType -> Bool # | |
| Show PaymentSourceType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentSourceType -> ShowS # show :: PaymentSourceType -> String # showList :: [PaymentSourceType] -> ShowS # | |
| ToJSON PaymentSourceType Source # | |
Defined in Circle.Types Methods toJSON :: PaymentSourceType -> Value # toEncoding :: PaymentSourceType -> Encoding # toJSONList :: [PaymentSourceType] -> Value # toEncodingList :: [PaymentSourceType] -> Encoding # | |
| FromJSON PaymentSourceType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentSourceType # parseJSONList :: Value -> Parser [PaymentSourceType] # | |
| HasCodec PaymentSourceType Source # | |
Defined in Circle.Types | |
data CancelPaymentRequestBody Source #
Request body to cancel a fiat payment.
Constructors
| CancelPaymentRequestBody | |
Fields | |
Instances
| Eq CancelPaymentRequestBody Source # | |
Defined in Circle.Types Methods (==) :: CancelPaymentRequestBody -> CancelPaymentRequestBody -> Bool # (/=) :: CancelPaymentRequestBody -> CancelPaymentRequestBody -> Bool # | |
| Show CancelPaymentRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CancelPaymentRequestBody -> ShowS # show :: CancelPaymentRequestBody -> String # showList :: [CancelPaymentRequestBody] -> ShowS # | |
| ToJSON CancelPaymentRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: CancelPaymentRequestBody -> Value # toEncoding :: CancelPaymentRequestBody -> Encoding # toJSONList :: [CancelPaymentRequestBody] -> Value # | |
| FromJSON CancelPaymentRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CancelPaymentRequestBody # parseJSONList :: Value -> Parser [CancelPaymentRequestBody] # | |
| HasCodec CancelPaymentRequestBody Source # | |
Defined in Circle.Types | |
data CancelPaymentReason Source #
Constructors
Instances
| Eq CancelPaymentReason Source # | |
Defined in Circle.Types Methods (==) :: CancelPaymentReason -> CancelPaymentReason -> Bool # (/=) :: CancelPaymentReason -> CancelPaymentReason -> Bool # | |
| Show CancelPaymentReason Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CancelPaymentReason -> ShowS # show :: CancelPaymentReason -> String # showList :: [CancelPaymentReason] -> ShowS # | |
| ToJSON CancelPaymentReason Source # | |
Defined in Circle.Types Methods toJSON :: CancelPaymentReason -> Value # toEncoding :: CancelPaymentReason -> Encoding # toJSONList :: [CancelPaymentReason] -> Value # toEncodingList :: [CancelPaymentReason] -> Encoding # | |
| FromJSON CancelPaymentReason Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CancelPaymentReason # parseJSONList :: Value -> Parser [CancelPaymentReason] # | |
| HasCodec CancelPaymentReason Source # | |
Defined in Circle.Types | |
data RefundPaymentRequestBody Source #
Request body to refund a fiat payment.
Constructors
| RefundPaymentRequestBody | |
Fields | |
Instances
| Eq RefundPaymentRequestBody Source # | |
Defined in Circle.Types Methods (==) :: RefundPaymentRequestBody -> RefundPaymentRequestBody -> Bool # (/=) :: RefundPaymentRequestBody -> RefundPaymentRequestBody -> Bool # | |
| Show RefundPaymentRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> RefundPaymentRequestBody -> ShowS # show :: RefundPaymentRequestBody -> String # showList :: [RefundPaymentRequestBody] -> ShowS # | |
| ToJSON RefundPaymentRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: RefundPaymentRequestBody -> Value # toEncoding :: RefundPaymentRequestBody -> Encoding # toJSONList :: [RefundPaymentRequestBody] -> Value # | |
| FromJSON RefundPaymentRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser RefundPaymentRequestBody # parseJSONList :: Value -> Parser [RefundPaymentRequestBody] # | |
| HasCodec RefundPaymentRequestBody Source # | |
Defined in Circle.Types | |
data OnChainTransferRequest Source #
Instances
data OnChainTransfersRequest Source #
Instances
data OnChainAddressRequest Source #
Instances
data OnChainTransferRequestBody Source #
Request body to create an on-chain transfer
Constructors
| OnChainTransferRequestBody | |
Instances
| Eq OnChainTransferRequestBody Source # | |
Defined in Circle.Types Methods (==) :: OnChainTransferRequestBody -> OnChainTransferRequestBody -> Bool # (/=) :: OnChainTransferRequestBody -> OnChainTransferRequestBody -> Bool # | |
| Show OnChainTransferRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> OnChainTransferRequestBody -> ShowS # show :: OnChainTransferRequestBody -> String # showList :: [OnChainTransferRequestBody] -> ShowS # | |
| ToJSON OnChainTransferRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: OnChainTransferRequestBody -> Value # toEncoding :: OnChainTransferRequestBody -> Encoding # toJSONList :: [OnChainTransferRequestBody] -> Value # toEncodingList :: [OnChainTransferRequestBody] -> Encoding # | |
data CardsRequest Source #
Instances
| CircleHasParam CardsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam CardsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest CardsRequest Source # | |
Defined in Circle.Types | |
data CardRequest Source #
Instances
| type CircleRequest CardRequest Source # | |
Defined in Circle.Types | |
data ListCardResponseBody Source #
Response body for listAllCards
Constructors
Instances
| Eq ListCardResponseBody Source # | |
Defined in Circle.Types Methods (==) :: ListCardResponseBody -> ListCardResponseBody -> Bool # (/=) :: ListCardResponseBody -> ListCardResponseBody -> Bool # | |
| Show ListCardResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ListCardResponseBody -> ShowS # show :: ListCardResponseBody -> String # showList :: [ListCardResponseBody] -> ShowS # | |
| ToJSON ListCardResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: ListCardResponseBody -> Value # toEncoding :: ListCardResponseBody -> Encoding # toJSONList :: [ListCardResponseBody] -> Value # toEncodingList :: [ListCardResponseBody] -> Encoding # | |
| FromJSON ListCardResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ListCardResponseBody # parseJSONList :: Value -> Parser [ListCardResponseBody] # | |
| HasCodec ListCardResponseBody Source # | |
Defined in Circle.Types | |
data CardResponseBody Source #
Response body for methods that interface with an individual card: createCard, getCard, and updateCard
Constructors
| CardResponseBody | |
Fields
| |
Instances
| Eq CardResponseBody Source # | |
Defined in Circle.Types Methods (==) :: CardResponseBody -> CardResponseBody -> Bool # (/=) :: CardResponseBody -> CardResponseBody -> Bool # | |
| Show CardResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CardResponseBody -> ShowS # show :: CardResponseBody -> String # showList :: [CardResponseBody] -> ShowS # | |
| ToJSON CardResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: CardResponseBody -> Value # toEncoding :: CardResponseBody -> Encoding # toJSONList :: [CardResponseBody] -> Value # toEncodingList :: [CardResponseBody] -> Encoding # | |
| FromJSON CardResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CardResponseBody # parseJSONList :: Value -> Parser [CardResponseBody] # | |
| HasCodec CardResponseBody Source # | |
Defined in Circle.Types | |
data CreateCardRequestBody Source #
Request body to create a debit card.
Constructors
| CreateCardRequestBody | |
Fields | |
Instances
| Eq CreateCardRequestBody Source # | |
Defined in Circle.Types Methods (==) :: CreateCardRequestBody -> CreateCardRequestBody -> Bool # (/=) :: CreateCardRequestBody -> CreateCardRequestBody -> Bool # | |
| Show CreateCardRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreateCardRequestBody -> ShowS # show :: CreateCardRequestBody -> String # showList :: [CreateCardRequestBody] -> ShowS # | |
| ToJSON CreateCardRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: CreateCardRequestBody -> Value # toEncoding :: CreateCardRequestBody -> Encoding # toJSONList :: [CreateCardRequestBody] -> Value # toEncodingList :: [CreateCardRequestBody] -> Encoding # | |
| FromJSON CreateCardRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreateCardRequestBody # parseJSONList :: Value -> Parser [CreateCardRequestBody] # | |
| HasCodec CreateCardRequestBody Source # | |
Defined in Circle.Types | |
data UpdateCardRequestBody Source #
Request body to update a debit card.
Constructors
| UpdateCardRequestBody | |
Fields
| |
Instances
| Eq UpdateCardRequestBody Source # | |
Defined in Circle.Types Methods (==) :: UpdateCardRequestBody -> UpdateCardRequestBody -> Bool # (/=) :: UpdateCardRequestBody -> UpdateCardRequestBody -> Bool # | |
| Show UpdateCardRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> UpdateCardRequestBody -> ShowS # show :: UpdateCardRequestBody -> String # showList :: [UpdateCardRequestBody] -> ShowS # | |
| ToJSON UpdateCardRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: UpdateCardRequestBody -> Value # toEncoding :: UpdateCardRequestBody -> Encoding # toJSONList :: [UpdateCardRequestBody] -> Value # toEncodingList :: [UpdateCardRequestBody] -> Encoding # | |
| FromJSON UpdateCardRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser UpdateCardRequestBody # parseJSONList :: Value -> Parser [UpdateCardRequestBody] # | |
| HasCodec UpdateCardRequestBody Source # | |
Defined in Circle.Types | |
data ListCardBillingDetails Source #
Constructors
| ListCardBillingDetails | |
Instances
data CardNetwork Source #
Constructors
| VISA | |
| MASTERCARD | |
| AMEX | |
| UNKNOWN |
Instances
data CardFundingType Source #
Instances
data VerificationErrorCode Source #
Constructors
Instances
| Eq VerificationErrorCode Source # | |
Defined in Circle.Types Methods (==) :: VerificationErrorCode -> VerificationErrorCode -> Bool # (/=) :: VerificationErrorCode -> VerificationErrorCode -> Bool # | |
| Show VerificationErrorCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> VerificationErrorCode -> ShowS # show :: VerificationErrorCode -> String # showList :: [VerificationErrorCode] -> ShowS # | |
| ToJSON VerificationErrorCode Source # | |
Defined in Circle.Types Methods toJSON :: VerificationErrorCode -> Value # toEncoding :: VerificationErrorCode -> Encoding # toJSONList :: [VerificationErrorCode] -> Value # toEncodingList :: [VerificationErrorCode] -> Encoding # | |
| FromJSON VerificationErrorCode Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser VerificationErrorCode # parseJSONList :: Value -> Parser [VerificationErrorCode] # | |
| HasCodec VerificationErrorCode Source # | |
Defined in Circle.Types | |
data ACHBankAccountRequest Source #
Instances
data ACHBankAccountResponseBody Source #
Response body for createACHAccount and getACHAccount
Constructors
Instances
data ACHBankAccountErrorCode Source #
Constructors
Instances
| Eq ACHBankAccountErrorCode Source # | |
Defined in Circle.Types Methods (==) :: ACHBankAccountErrorCode -> ACHBankAccountErrorCode -> Bool # (/=) :: ACHBankAccountErrorCode -> ACHBankAccountErrorCode -> Bool # | |
| Show ACHBankAccountErrorCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ACHBankAccountErrorCode -> ShowS # show :: ACHBankAccountErrorCode -> String # showList :: [ACHBankAccountErrorCode] -> ShowS # | |
| ToJSON ACHBankAccountErrorCode Source # | |
Defined in Circle.Types Methods toJSON :: ACHBankAccountErrorCode -> Value # toEncoding :: ACHBankAccountErrorCode -> Encoding # toJSONList :: [ACHBankAccountErrorCode] -> Value # | |
| FromJSON ACHBankAccountErrorCode Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ACHBankAccountErrorCode # parseJSONList :: Value -> Parser [ACHBankAccountErrorCode] # | |
| HasCodec ACHBankAccountErrorCode Source # | |
Defined in Circle.Types | |
data CreateACHBankAccountRequestBody Source #
Request body to an ACH bank account.
Constructors
| CreateACHBankAccountRequestBody | |
Instances
| Eq CreateACHBankAccountRequestBody Source # | |
Defined in Circle.Types | |
| Show CreateACHBankAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreateACHBankAccountRequestBody -> ShowS # | |
| ToJSON CreateACHBankAccountRequestBody Source # | |
Defined in Circle.Types | |
| FromJSON CreateACHBankAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreateACHBankAccountRequestBody # parseJSONList :: Value -> Parser [CreateACHBankAccountRequestBody] # | |
| HasCodec CreateACHBankAccountRequestBody Source # | |
Defined in Circle.Types | |
data MockAccountRequest Source #
Instances
data CreateMockACHBankAccountRequestBody Source #
Request body to create a mock ACH bank account (in the sandbox only).
Constructors
| CreateMockACHBankAccountRequestBody | |
Instances
| Eq CreateMockACHBankAccountRequestBody Source # | |
Defined in Circle.Types | |
| Show CreateMockACHBankAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreateMockACHBankAccountRequestBody -> ShowS # show :: CreateMockACHBankAccountRequestBody -> String # showList :: [CreateMockACHBankAccountRequestBody] -> ShowS # | |
| ToJSON CreateMockACHBankAccountRequestBody Source # | |
Defined in Circle.Types | |
| FromJSON CreateMockACHBankAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreateMockACHBankAccountRequestBody # parseJSONList :: Value -> Parser [CreateMockACHBankAccountRequestBody] # | |
| HasCodec CreateMockACHBankAccountRequestBody Source # | |
data MockACHBankAccountResponseBody Source #
Response body for methods that call the "mocks/ach/account" endpoint
Constructors
| MockACHBankAccountResponseBody | |
Instances
| Eq MockACHBankAccountResponseBody Source # | |
Defined in Circle.Types | |
| Show MockACHBankAccountResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> MockACHBankAccountResponseBody -> ShowS # show :: MockACHBankAccountResponseBody -> String # showList :: [MockACHBankAccountResponseBody] -> ShowS # | |
| ToJSON MockACHBankAccountResponseBody Source # | |
Defined in Circle.Types | |
| FromJSON MockACHBankAccountResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser MockACHBankAccountResponseBody # parseJSONList :: Value -> Parser [MockACHBankAccountResponseBody] # | |
| HasCodec MockACHBankAccountResponseBody Source # | |
Defined in Circle.Types | |
data MockACHBankAccount Source #
Constructors
| MockACHBankAccount | |
Instances
| Eq MockACHBankAccount Source # | |
Defined in Circle.Types Methods (==) :: MockACHBankAccount -> MockACHBankAccount -> Bool # (/=) :: MockACHBankAccount -> MockACHBankAccount -> Bool # | |
| Show MockACHBankAccount Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> MockACHBankAccount -> ShowS # show :: MockACHBankAccount -> String # showList :: [MockACHBankAccount] -> ShowS # | |
| ToJSON MockACHBankAccount Source # | |
Defined in Circle.Types Methods toJSON :: MockACHBankAccount -> Value # toEncoding :: MockACHBankAccount -> Encoding # toJSONList :: [MockACHBankAccount] -> Value # toEncodingList :: [MockACHBankAccount] -> Encoding # | |
| FromJSON MockACHBankAccount Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser MockACHBankAccount # parseJSONList :: Value -> Parser [MockACHBankAccount] # | |
| HasCodec MockACHBankAccount Source # | |
Defined in Circle.Types | |
data MockRoutingNumber Source #
Constructors
| MockRoutingNumber1 | |
| MockRoutingNumber2 | |
| MockRoutingNumber3 | |
| MockRoutingNumber4 | |
| MockRoutingNumber5 | |
| MockRoutingNumber6 | |
| MockRoutingNumber7 | |
| MockRoutingNumber8 | |
| MockRoutingNumber9 |
Instances
data SEPAAccountRequest Source #
Instances
| type CircleRequest SEPAAccountRequest Source # | |
Defined in Circle.Types | |
data SEPAInstructionsRequest Source #
Instances
data SEPAAccountRequestBody Source #
Request body to create a SEPA account.
Constructors
| SEPAAccountRequestBody | |
Instances
| Eq SEPAAccountRequestBody Source # | |
Defined in Circle.Types Methods (==) :: SEPAAccountRequestBody -> SEPAAccountRequestBody -> Bool # (/=) :: SEPAAccountRequestBody -> SEPAAccountRequestBody -> Bool # | |
| Show SEPAAccountRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SEPAAccountRequestBody -> ShowS # show :: SEPAAccountRequestBody -> String # showList :: [SEPAAccountRequestBody] -> ShowS # | |
| ToJSON SEPAAccountRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: SEPAAccountRequestBody -> Value # toEncoding :: SEPAAccountRequestBody -> Encoding # toJSONList :: [SEPAAccountRequestBody] -> Value # | |
| FromJSON SEPAAccountRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SEPAAccountRequestBody # parseJSONList :: Value -> Parser [SEPAAccountRequestBody] # | |
| HasCodec SEPAAccountRequestBody Source # | |
Defined in Circle.Types | |
data SEPAAccountResponseBody Source #
Response body for methods that call the "banks/sepa" endpoint
Constructors
Instances
| Eq SEPAAccountResponseBody Source # | |
Defined in Circle.Types Methods (==) :: SEPAAccountResponseBody -> SEPAAccountResponseBody -> Bool # (/=) :: SEPAAccountResponseBody -> SEPAAccountResponseBody -> Bool # | |
| Show SEPAAccountResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SEPAAccountResponseBody -> ShowS # show :: SEPAAccountResponseBody -> String # showList :: [SEPAAccountResponseBody] -> ShowS # | |
| ToJSON SEPAAccountResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: SEPAAccountResponseBody -> Value # toEncoding :: SEPAAccountResponseBody -> Encoding # toJSONList :: [SEPAAccountResponseBody] -> Value # | |
| FromJSON SEPAAccountResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SEPAAccountResponseBody # parseJSONList :: Value -> Parser [SEPAAccountResponseBody] # | |
| HasCodec SEPAAccountResponseBody Source # | |
Defined in Circle.Types | |
data SettlementRequest Source #
Instances
| type CircleRequest SettlementRequest Source # | |
Defined in Circle.Types | |
data SettlementsRequest Source #
Instances
| CircleHasParam SettlementsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam SettlementsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam SettlementsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam SettlementsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest SettlementsRequest Source # | |
Defined in Circle.Types | |
data SettlementResponseBody Source #
Response body for methods that call the "settlements" endpoint
Constructors
Instances
| Eq SettlementResponseBody Source # | |
Defined in Circle.Types Methods (==) :: SettlementResponseBody -> SettlementResponseBody -> Bool # (/=) :: SettlementResponseBody -> SettlementResponseBody -> Bool # | |
| Show SettlementResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> SettlementResponseBody -> ShowS # show :: SettlementResponseBody -> String # showList :: [SettlementResponseBody] -> ShowS # | |
| ToJSON SettlementResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: SettlementResponseBody -> Value # toEncoding :: SettlementResponseBody -> Encoding # toJSONList :: [SettlementResponseBody] -> Value # | |
| FromJSON SettlementResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser SettlementResponseBody # parseJSONList :: Value -> Parser [SettlementResponseBody] # | |
| HasCodec SettlementResponseBody Source # | |
Defined in Circle.Types | |
data ChargebacksRequest Source #
Instances
| CircleHasParam ChargebacksRequest PaymentIdQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ChargebacksRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ChargebacksRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ChargebacksRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ChargebacksRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest ChargebacksRequest Source # | |
Defined in Circle.Types | |
data ChargebackRequest Source #
Instances
| type CircleRequest ChargebackRequest Source # | |
Defined in Circle.Types | |
data MockChargebackRequest Source #
Instances
data ChargebackResponseBody Source #
Response body for methods that call the "cards/chargebacks" and "mocks/cards/chargebacks" endpoints
Constructors
| ChargebackResponseBody | |
Instances
| Eq ChargebackResponseBody Source # | |
Defined in Circle.Types Methods (==) :: ChargebackResponseBody -> ChargebackResponseBody -> Bool # (/=) :: ChargebackResponseBody -> ChargebackResponseBody -> Bool # | |
| Show ChargebackResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ChargebackResponseBody -> ShowS # show :: ChargebackResponseBody -> String # showList :: [ChargebackResponseBody] -> ShowS # | |
| ToJSON ChargebackResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: ChargebackResponseBody -> Value # toEncoding :: ChargebackResponseBody -> Encoding # toJSONList :: [ChargebackResponseBody] -> Value # | |
| FromJSON ChargebackResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ChargebackResponseBody # parseJSONList :: Value -> Parser [ChargebackResponseBody] # | |
| HasCodec ChargebackResponseBody Source # | |
Defined in Circle.Types | |
data ChargebackCategory Source #
Instances
data ChargebackHistory Source #
Constructors
| ChargebackHistory | |
Instances
| Eq ChargebackHistory Source # | |
Defined in Circle.Types Methods (==) :: ChargebackHistory -> ChargebackHistory -> Bool # (/=) :: ChargebackHistory -> ChargebackHistory -> Bool # | |
| Show ChargebackHistory Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ChargebackHistory -> ShowS # show :: ChargebackHistory -> String # showList :: [ChargebackHistory] -> ShowS # | |
| ToJSON ChargebackHistory Source # | |
Defined in Circle.Types Methods toJSON :: ChargebackHistory -> Value # toEncoding :: ChargebackHistory -> Encoding # toJSONList :: [ChargebackHistory] -> Value # toEncodingList :: [ChargebackHistory] -> Encoding # | |
| FromJSON ChargebackHistory Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ChargebackHistory # parseJSONList :: Value -> Parser [ChargebackHistory] # | |
| HasCodec ChargebackHistory Source # | |
Defined in Circle.Types | |
data ChargebackHistoryType Source #
Instances
data ReversalsRequest Source #
Instances
| CircleHasParam ReversalsRequest PaymentStatusQueryParams Source # | |
Defined in Circle.Types | |
| CircleHasParam ReversalsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReversalsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReversalsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReversalsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest ReversalsRequest Source # | |
Defined in Circle.Types | |
data ReversalResponseBody Source #
Response body for methods that call the "reversals" endpoint
Constructors
Instances
| Eq ReversalResponseBody Source # | |
Defined in Circle.Types Methods (==) :: ReversalResponseBody -> ReversalResponseBody -> Bool # (/=) :: ReversalResponseBody -> ReversalResponseBody -> Bool # | |
| Show ReversalResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ReversalResponseBody -> ShowS # show :: ReversalResponseBody -> String # showList :: [ReversalResponseBody] -> ShowS # | |
| ToJSON ReversalResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: ReversalResponseBody -> Value # toEncoding :: ReversalResponseBody -> Encoding # toJSONList :: [ReversalResponseBody] -> Value # toEncodingList :: [ReversalResponseBody] -> Encoding # | |
| FromJSON ReversalResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ReversalResponseBody # parseJSONList :: Value -> Parser [ReversalResponseBody] # | |
| HasCodec ReversalResponseBody Source # | |
Defined in Circle.Types | |
data ReversalReason Source #
Constructors
Instances
data PaymentIntentRequest Source #
Instances
data PaymentIntentsRequest Source #
Instances
data CreatePaymentIntentRequestBody Source #
Request body to create a payment intent for a blockchain payment
Constructors
| CreatePaymentIntentRequestBody | |
Instances
| Eq CreatePaymentIntentRequestBody Source # | |
Defined in Circle.Types | |
| Show CreatePaymentIntentRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreatePaymentIntentRequestBody -> ShowS # show :: CreatePaymentIntentRequestBody -> String # showList :: [CreatePaymentIntentRequestBody] -> ShowS # | |
| ToJSON CreatePaymentIntentRequestBody Source # | |
Defined in Circle.Types | |
| FromJSON CreatePaymentIntentRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreatePaymentIntentRequestBody # parseJSONList :: Value -> Parser [CreatePaymentIntentRequestBody] # | |
| HasCodec CreatePaymentIntentRequestBody Source # | |
Defined in Circle.Types | |
data PaymentIntentResponseBody Source #
Response body for methods that call the "paymentIntents" endpoint
Constructors
Instances
| Eq PaymentIntentResponseBody Source # | |
Defined in Circle.Types Methods (==) :: PaymentIntentResponseBody -> PaymentIntentResponseBody -> Bool # (/=) :: PaymentIntentResponseBody -> PaymentIntentResponseBody -> Bool # | |
| Show PaymentIntentResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentResponseBody -> ShowS # show :: PaymentIntentResponseBody -> String # showList :: [PaymentIntentResponseBody] -> ShowS # | |
| ToJSON PaymentIntentResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: PaymentIntentResponseBody -> Value # toEncoding :: PaymentIntentResponseBody -> Encoding # toJSONList :: [PaymentIntentResponseBody] -> Value # | |
| FromJSON PaymentIntentResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentIntentResponseBody # parseJSONList :: Value -> Parser [PaymentIntentResponseBody] # | |
| HasCodec PaymentIntentResponseBody Source # | |
Defined in Circle.Types | |
data PaymentMethodData Source #
Constructors
| PaymentMethodData | |
Fields | |
Instances
| Eq PaymentMethodData Source # | |
Defined in Circle.Types Methods (==) :: PaymentMethodData -> PaymentMethodData -> Bool # (/=) :: PaymentMethodData -> PaymentMethodData -> Bool # | |
| Show PaymentMethodData Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentMethodData -> ShowS # show :: PaymentMethodData -> String # showList :: [PaymentMethodData] -> ShowS # | |
| ToJSON PaymentMethodData Source # | |
Defined in Circle.Types Methods toJSON :: PaymentMethodData -> Value # toEncoding :: PaymentMethodData -> Encoding # toJSONList :: [PaymentMethodData] -> Value # toEncodingList :: [PaymentMethodData] -> Encoding # | |
| FromJSON PaymentMethodData Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentMethodData # parseJSONList :: Value -> Parser [PaymentMethodData] # | |
| HasCodec PaymentMethodData Source # | |
Defined in Circle.Types | |
data TimelineData Source #
Constructors
| TimelineData | |
Instances
| Eq TimelineData Source # | |
Defined in Circle.Types | |
| Show TimelineData Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TimelineData -> ShowS # show :: TimelineData -> String # showList :: [TimelineData] -> ShowS # | |
| ToJSON TimelineData Source # | |
Defined in Circle.Types Methods toJSON :: TimelineData -> Value # toEncoding :: TimelineData -> Encoding # toJSONList :: [TimelineData] -> Value # toEncodingList :: [TimelineData] -> Encoding # | |
| FromJSON TimelineData Source # | |
Defined in Circle.Types | |
| HasCodec TimelineData Source # | |
Defined in Circle.Types Methods codec :: JSONCodec TimelineData # listCodecForStringCompatibility :: JSONCodec [TimelineData] # | |
data ReturnsRequest Source #
Instances
| CircleHasParam ReturnsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReturnsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReturnsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam ReturnsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest ReturnsRequest Source # | |
Defined in Circle.Types | |
data WalletRequest Source #
Instances
| type CircleRequest WalletRequest Source # | |
Defined in Circle.Types | |
data WalletsRequest Source #
Instances
| CircleHasParam WalletsRequest PageSizeQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam WalletsRequest ToQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam WalletsRequest FromQueryParam Source # | |
Defined in Circle.Types | |
| CircleHasParam WalletsRequest PaginationQueryParams Source # | |
Defined in Circle.Types | |
| type CircleRequest WalletsRequest Source # | |
Defined in Circle.Types | |
data WalletResponseBody Source #
Response body for methods that call the "wallets" endpoint
Constructors
| WalletResponseBody | |
Instances
| Eq WalletResponseBody Source # | |
Defined in Circle.Types Methods (==) :: WalletResponseBody -> WalletResponseBody -> Bool # (/=) :: WalletResponseBody -> WalletResponseBody -> Bool # | |
| Show WalletResponseBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> WalletResponseBody -> ShowS # show :: WalletResponseBody -> String # showList :: [WalletResponseBody] -> ShowS # | |
| ToJSON WalletResponseBody Source # | |
Defined in Circle.Types Methods toJSON :: WalletResponseBody -> Value # toEncoding :: WalletResponseBody -> Encoding # toJSONList :: [WalletResponseBody] -> Value # toEncodingList :: [WalletResponseBody] -> Encoding # | |
| FromJSON WalletResponseBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser WalletResponseBody # parseJSONList :: Value -> Parser [WalletResponseBody] # | |
| HasCodec WalletResponseBody Source # | |
Defined in Circle.Types | |
data CreateWalletRequestBody Source #
Request body to create a Circle wallet.
Constructors
| CreateWalletRequestBody | |
Instances
| Eq CreateWalletRequestBody Source # | |
Defined in Circle.Types Methods (==) :: CreateWalletRequestBody -> CreateWalletRequestBody -> Bool # (/=) :: CreateWalletRequestBody -> CreateWalletRequestBody -> Bool # | |
| Show CreateWalletRequestBody Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> CreateWalletRequestBody -> ShowS # show :: CreateWalletRequestBody -> String # showList :: [CreateWalletRequestBody] -> ShowS # | |
| ToJSON CreateWalletRequestBody Source # | |
Defined in Circle.Types Methods toJSON :: CreateWalletRequestBody -> Value # toEncoding :: CreateWalletRequestBody -> Encoding # toJSONList :: [CreateWalletRequestBody] -> Value # | |
| FromJSON CreateWalletRequestBody Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser CreateWalletRequestBody # parseJSONList :: Value -> Parser [CreateWalletRequestBody] # | |
| HasCodec CreateWalletRequestBody Source # | |
Defined in Circle.Types | |
utcToCircle :: UTCTime -> Text Source #
data ThisOrThat a b Source #
Similar to Either but with different ToJSON and FromJSON instances.
ToJSON will serialize the payload without adding any kind of tag.
FromJSON will first attempt to parse JSON as the first type parameter,
and if that fails will then attempt to parse as the second type parameter.
NB: The order of type parameters make a huge difference!
In ThisOrThat A BA is structurally a subtype of B, then the
parser can never produce a That result! For example, with types
data A = A {foo :: String, bar :: Scientific}
data B = B {foo :: String, bar :: Scientific, baz :: Bool}
FromJSON (ThisOrThat A B)B. Any JSON object
that includes properties foo: string and bar: number will parse
as an A, whether or not the property baz: boolean is present. You
can fix this by instead using ThisOrThat B A
Instances
catThises :: [ThisOrThat a b] -> [a] Source #
catThats :: [ThisOrThat a b] -> [b] Source #
thisOrThatToEither :: ThisOrThat a b -> Either a b Source #
thisOrThat :: (a -> c) -> (b -> c) -> ThisOrThat a b -> c Source #
data PaymentStatus Source #
Constructors
| PaymentPending | |
| Confirmed | |
| Paid | |
| PaymentFailed | |
| ActionRequired |
Instances
| Eq PaymentStatus Source # | |
Defined in Circle.Types Methods (==) :: PaymentStatus -> PaymentStatus -> Bool # (/=) :: PaymentStatus -> PaymentStatus -> Bool # | |
| Show PaymentStatus Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentStatus -> ShowS # show :: PaymentStatus -> String # showList :: [PaymentStatus] -> ShowS # | |
| ToJSON PaymentStatus Source # | |
Defined in Circle.Types Methods toJSON :: PaymentStatus -> Value # toEncoding :: PaymentStatus -> Encoding # toJSONList :: [PaymentStatus] -> Value # toEncodingList :: [PaymentStatus] -> Encoding # | |
| FromJSON PaymentStatus Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentStatus # parseJSONList :: Value -> Parser [PaymentStatus] # | |
| HasCodec PaymentStatus Source # | |
Defined in Circle.Types Methods codec :: JSONCodec PaymentStatus # listCodecForStringCompatibility :: JSONCodec [PaymentStatus] # | |
data PaymentIntentStatus Source #
Constructors
| PaymentIntentCreated | |
| PaymentIntentPending | |
| PaymentIntentComplete | |
| PaymentIntentExpired | |
| PaymentIntentFailed |
Instances
| Eq PaymentIntentStatus Source # | |
Defined in Circle.Types Methods (==) :: PaymentIntentStatus -> PaymentIntentStatus -> Bool # (/=) :: PaymentIntentStatus -> PaymentIntentStatus -> Bool # | |
| Show PaymentIntentStatus Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentStatus -> ShowS # show :: PaymentIntentStatus -> String # showList :: [PaymentIntentStatus] -> ShowS # | |
| ToJSON PaymentIntentStatus Source # | |
Defined in Circle.Types Methods toJSON :: PaymentIntentStatus -> Value # toEncoding :: PaymentIntentStatus -> Encoding # toJSONList :: [PaymentIntentStatus] -> Value # toEncodingList :: [PaymentIntentStatus] -> Encoding # | |
| FromJSON PaymentIntentStatus Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentIntentStatus # parseJSONList :: Value -> Parser [PaymentIntentStatus] # | |
| HasCodec PaymentIntentStatus Source # | |
Defined in Circle.Types | |
data PaymentIntentContext Source #
Constructors
| ContextUnderpaid | |
| ContextPaid | |
| ContextOverpaid |
Instances
| Eq PaymentIntentContext Source # | |
Defined in Circle.Types Methods (==) :: PaymentIntentContext -> PaymentIntentContext -> Bool # (/=) :: PaymentIntentContext -> PaymentIntentContext -> Bool # | |
| Show PaymentIntentContext Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PaymentIntentContext -> ShowS # show :: PaymentIntentContext -> String # showList :: [PaymentIntentContext] -> ShowS # | |
| ToJSON PaymentIntentContext Source # | |
Defined in Circle.Types Methods toJSON :: PaymentIntentContext -> Value # toEncoding :: PaymentIntentContext -> Encoding # toJSONList :: [PaymentIntentContext] -> Value # toEncodingList :: [PaymentIntentContext] -> Encoding # | |
| FromJSON PaymentIntentContext Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser PaymentIntentContext # parseJSONList :: Value -> Parser [PaymentIntentContext] # | |
| HasCodec PaymentIntentContext Source # | |
Defined in Circle.Types | |
Constructors
| Address | |
Fields
| |
data BankAccountType Source #
Instances
| Eq BankAccountType Source # | |
Defined in Circle.Types Methods (==) :: BankAccountType -> BankAccountType -> Bool # (/=) :: BankAccountType -> BankAccountType -> Bool # | |
| Show BankAccountType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BankAccountType -> ShowS # show :: BankAccountType -> String # showList :: [BankAccountType] -> ShowS # | |
| ToJSON BankAccountType Source # | |
Defined in Circle.Types Methods toJSON :: BankAccountType -> Value # toEncoding :: BankAccountType -> Encoding # toJSONList :: [BankAccountType] -> Value # toEncodingList :: [BankAccountType] -> Encoding # | |
| FromJSON BankAccountType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser BankAccountType # parseJSONList :: Value -> Parser [BankAccountType] # | |
| HasCodec BankAccountType Source # | |
Defined in Circle.Types | |
data ACHBankAccountType Source #
Constructors
| RetailType | |
| BusinessType |
Instances
| Eq ACHBankAccountType Source # | |
Defined in Circle.Types Methods (==) :: ACHBankAccountType -> ACHBankAccountType -> Bool # (/=) :: ACHBankAccountType -> ACHBankAccountType -> Bool # | |
| Show ACHBankAccountType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ACHBankAccountType -> ShowS # show :: ACHBankAccountType -> String # showList :: [ACHBankAccountType] -> ShowS # | |
| ToJSON ACHBankAccountType Source # | |
Defined in Circle.Types Methods toJSON :: ACHBankAccountType -> Value # toEncoding :: ACHBankAccountType -> Encoding # toJSONList :: [ACHBankAccountType] -> Value # toEncodingList :: [ACHBankAccountType] -> Encoding # | |
| FromJSON ACHBankAccountType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ACHBankAccountType # parseJSONList :: Value -> Parser [ACHBankAccountType] # | |
| HasCodec ACHBankAccountType Source # | |
Defined in Circle.Types | |
data DestinationBankAccount Source #
Constructors
| DestinationBankAccount | |
Fields | |
Instances
| Eq DestinationBankAccount Source # | |
Defined in Circle.Types Methods (==) :: DestinationBankAccount -> DestinationBankAccount -> Bool # (/=) :: DestinationBankAccount -> DestinationBankAccount -> Bool # | |
| Show DestinationBankAccount Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> DestinationBankAccount -> ShowS # show :: DestinationBankAccount -> String # showList :: [DestinationBankAccount] -> ShowS # | |
| ToJSON DestinationBankAccount Source # | |
Defined in Circle.Types Methods toJSON :: DestinationBankAccount -> Value # toEncoding :: DestinationBankAccount -> Encoding # toJSONList :: [DestinationBankAccount] -> Value # | |
| FromJSON DestinationBankAccount Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser DestinationBankAccount # parseJSONList :: Value -> Parser [DestinationBankAccount] # | |
| HasCodec DestinationBankAccount Source # | |
Defined in Circle.Types | |
data SupportedCurrencies Source #
Instances
data BlockchainFeeType Source #
Constructors
| BlockchainLeaseFee | |
| TotalPaymentFees |
Instances
| Eq BlockchainFeeType Source # | |
Defined in Circle.Types Methods (==) :: BlockchainFeeType -> BlockchainFeeType -> Bool # (/=) :: BlockchainFeeType -> BlockchainFeeType -> Bool # | |
| Show BlockchainFeeType Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BlockchainFeeType -> ShowS # show :: BlockchainFeeType -> String # showList :: [BlockchainFeeType] -> ShowS # | |
| ToJSON BlockchainFeeType Source # | |
Defined in Circle.Types Methods toJSON :: BlockchainFeeType -> Value # toEncoding :: BlockchainFeeType -> Encoding # toJSONList :: [BlockchainFeeType] -> Value # toEncodingList :: [BlockchainFeeType] -> Encoding # | |
| FromJSON BlockchainFeeType Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser BlockchainFeeType # parseJSONList :: Value -> Parser [BlockchainFeeType] # | |
| HasCodec BlockchainFeeType Source # | |
Defined in Circle.Types | |
data BlockchainFeeMoneyAmount Source #
Constructors
| BlockchainFeeMoneyAmount | |
Instances
data MoneyAmount Source #
Constructors
| MoneyAmount | |
Fields | |
Instances
data TransferFeeAmount Source #
Constructors
| TransferFeeAmount | |
Instances
data RiskEvaluation Source #
Constructors
| RiskEvaluation | |
Fields | |
Instances
data Adjustments Source #
Constructors
| Adjustments | |
Fields | |
Instances
data BillingDetails Source #
Constructors
| BillingDetails | |
Fields | |
Instances
data BankAddress Source #
Constructors
| BankAddress | |
Fields
| |
Instances
| Eq BankAddress Source # | |
Defined in Circle.Types | |
| Show BankAddress Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BankAddress -> ShowS # show :: BankAddress -> String # showList :: [BankAddress] -> ShowS # | |
| ToJSON BankAddress Source # | |
Defined in Circle.Types Methods toJSON :: BankAddress -> Value # toEncoding :: BankAddress -> Encoding # toJSONList :: [BankAddress] -> Value # toEncodingList :: [BankAddress] -> Encoding # | |
| FromJSON BankAddress Source # | |
Defined in Circle.Types | |
| HasCodec BankAddress Source # | |
Defined in Circle.Types | |
data BeneficiaryDetails Source #
Constructors
| BeneficiaryDetails | |
Fields | |
Instances
| Eq BeneficiaryDetails Source # | |
Defined in Circle.Types Methods (==) :: BeneficiaryDetails -> BeneficiaryDetails -> Bool # (/=) :: BeneficiaryDetails -> BeneficiaryDetails -> Bool # | |
| Show BeneficiaryDetails Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BeneficiaryDetails -> ShowS # show :: BeneficiaryDetails -> String # showList :: [BeneficiaryDetails] -> ShowS # | |
| ToJSON BeneficiaryDetails Source # | |
Defined in Circle.Types Methods toJSON :: BeneficiaryDetails -> Value # toEncoding :: BeneficiaryDetails -> Encoding # toJSONList :: [BeneficiaryDetails] -> Value # toEncodingList :: [BeneficiaryDetails] -> Encoding # | |
| FromJSON BeneficiaryDetails Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser BeneficiaryDetails # parseJSONList :: Value -> Parser [BeneficiaryDetails] # | |
| HasCodec BeneficiaryDetails Source # | |
Defined in Circle.Types | |
data BeneficiaryBankDetails Source #
Constructors
Instances
| Eq BeneficiaryBankDetails Source # | |
Defined in Circle.Types Methods (==) :: BeneficiaryBankDetails -> BeneficiaryBankDetails -> Bool # (/=) :: BeneficiaryBankDetails -> BeneficiaryBankDetails -> Bool # | |
| Show BeneficiaryBankDetails Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> BeneficiaryBankDetails -> ShowS # show :: BeneficiaryBankDetails -> String # showList :: [BeneficiaryBankDetails] -> ShowS # | |
| ToJSON BeneficiaryBankDetails Source # | |
Defined in Circle.Types Methods toJSON :: BeneficiaryBankDetails -> Value # toEncoding :: BeneficiaryBankDetails -> Encoding # toJSONList :: [BeneficiaryBankDetails] -> Value # | |
| FromJSON BeneficiaryBankDetails Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser BeneficiaryBankDetails # parseJSONList :: Value -> Parser [BeneficiaryBankDetails] # | |
| HasCodec BeneficiaryBankDetails Source # | |
Defined in Circle.Types | |
newtype ProcessorToken Source #
Constructors
| ProcessorToken | |
Fields | |
Instances
| Eq ProcessorToken Source # | |
Defined in Circle.Types Methods (==) :: ProcessorToken -> ProcessorToken -> Bool # (/=) :: ProcessorToken -> ProcessorToken -> Bool # | |
| Show ProcessorToken Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> ProcessorToken -> ShowS # show :: ProcessorToken -> String # showList :: [ProcessorToken] -> ShowS # | |
| ToJSON ProcessorToken Source # | |
Defined in Circle.Types Methods toJSON :: ProcessorToken -> Value # toEncoding :: ProcessorToken -> Encoding # toJSONList :: [ProcessorToken] -> Value # toEncodingList :: [ProcessorToken] -> Encoding # | |
| FromJSON ProcessorToken Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser ProcessorToken # parseJSONList :: Value -> Parser [ProcessorToken] # | |
| HasCodec ProcessorToken Source # | |
Defined in Circle.Types Methods codec :: JSONCodec ProcessorToken # listCodecForStringCompatibility :: JSONCodec [ProcessorToken] # | |
newtype AddressLine Source #
Constructors
| AddressLine | |
Fields | |
Instances
| Eq AddressLine Source # | |
Defined in Circle.Types | |
| Show AddressLine Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> AddressLine -> ShowS # show :: AddressLine -> String # showList :: [AddressLine] -> ShowS # | |
| ToJSON AddressLine Source # | |
Defined in Circle.Types Methods toJSON :: AddressLine -> Value # toEncoding :: AddressLine -> Encoding # toJSONList :: [AddressLine] -> Value # toEncodingList :: [AddressLine] -> Encoding # | |
| FromJSON AddressLine Source # | |
Defined in Circle.Types | |
| HasCodec AddressLine Source # | |
Defined in Circle.Types | |
urlToByteString :: URL -> ByteString Source #
newtype AccountNumber Source #
Constructors
| AccountNumber | |
Fields | |
Instances
| Eq AccountNumber Source # | |
Defined in Circle.Types Methods (==) :: AccountNumber -> AccountNumber -> Bool # (/=) :: AccountNumber -> AccountNumber -> Bool # | |
| Show AccountNumber Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> AccountNumber -> ShowS # show :: AccountNumber -> String # showList :: [AccountNumber] -> ShowS # | |
| ToJSON AccountNumber Source # | |
Defined in Circle.Types Methods toJSON :: AccountNumber -> Value # toEncoding :: AccountNumber -> Encoding # toJSONList :: [AccountNumber] -> Value # toEncodingList :: [AccountNumber] -> Encoding # | |
| FromJSON AccountNumber Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser AccountNumber # parseJSONList :: Value -> Parser [AccountNumber] # | |
| HasCodec AccountNumber Source # | |
Defined in Circle.Types Methods codec :: JSONCodec AccountNumber # listCodecForStringCompatibility :: JSONCodec [AccountNumber] # | |
| Lift AccountNumber Source # | |
Defined in Circle.Types | |
mkAccountNumber :: Text -> Maybe AccountNumber Source #
type AccountNumberMask = Refined (SizeEqualTo 4) Text Source #
newtype RoutingNumber Source #
Constructors
| RoutingNumber | |
Fields | |
Instances
| Eq RoutingNumber Source # | |
Defined in Circle.Types Methods (==) :: RoutingNumber -> RoutingNumber -> Bool # (/=) :: RoutingNumber -> RoutingNumber -> Bool # | |
| Show RoutingNumber Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> RoutingNumber -> ShowS # show :: RoutingNumber -> String # showList :: [RoutingNumber] -> ShowS # | |
| ToJSON RoutingNumber Source # | |
Defined in Circle.Types Methods toJSON :: RoutingNumber -> Value # toEncoding :: RoutingNumber -> Encoding # toJSONList :: [RoutingNumber] -> Value # toEncodingList :: [RoutingNumber] -> Encoding # | |
| FromJSON RoutingNumber Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser RoutingNumber # parseJSONList :: Value -> Parser [RoutingNumber] # | |
| HasCodec RoutingNumber Source # | |
Defined in Circle.Types Methods codec :: JSONCodec RoutingNumber # listCodecForStringCompatibility :: JSONCodec [RoutingNumber] # | |
| Lift RoutingNumber Source # | |
Defined in Circle.Types | |
mkRoutingNumber :: Text -> Maybe RoutingNumber Source #
ibanToText :: Iban -> Text Source #
A newtype around email text. This newtype verifies the email is formatted correctly using HTML5's email regexp https://www.w3.org/TR/html5/forms.html#valid-e-mail-address
Constructors
Fields
| |
emailRegex :: Regex Source #
mkEmail :: Text -> Maybe Email Source #
Attempt to create an email from text, returning Nothing if it doesn't
match our email regular expression.
emailToByteString :: Email -> ByteString Source #
Convenience function for APIs that take emails as ByteString
compileEmail :: QuasiQuoter Source #
Create an email at compile time Usage: > [compileEmail|dmarticus@gmail.com|]
newtype PostalCode Source #
Constructors
| PostalCode | |
Fields
| |
Instances
| Eq PostalCode Source # | |
Defined in Circle.Types | |
| Show PostalCode Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> PostalCode -> ShowS # show :: PostalCode -> String # showList :: [PostalCode] -> ShowS # | |
| ToJSON PostalCode Source # | |
Defined in Circle.Types Methods toJSON :: PostalCode -> Value # toEncoding :: PostalCode -> Encoding # toJSONList :: [PostalCode] -> Value # toEncodingList :: [PostalCode] -> Encoding # | |
| FromJSON PostalCode Source # | |
Defined in Circle.Types | |
| HasCodec PostalCode Source # | |
Defined in Circle.Types | |
Constructors
| SwiftCode | |
Fields
| |
Instances
| Eq SwiftCode Source # | |
| Ord SwiftCode Source # | |
| Show SwiftCode Source # | |
| ToJSON SwiftCode Source # | |
Defined in Circle.Types | |
| FromJSON SwiftCode Source # | |
| HasCodec SwiftCode Source # | |
Defined in Circle.Types | |
| Lift SwiftCode Source # | |
swiftCodeToText :: SwiftCode -> Text Source #
getCountryFromSwiftCodeText :: Text -> Text Source #
Extracts an ISO 3166-1 alpha-2 country code (or XK for Kosovo) from a SWIFT code, e.g. BOFAUS3N -> US
get8DigitSwiftCode :: SwiftCode -> SwiftCode Source #
SwiftCodes can be either 11 or 8 digits, this ensures you're always working with the 8 digit variety.
getBranchCodeFromSwiftCode :: SwiftCode -> Maybe Text Source #
Gets the branch code from an 11-digit SwiftCode (this is the last 3 digits of an 11-digit SwiftCode), otherwise returns Nothing.
Constructors
| District | |
Fields
| |
newtype ISO3166Alpha2 Source #
Constructors
| ISO3166Alpha2 | |
Fields | |
Instances
newtype TrackingReference Source #
Constructors
| TrackingReference | |
Fields | |
Instances
| Eq TrackingReference Source # | |
Defined in Circle.Types Methods (==) :: TrackingReference -> TrackingReference -> Bool # (/=) :: TrackingReference -> TrackingReference -> Bool # | |
| Show TrackingReference Source # | |
Defined in Circle.Types Methods showsPrec :: Int -> TrackingReference -> ShowS # show :: TrackingReference -> String # showList :: [TrackingReference] -> ShowS # | |
| ToJSON TrackingReference Source # | |
Defined in Circle.Types Methods toJSON :: TrackingReference -> Value # toEncoding :: TrackingReference -> Encoding # toJSONList :: [TrackingReference] -> Value # toEncodingList :: [TrackingReference] -> Encoding # | |
| FromJSON TrackingReference Source # | |
Defined in Circle.Types Methods parseJSON :: Value -> Parser TrackingReference # parseJSONList :: Value -> Parser [TrackingReference] # | |
| HasCodec TrackingReference Source # | |
Defined in Circle.Types | |
Constructors
| HexString | |
Fields
| |
Constructors
| WalletId | |
Fields
| |