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

Circle.Types

Contents

Orphan instances

Description

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

Synopsis

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

Documentation

newtype ApiToken Source #

Token type used for HTTP Bearer authentication.

Constructors

ApiToken
Fields unApiToken :: ByteString

Instances

Instances details

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

data CircleAPIRequest a b c Source #

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

Constructors

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

Instances

Instances details

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

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

Create a CircleAPIRequest

type family CircleRequest a :: * Source #

Instances

Instances details

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

data CircleError Source #

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

Constructors

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

Instances

Instances details

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

data CircleResponseBody a Source #

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

Constructors

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

Instances

Instances details

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

newtype ResponseStatus Source #

Constructors

ResponseStatus
Fields unResponseStatus :: Int

Instances

Instances details

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

newtype ResponseMessage Source #

Constructors

ResponseMessage
Fields unResponseMessage :: Text

Instances

Instances details

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

type Reply = Response ByteString Source #

type Method = Method Source #

type Host = Text Source #

Either production or sandbox API host

data CircleHost Source #

Constructors

CircleProduction
CircleSandbox

Instances

Instances details

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

hostUri :: CircleHost -> Text Source #

data CircleConfig Source #

Constructors

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

Instances

Instances details

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

credentialsEnv :: Maybe String -> IO ApiToken Source #

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

prodEnvConfig :: Maybe String -> IO CircleConfig Source #

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

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

sandboxEnvConfig :: Maybe String -> IO CircleConfig Source #

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

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

newtype Query Source #

Constructors

Query
Fields unQuery :: TupleBS8

Instances

Instances details

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

newtype Body Source #

Constructors

Body
Fields unBody :: ByteString

Instances

Instances details

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

data Params b c Source #

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

Constructors

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

Instances

Instances details

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

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

type TupleBS8 = (ByteString, ByteString) Source #

Type alias for query parameters

class ToCircleParam param where Source #

Convert a parameter to a key/value

Methods

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

Instances

Instances details

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

class ToCircleParam param => CircleHasParam request param Source #

Instances

Instances details

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

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

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

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

newtype PaginationQueryParams Source #

Constructors

PaginationQueryParams
Fields paginationQueryParams :: PaginationQueryParam

Instances

Instances details

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

data PaginationQueryParam Source #

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

Constructors

PageBefore !Text
PageAfter !Text

Instances

Instances details

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

newtype FromQueryParam Source #

Constructors

FromQueryParam
Fields fromQueryParam :: UTCTime

Instances

Instances details

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

newtype ToQueryParam Source #

Constructors

ToQueryParam
Fields toQueryParam :: UTCTime

Instances

Instances details

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

newtype PageSizeQueryParam Source #

Constructors

PageSizeQueryParam
Fields pageSizeQueryParam :: Integer

Instances

Instances details

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

newtype StatusQueryParams Source #

Constructors

StatusQueryParams
Fields statusQueryParams :: [Status]

Instances

Instances details

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

statusToBS8 :: Status -> ByteString Source #

newtype DestinationQueryParam Source #

Constructors

DestinationQueryParam
Fields destinationQueryParam :: UUID

Instances

Instances details

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

newtype TypeQueryParam Source #

Constructors

TypeQueryParam
Fields typeQueryParam :: BankAccountType

Instances

Instances details

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

bankAccountTypeToBS8 :: BankAccountType -> ByteString Source #

newtype CurrencyQueryParam Source #

Constructors

CurrencyQueryParam
Fields currencyQueryParam :: SupportedCurrencies

Instances

Instances details

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

currencyToBS8 :: SupportedCurrencies -> ByteString Source #

newtype SourceQueryParam Source #

Constructors

SourceQueryParam
Fields sourceQueryParam :: UUID

Instances

Instances details

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

newtype SettlementIdQueryParam Source #

Constructors

SettlementIdQueryParam
Fields settlementIdQueryParam :: UUID

Instances

Instances details

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

newtype PaymentIntentIdQueryParam Source #

Constructors

PaymentIntentIdQueryParam
Fields paymentIntentIdQueryParam :: UUID

Instances

Instances details

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

newtype PaymentIdQueryParam Source #

Constructors

PaymentIdQueryParam
Fields paymentIdQueryParam :: UUID

Instances

Instances details

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

newtype PaymentStatusQueryParams Source #

Constructors

PaymentStatusQueryParams
Fields paymentStatusQueryParams :: [PaymentStatus]

Instances

Instances details

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

paymentStatusToBS8 :: PaymentStatus -> ByteString Source #

newtype PaymentIntentContextQueryParams Source #

Constructors

PaymentIntentContextQueryParams
Fields paymentIntentContextQueryParams :: [PaymentIntentContext]

Instances

Instances details

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

paymentIntentContextToBS8 :: PaymentIntentContext -> ByteString Source #

newtype WalletIdQueryParam Source #

Constructors

WalletIdQueryParam
Fields walletIdQueryParam :: WalletId

Instances

Instances details

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

newtype SourceWalletIdQueryParam Source #

Constructors

SourceWalletIdQueryParam
Fields sourceWalletIdQueryParam :: WalletId

Instances

Instances details

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

newtype DestinationWalletIdQueryParam Source #

Constructors

DestinationWalletIdQueryParam
Fields destinationWalletIdQueryParam :: WalletId

Instances

Instances details

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

newtype ReturnIdentitiesQueryParam Source #

Constructors

ReturnIdentitiesQueryParam
Fields returnIdentitiesQueryParam :: Bool

Instances

Instances details

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

data BalanceRequest Source #

Instances

Instances details

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

data BalanceResponseBody Source #

Response body for listAllBusinessBalances and listAllBalances

Constructors

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

Instances

Instances details

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

data PayoutRequest Source #

Instances

Instances details

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

data PayoutsRequest Source #

Instances

Instances details

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

data PayoutResponseBody Source #

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

Instances

Instances details

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

data BusinessPayoutRequestBody Source #

Request body for creating a new business account payout

Constructors

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

Instances

Instances details

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

newtype PayoutMetadata Source #

Constructors

PayoutMetadata
Fields payoutMetadataBeneficiaryEmail :: Email

Instances

Instances details

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

data PayoutRequestBody Source #

Request body to create a payout.

Constructors

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

Instances

Instances details

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

data PayoutReturnResponseBody Source #

Response body for methods that call the "returns" endpoint

Constructors

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

Instances

Instances details

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

data PayoutErrorCode Source #

Constructors

InsufficientFunds
TransactionDenied
TransactionFailed
TransactionReturned
BankTransactionError
FiatAccountLimitExceeded
InvalidBankAccountNumber
InvalidACHRoutingTransitNumber
InvalidWireRoutingTransitNumber
VendorInactive

Instances

Instances details

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

data ConfigurationRequest Source #

Instances

Instances details

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

newtype ConfigurationResponseBody Source #

Response body for getConfigurationInfo

Constructors

ConfigurationResponseBody
Fields configurationResponseBodyPayments :: WalletConfig

Instances

Instances details

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

newtype WalletConfig Source #

Constructors

WalletConfig
Fields masterWalletId :: WalletId

Instances

Instances details

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

data EncryptionRequest Source #

Instances

Instances details

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

data EncryptionResponseBody Source #

Response body for getPublicKey

Constructors

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

Instances

Instances details

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

newtype PGPKey Source #

Constructors

PGPKey
Fields unPGPKey :: Text

Instances

Instances details

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

data ChannelsRequest Source #

Instances

Instances details

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

newtype ChannelResponseBody Source #

Response body for listAllChannels

Constructors

ChannelResponseBody
Fields channels :: [Channel]

Instances

Instances details

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

data Channel Source #

Constructors

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

Instances

Instances details

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

data StablecoinsRequest Source #

Instances

Instances details

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

data StablecoinResponseBody Source #

Response body for listAllStablecoins

Constructors

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

Instances

Instances details

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

data ChainAmount Source #

Constructors

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

Instances

Instances details

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

data Chain Source #

Constructors

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

Instances

Instances details

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

data Stablecoin Source #

Constructors

USDC
EUROC
USDT

Instances

Instances details

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

data SubscriptionsRequest Source #

Instances

Instances details

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

data SubscriptionRequest Source #

Instances

Instances details

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

data SubscriptionResponseBody Source #

Response body for methods that call "notifications/subscriptions"

Constructors

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

Instances

Instances details

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

data SubscriptionDetails Source #

Constructors

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

Instances

Instances details

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

newtype SubscriptionRequestBody Source #

Request body for creating a new subscription

Constructors

SubscriptionRequestBody
Fields subscriptionRequestBodyEndpoint :: Text

Instances

Instances details

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

data TransfersRequest Source #

Instances

Instances details

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

data TransferRequest Source #

Instances

Instances details

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

data BusinessTransferRequestBody Source #

Request body for creating a new business account transfer

Constructors

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

Instances

Instances details

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

data TransferRequestBody Source #

Request body for creating a new transfer

Constructors

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

Instances

Instances details

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

data TransferDestination Source #

Constructors

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

Instances

Instances details

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

data DestinationType Source #

Constructors

VerifiedBlockchain

Instances

Instances details

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

data TransferResponseBody Source #

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

Instances

Instances details

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

data SourceWallet Source #

Constructors

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

Instances

Instances details

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

data SourceBlockchain Source #

Constructors

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

Instances

Instances details

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

data DestinationWallet Source #

Constructors

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

Instances

Instances details

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

data DestinationBlockchain Source #

Constructors

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

Instances

Instances details

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

data Identity Source #

Constructors

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

Instances

Instances details

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

data IdentityType Source #

Constructors

Individual
Business

Instances

Instances details

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

data TransferType Source #

Constructors

Wallet
Blockchain

Instances

Instances details

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

data TransferErrorCode Source #

Constructors

TransferInsufficientFunds
BlockchainError
TransferDenied
TransferFailed

Instances

Instances details

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

data DepositAddressesRequest Source #

Instances

Instances details

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

data DepositAddressRequest Source #

Instances

Instances details

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

data DepositAddressResponseBody Source #

Response body for methods that call the "businessAccountwalletsaddresses/deposit" endpoint

Constructors

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

Instances

Instances details

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

data DepositAddressRequestBody Source #

Request body for creating a new deposit address

Constructors

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

Instances

Instances details

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

data RecipientAddressesRequest Source #

Instances

Instances details

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

data RecipientAddressRequest Source #

Instances

Instances details

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

data RecipientAddressResponseBody Source #

Response body for methods that call the "businessAccountwalletsaddresses/recipient" endpoint

Constructors

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

Instances

Instances details

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

data RecipientAddressRequestBody Source #

Request body for creating a new recipient address

Constructors

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

Instances

Instances details

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

data DepositsRequest Source #

Instances

Instances details

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

data DepositResponseBody Source #

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

Instances

Instances details

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

data MockPaymentRequest Source #

Instances

Instances details

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

data MockPaymentResponseBody Source #

Response body for methods that call the "mockpayments*" endpoint

Constructors

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

Instances

Instances details

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

data MockSenOrWirePaymentRequestBody Source #

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

Constructors

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

Instances

Instances details

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

data MockSEPAPaymentRequestBody Source #

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

Constructors

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

Instances

Instances details

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

newtype MockBeneficiaryBankDetails Source #

Constructors

MockBeneficiaryBankDetails
Fields mockBeneficiaryBankDetailsAccountNumber :: AccountNumber

Instances

Instances details

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

data SENAccountRequest Source #

Instances

Instances details

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

data SENAccountsRequest Source #

Instances

Instances details

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

data SENInstructionsRequest Source #

Instances

Instances details

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

data SENAccountRequestBody Source #

Request body to create a Silvergate SEN account.

Constructors

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

Instances

Instances details

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

data SENAccountResponseBody Source #

Response body for methods that call the `businessAccountbankssen` endpoint

Constructors

SENAccountResponseBody
Fields senAccountResponseBodyId :: !UUID senAccountResponseBodyStatus :: !Status senAccountResponseBodyDescription :: !Text senAccountResponseBodyTrackingRef :: !TrackingReference senAccountResponseBodyCreateDate :: !UTCTime senAccountResponseBodyUpdateDate :: !UTCTime senAccountResponseBodyCurrency :: !(Maybe SupportedCurrencies)

Instances

Instances details

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

data SENInstructionsResponseData Source #

Constructors

SENInstructionsResponseData
Fields senInstructionsResponseDataTrackingRef :: !TrackingReference senInstructionsResponseDataAccountNumber :: !AccountNumber senInstructionsResponseDataCurrency :: !SupportedCurrencies

Instances

Instances details

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

data SignetBankAccountRequest Source #

Instances

Instances details

type CircleRequest SignetBankAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankAccountRequest = CircleResponseBody SignetBankAccountResponseData

data SignetBankAccountsRequest Source #

Instances

Instances details

type CircleRequest SignetBankAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankAccountsRequest = CircleResponseBody [SignetBankAccountResponseData]

data SignetBankInstructionsRequest Source #

Instances

Instances details

type CircleRequest SignetBankInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SignetBankInstructionsRequest = CircleResponseBody SignetBankInstructionsResponseData

data SignetBankAccountRequestBody Source #

Request body to create Signet Bank bank account.

Constructors

SignetBankAccountRequestBody
Fields signetBankAccountRequestBodyIdempotencyKey :: !UUID signetBankAccountRequestBodyWalletAddress :: !HexString

Instances

Instances details

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

data SignetBankAccountResponseData Source #

Response body for methods that call the "businessAccountbankssignet" endpoint

Constructors

SignetBankAccountResponseData
Fields signetBankAccountId :: !UUID signetBankAccountStatus :: !Status signetBankAccountTrackingRef :: !TrackingReference signetBankAccountWalletAddress :: !HexString signetBankAccountCreateDate :: !UTCTime signetBankAccountUpdateDate :: !UTCTime

Instances

Instances details

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

data SignetBankInstructionsResponseData Source #

Constructors

SignetBankInstructionsResponseData
Fields signetBankInstructionsTrackingRef :: !(Maybe TrackingReference) signetBankInstructionsWalletAddress :: !(Maybe HexString)

Instances

Instances details

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

data WireAccountRequest Source #

Instances

Instances details

type CircleRequest WireAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireAccountRequest = CircleResponseBody WireAccountResponseBody

data WireAccountsRequest Source #

Instances

Instances details

type CircleRequest WireAccountsRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireAccountsRequest = CircleResponseBody [WireAccountResponseBody]

data WireInstructionsRequest Source #

Instances

Instances details

CircleHasParam WireInstructionsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest WireInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest WireInstructionsRequest = CircleResponseBody WireInstructionsResponseData

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

Instances details

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

data USBankAccountRequestBody Source #

Constructors

USBankAccountRequestBody
Fields usBankAccountIdempotencyKey :: !UUID usBankAccountAccountNumber :: !AccountNumber usBankAccountRoutingNumber :: !RoutingNumber usBankAccountBillingDetails :: !BillingDetails usBankAccountBankAddress :: !BankAddress

Instances

Instances details

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

data IBANBankAccountRequestBody Source #

Constructors

IBANBankAccountRequestBody
Fields ibanBankAccountIdempotencyKey :: !UUID ibanBankAccountIBAN :: !Iban ibanBankAccountBillingDetails :: !BillingDetails ibanBankAccountBankAddress :: !BankAddress

Instances

Instances details

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

data NonIBANBankAccountRequestBody Source #

Constructors

NonIBANBankAccountRequestBody
Fields nonIBANBankAccountIdempotencyKey :: !UUID nonIBANBankAccountAccountNumber :: !AccountNumber nonIBANBankAccountRoutingNumber :: !RoutingNumber nonIBANBankAccountBillingDetails :: !BillingDetails nonIBANBankAccountBankAddress :: !BankAddress

Instances

Instances details

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

data WireInstructionsResponseData Source #

Response body for getWireAccountInstructions

Constructors

WireInstructionsResponseData
Fields wireInstructionsResponseDataTrackingRef :: !TrackingReference wireInstructionsResponseDataBeneficiaryDetails :: !BeneficiaryDetails wireInstructionsResponseDataBeneficiaryBankDetails :: !BeneficiaryBankDetails

Instances

Instances details

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

data WireAccountResponseBody Source #

Response body for methods that call the "wires" or "businessAccountwires" endpoints

Constructors

WireAccountResponseBody

Fields

wireAccountResponseBodyId :: !UUID
wireAccountResponseBodyStatus :: !Status
wireAccountResponseBodyDescription :: !Text
wireAccountResponseBodyTrackingRef :: !TrackingReference
wireAccountResponseBodyFingerprint :: !UUID
wireAccountResponseBodyBillingDetails :: !BillingDetails
wireAccountResponseBodyBankAddress :: !BankAddress
wireAccountResponseBodyCreateDate :: !UTCTime
wireAccountResponseBodyUpdateDate :: !UTCTime

Instances

Instances details

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

data PaymentRequest Source #

Instances

Instances details

type CircleRequest PaymentRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentRequest = CircleResponseBody (ThisOrThat FiatOrCryptoPaymentResponseBody FiatCancelOrRefundResponseBody)

data PaymentsRequest Source #

Instances

Instances details

CircleHasParam PaymentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaymentIntentIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest SettlementIdQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest SourceQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest TypeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest DestinationQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest PaymentsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentsRequest = CircleResponseBody [ThisOrThat FiatOrCryptoPaymentResponseBody FiatCancelOrRefundResponseBody]

data CreatePaymentRequestBody Source #

Request body to create any kind of payment.

Constructors

CreatePaymentRequestBody

Fields

createPaymentIdempotencyKey :: !UUID
createPaymentKeyId :: !Text
requestMetadata :: !RequestMetadata
createPaymentAmount :: !MoneyAmount
createPaymentAutoCapture :: !(Maybe Bool)
createPaymentVerification :: !VerificationType
createPaymentVerificationSuccessUrl :: !(Maybe URL)
The following two fields are only present if VerificationType = ThreeDSecure
createPaymentVerificationFailureUrl :: !(Maybe URL)
createPaymentSource :: !PaymentSource
createPaymentDescription :: !(Maybe Text)
createPaymentEncryptedData :: !(Maybe Text)
This encrypted data needs to encrypt the card CVV
createPaymentChannel :: !(Maybe UUID)

Instances

Instances details

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

data RequestMetadata Source #

Constructors

RequestMetadata
Fields requestMetadataEmail :: !Email requestMetadataPhoneNumber :: !(Maybe PhoneNumber) requestMetadataSessionId :: !SessionId requestMetadataIpAddress :: !IPAddress

Instances

Instances details

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

newtype SessionId Source #

Constructors

SessionId
Fields unSessionId :: Text

Instances

Instances details

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

newtype IPAddress Source #

Constructors

IPAddress
Fields unIPAddress :: Text

Instances

Instances details

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

newtype PhoneNumber Source #

Constructors

PhoneNumber
Fields unPhoneNumber :: Text

Instances

Instances details

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

data PaymentErrorCode Source #

Instances

Instances details

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

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

FiatOrCryptoPaymentResponseBody

Fields

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)

Instances

Instances details

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

data ResponseMetadata Source #

Constructors

ResponseMetadata
Fields responseMetadataEmail :: !Email responseMetadataPhoneNumber :: !(Maybe PhoneNumber)

Instances

Instances details

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

data VerificationData Source #

Constructors

VerificationData
Fields verificationAVS :: !AVS verificationCVV :: !CVV

Instances

Instances details

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

data AVS Source #

Constructors

AVSNotRequested
AVSPending
Y
N

Instances

Instances details

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

data CVV Source #

Constructors

CVVNotRequested
CVVPass
CVVFail
CVVUnavailable
CVVPending

Instances

Instances details

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

data PaymentDepositAddress Source #

Constructors

PaymentDepositAddress
Fields paymentDepositAddressChain :: !Chain paymentDepositAddressAddress :: !HexString

Instances

Instances details

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

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

FiatCancelOrRefundResponseBody

Instances

Instances details

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

data OriginalFiatPayment Source #

Constructors

OriginalFiatPayment

Instances

Instances details

Eq OriginalFiatPayment Source #
Instance details Defined in Circle.Types Methods (==) :: OriginalFiatPayment -> OriginalFiatPayment -> Bool # (/=) :: OriginalFiatPayment -> OriginalFiatPayment -> Bool #
Show OriginalFiatPayment Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> OriginalFiatPayment -> ShowS # show :: OriginalFiatPayment -> String # showList :: [OriginalFiatPayment] -> ShowS #
Generic OriginalFiatPayment Source #
Instance details Defined in Circle.Types Associated Types type Rep OriginalFiatPayment :: Type -> Type # Methods from :: OriginalFiatPayment -> Rep OriginalFiatPayment x # to :: Rep OriginalFiatPayment x -> OriginalFiatPayment #
ToJSON OriginalFiatPayment Source #
Instance details Defined in Circle.Types Methods toJSON :: OriginalFiatPayment -> Value # toEncoding :: OriginalFiatPayment -> Encoding # toJSONList :: [OriginalFiatPayment] -> Value # toEncodingList :: [OriginalFiatPayment] -> Encoding #
FromJSON OriginalFiatPayment Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser OriginalFiatPayment # parseJSONList :: Value -> Parser [OriginalFiatPayment] #
HasCodec OriginalFiatPayment Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec OriginalFiatPayment # listCodecForStringCompatibility :: JSONCodec [OriginalFiatPayment] #
type Rep OriginalFiatPayment Source #
Instance details Defined in Circle.Types type Rep OriginalFiatPayment = D1 ('MetaData "OriginalFiatPayment" "Circle.Types" "circle-0.1.0.0-inplace" 'False) (C1 ('MetaCons "OriginalFiatPayment" 'PrefixI 'True) (((S1 ('MetaSel ('Just "originalFiatPaymentId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UUID) :: (S1 ('MetaSel ('Just "originalFiatPaymentType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PaymentType) :: S1 ('MetaSel ('Just "originalFiatPaymentStatus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PaymentStatus))) :: (S1 ('MetaSel ('Just "originalFiatPaymentCreateDate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :: (S1 ('MetaSel ('Just "originalFiatPaymentUpdateDate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "originalFiatPaymentDescription") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "originalFiatPaymentAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe MoneyAmount)) :: (S1 ('MetaSel ('Just "originalFiatPaymentFees") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe MoneyAmount)) :: S1 ('MetaSel ('Just "originalFiatPaymentMerchantId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UUID)))) :: (S1 ('MetaSel ('Just "originalFiatPaymentMerchantWalletId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe WalletId)) :: (S1 ('MetaSel ('Just "originalFiatPaymentSource") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe PaymentSource)) :*: S1 ('MetaSel ('Just "originalFiatPaymentTrackingRef") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe TrackingReference)))))))

data PaymentSource Source #

Constructors

PaymentSource
Fields paymentSourceId :: !UUID paymentSourceType :: !PaymentSourceType

Instances

Instances details

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

data PaymentActionRequired Source #

Constructors

PaymentActionRequired
Fields paymentActionRequiredType :: !ActionRequiredType paymentActionRequiredRedirectUrl :: !URL

Instances

Instances details

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

data ActionRequiredType Source #

Constructors

ThreeDSecureRequired

Instances

Instances details

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

data VerificationType Source #

Constructors

VerificationThreeDSecure
VerificationCVV

Instances

Instances details

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

data PaymentType Source #

Constructors

Payment
Cancel
Refund

Instances

Instances details

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

data PaymentSourceType Source #

Constructors

Card
ACH
WireSource
SEPA

Instances

Instances details

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

data CancelPaymentRequestBody Source #

Request body to cancel a fiat payment.

Constructors

CancelPaymentRequestBody
Fields cancelPaymentIdempotencyKey :: !UUID cancelPaymentReason :: !(Maybe CancelPaymentReason)

Instances

Instances details

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

data CancelPaymentReason Source #

Constructors

CancelPaymentReasonDuplicate
CancelPaymentReasonFraudulent
CancelPaymentReasonRequestedByCustomer
CancelPaymentReasonBankTransactionError
CancelPaymentReasonInvalidAccountNumber
CancelPaymentReasonInsufficientFunds
CancelPaymentReasonPaymentStoppedByIssuer

Instances

Instances details

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

data RefundPaymentRequestBody Source #

Request body to refund a fiat payment.

Constructors

RefundPaymentRequestBody
Fields refundPaymentIdempotencyKey :: !UUID refundPaymentAmount :: !MoneyAmount refundPaymentReason :: !(Maybe CancelPaymentReason)

Instances

Instances details

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

data OnChainTransferRequest Source #

Instances

Instances details

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

data OnChainTransfersRequest Source #

Instances

Instances details

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

data OnChainAddressRequest Source #

Instances

Instances details

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

data OnChainTransferRequestBody Source #

Request body to create an on-chain transfer

Constructors

OnChainTransferRequestBody
Fields onChainTransferRequestBodyIdempotencyKey :: !UUID onChainTransferRequestBodySource :: !SourceWallet onChainTransferRequestBodyDestination :: !(ThisOrThat DestinationWallet DestinationBlockchain) onChainTransferRequestBodyAmount :: !MoneyAmount

Instances

Instances details

Eq OnChainTransferRequestBody Source #
Instance details Defined in Circle.Types Methods (==) :: OnChainTransferRequestBody -> OnChainTransferRequestBody -> Bool # (/=) :: OnChainTransferRequestBody -> OnChainTransferRequestBody -> Bool #
Show OnChainTransferRequestBody Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> OnChainTransferRequestBody -> ShowS # show :: OnChainTransferRequestBody -> String # showList :: [OnChainTransferRequestBody] -> ShowS #
ToJSON OnChainTransferRequestBody Source #
Instance details Defined in Circle.Types Methods toJSON :: OnChainTransferRequestBody -> Value # toEncoding :: OnChainTransferRequestBody -> Encoding # toJSONList :: [OnChainTransferRequestBody] -> Value # toEncodingList :: [OnChainTransferRequestBody] -> Encoding #

data CardsRequest Source #

Instances

Instances details

CircleHasParam CardsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam CardsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest CardsRequest Source #
Instance details Defined in Circle.Types type CircleRequest CardsRequest = CircleResponseBody [ListCardResponseBody]

data CardRequest Source #

Instances

Instances details

type CircleRequest CardRequest Source #
Instance details Defined in Circle.Types type CircleRequest CardRequest = CircleResponseBody CardResponseBody

data ListCardResponseBody Source #

Response body for listAllCards

Constructors

ListCardResponseBody

Fields

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

Instances

Instances details

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

data CardResponseBody Source #

Response body for methods that interface with an individual card: createCard, getCard, and updateCard

Constructors

CardResponseBody

Fields

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

Instances

Instances details

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

data CreateCardRequestBody Source #

Request body to create a debit card.

Constructors

CreateCardRequestBody
Fields createCardIdempotencyKey :: !UUID createCardKeyId :: !(Maybe Text) createCardEncryptedData :: !(Maybe Text) createCardBillingDetails :: !BillingDetails createCardExpiryMonth :: !Int createCardExpiryYear :: !Int createCardMetadata :: !RequestMetadata

Instances

Instances details

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

data UpdateCardRequestBody Source #

Request body to update a debit card.

Constructors

UpdateCardRequestBody
Fields updateCardKeyId :: !(Maybe Text) updateCardEncryptedData :: !(Maybe Text) updateCardExpiryMonth :: !Int updateCardExpiryYear :: !Int

Instances

Instances details

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

data ListCardBillingDetails Source #

Constructors

ListCardBillingDetails
Fields listCardBillingDetailsCountry :: !ISO3166Alpha2 listCardBillingDetailsDistrict :: !District

Instances

Instances details

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

data CardNetwork Source #

Constructors

VISA
MASTERCARD
AMEX
UNKNOWN

Instances

Instances details

Bounded CardNetwork Source #
Instance details Defined in Circle.Types Methods minBound :: CardNetwork # maxBound :: CardNetwork #
Enum CardNetwork Source #
Instance details Defined in Circle.Types Methods succ :: CardNetwork -> CardNetwork # pred :: CardNetwork -> CardNetwork # toEnum :: Int -> CardNetwork # fromEnum :: CardNetwork -> Int # enumFrom :: CardNetwork -> [CardNetwork] # enumFromThen :: CardNetwork -> CardNetwork -> [CardNetwork] # enumFromTo :: CardNetwork -> CardNetwork -> [CardNetwork] # enumFromThenTo :: CardNetwork -> CardNetwork -> CardNetwork -> [CardNetwork] #
Eq CardNetwork Source #
Instance details Defined in Circle.Types Methods (==) :: CardNetwork -> CardNetwork -> Bool # (/=) :: CardNetwork -> CardNetwork -> Bool #
Show CardNetwork Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CardNetwork -> ShowS # show :: CardNetwork -> String # showList :: [CardNetwork] -> ShowS #
ToJSON CardNetwork Source #
Instance details Defined in Circle.Types Methods toJSON :: CardNetwork -> Value # toEncoding :: CardNetwork -> Encoding # toJSONList :: [CardNetwork] -> Value # toEncodingList :: [CardNetwork] -> Encoding #
FromJSON CardNetwork Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser CardNetwork # parseJSONList :: Value -> Parser [CardNetwork] #
HasCodec CardNetwork Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec CardNetwork # listCodecForStringCompatibility :: JSONCodec [CardNetwork] #

data CardFundingType Source #

Constructors

Credit
Debit
Prepaid
Unknown

Instances

Instances details

Bounded CardFundingType Source #
Instance details Defined in Circle.Types Methods minBound :: CardFundingType # maxBound :: CardFundingType #
Enum CardFundingType Source #
Instance details Defined in Circle.Types Methods succ :: CardFundingType -> CardFundingType # pred :: CardFundingType -> CardFundingType # toEnum :: Int -> CardFundingType # fromEnum :: CardFundingType -> Int # enumFrom :: CardFundingType -> [CardFundingType] # enumFromThen :: CardFundingType -> CardFundingType -> [CardFundingType] # enumFromTo :: CardFundingType -> CardFundingType -> [CardFundingType] # enumFromThenTo :: CardFundingType -> CardFundingType -> CardFundingType -> [CardFundingType] #
Eq CardFundingType Source #
Instance details Defined in Circle.Types Methods (==) :: CardFundingType -> CardFundingType -> Bool # (/=) :: CardFundingType -> CardFundingType -> Bool #
Show CardFundingType Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> CardFundingType -> ShowS # show :: CardFundingType -> String # showList :: [CardFundingType] -> ShowS #
ToJSON CardFundingType Source #
Instance details Defined in Circle.Types Methods toJSON :: CardFundingType -> Value # toEncoding :: CardFundingType -> Encoding # toJSONList :: [CardFundingType] -> Value # toEncodingList :: [CardFundingType] -> Encoding #
FromJSON CardFundingType Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser CardFundingType # parseJSONList :: Value -> Parser [CardFundingType] #
HasCodec CardFundingType Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec CardFundingType # listCodecForStringCompatibility :: JSONCodec [CardFundingType] #

data VerificationErrorCode Source #

Constructors

VerificationFailed
VerificationFraudDetected
VerificationDenied
VerificationNotSupportedByIssuer
VerificationStoppedByIssuer
VerificationCardFailed
VerificationCardInvalid
VerificationCardAddressMismatch
VerificationCardZipMismatch
VerificationCardCvvInvalid
VerificationCardExpired
VerificationCardLimitViolated
VerificationCardNotHonored
VerificationCardCvvRequired
VerificationCreditCardNotAllowed
VerificationCardAccountIneligible
VerificationCardNetworkUnsupported

Instances

Instances details

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

data ACHBankAccountRequest Source #

Instances

Instances details

type CircleRequest ACHBankAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest ACHBankAccountRequest = CircleResponseBody ACHBankAccountResponseBody

data ACHBankAccountResponseBody Source #

Response body for createACHAccount and getACHAccount

Instances

Instances details

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

data ACHBankAccountErrorCode Source #

Constructors

ACHBankAccountAuthorizationExpired
ACHBankAccountError
ACHBankAccountIneligible
ACHBankAccountNotFound
ACHBankAccountUnauthorized
ACHBankAccountUnsupportedRoutingNumber
ACHBankAccountVerificationFailed

Instances

Instances details

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

data CreateACHBankAccountRequestBody Source #

Request body to an ACH bank account.

Constructors

CreateACHBankAccountRequestBody
Fields achBankAccountBodyIdempotencyKey :: !UUID achBankAccountBodyPlaidProcessorToken :: !ProcessorToken achBankAccountBodyBillingDetails :: !BillingDetails achBankAccountBodyBankAccountType :: !(Maybe ACHBankAccountType) achBankAccountBodyMetadata :: !RequestMetadata

Instances

Instances details

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

data MockAccountRequest Source #

Instances

Instances details

type CircleRequest MockAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockAccountRequest = CircleResponseBody MockACHBankAccountResponseBody

data CreateMockACHBankAccountRequestBody Source #

Request body to create a mock ACH bank account (in the sandbox only).

Constructors

CreateMockACHBankAccountRequestBody
Fields mockACHBankAccountBodyAccount :: !MockACHBankAccount mockACHBankAccountBodyBalance :: !MoneyAmount

Instances

Instances details

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

data MockACHBankAccountResponseBody Source #

Response body for methods that call the "mocksachaccount" endpoint

Constructors

MockACHBankAccountResponseBody
Fields mockACHBankAccountResponseBodyAccount :: !MockACHBankAccount mockACHBankAccountResponseBodyBalance :: !MoneyAmount mockACHBankAccountResponseBodyProcessorToken :: !ProcessorToken

Instances

Instances details

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

data MockACHBankAccount Source #

Constructors

MockACHBankAccount
Fields mockACHBankAccountAccountNumber :: !AccountNumber mockACHBankAccountRoutingNumber :: !MockRoutingNumber mockACHBankAccountDescription :: !Text

Instances

Instances details

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

data MockRoutingNumber Source #

Constructors

MockRoutingNumber1
MockRoutingNumber2
MockRoutingNumber3
MockRoutingNumber4
MockRoutingNumber5
MockRoutingNumber6
MockRoutingNumber7
MockRoutingNumber8
MockRoutingNumber9

Instances

Instances details

Bounded MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods minBound :: MockRoutingNumber # maxBound :: MockRoutingNumber #
Enum MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods succ :: MockRoutingNumber -> MockRoutingNumber # pred :: MockRoutingNumber -> MockRoutingNumber # toEnum :: Int -> MockRoutingNumber # fromEnum :: MockRoutingNumber -> Int # enumFrom :: MockRoutingNumber -> [MockRoutingNumber] # enumFromThen :: MockRoutingNumber -> MockRoutingNumber -> [MockRoutingNumber] # enumFromTo :: MockRoutingNumber -> MockRoutingNumber -> [MockRoutingNumber] # enumFromThenTo :: MockRoutingNumber -> MockRoutingNumber -> MockRoutingNumber -> [MockRoutingNumber] #
Eq MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods (==) :: MockRoutingNumber -> MockRoutingNumber -> Bool # (/=) :: MockRoutingNumber -> MockRoutingNumber -> Bool #
Show MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> MockRoutingNumber -> ShowS # show :: MockRoutingNumber -> String # showList :: [MockRoutingNumber] -> ShowS #
ToJSON MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods toJSON :: MockRoutingNumber -> Value # toEncoding :: MockRoutingNumber -> Encoding # toJSONList :: [MockRoutingNumber] -> Value # toEncodingList :: [MockRoutingNumber] -> Encoding #
FromJSON MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser MockRoutingNumber # parseJSONList :: Value -> Parser [MockRoutingNumber] #
HasCodec MockRoutingNumber Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec MockRoutingNumber # listCodecForStringCompatibility :: JSONCodec [MockRoutingNumber] #

data SEPAAccountRequest Source #

Instances

Instances details

type CircleRequest SEPAAccountRequest Source #
Instance details Defined in Circle.Types type CircleRequest SEPAAccountRequest = CircleResponseBody SEPAAccountResponseBody

data SEPAInstructionsRequest Source #

Instances

Instances details

type CircleRequest SEPAInstructionsRequest Source #
Instance details Defined in Circle.Types type CircleRequest SEPAInstructionsRequest = CircleResponseBody WireInstructionsResponseData

data SEPAAccountRequestBody Source #

Request body to create a SEPA account.

Constructors

SEPAAccountRequestBody
Fields sepaAccountRequestBodyIdempotencyKey :: !UUID sepaAccountRequestBodyIBAN :: !Iban sepaAccountRequestBodyBillingDetails :: !BillingDetails

Instances

Instances details

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

data SEPAAccountResponseBody Source #

Response body for methods that call the "banks/sepa" endpoint

Instances

Instances details

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

data SettlementRequest Source #

Instances

Instances details

type CircleRequest SettlementRequest Source #
Instance details Defined in Circle.Types type CircleRequest SettlementRequest = CircleResponseBody SettlementResponseBody

data SettlementsRequest Source #

Instances

Instances details

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

data SettlementResponseBody Source #

Response body for methods that call the "settlements" endpoint

Constructors

SettlementResponseBody

Fields

settlementResponseBodyId :: !UUID
settlementResponseBodyMerchantWalletId :: !UUID
settlementResponseBodyWalletId :: !UUID
settlementResponseBodyTotalDebits :: !MoneyAmount
settlementResponseBodyTotalCredits :: !MoneyAmount
settlementResponseBodyPaymentFees :: !MoneyAmount
settlementResponseBodyChargebackFees :: !MoneyAmount
settlementResponseBodyCreateDate :: !UTCTime
settlementResponseBodyUpdateDate :: !UTCTime

Instances

Instances details

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

data ChargebacksRequest Source #

Instances

Instances details

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

data ChargebackRequest Source #

Instances

Instances details

type CircleRequest ChargebackRequest Source #
Instance details Defined in Circle.Types type CircleRequest ChargebackRequest = CircleResponseBody ChargebackResponseBody

data MockChargebackRequest Source #

Instances

Instances details

type CircleRequest MockChargebackRequest Source #
Instance details Defined in Circle.Types type CircleRequest MockChargebackRequest = CircleResponseBody ChargebackResponseBody

data ChargebackResponseBody Source #

Response body for methods that call the "cardschargebacks" and "mockscards/chargebacks" endpoints

Constructors

ChargebackResponseBody
Fields chargebackResponseBodyId :: !UUID chargebackResponseBodyPaymentId :: !UUID chargebackResponseBodyMerchantId :: !UUID chargebackResponseBodyReasonCode :: !Text chargebackResponseBodyCategory :: !(Maybe ChargebackCategory) chargebackResponseBodyHistory :: [ChargebackHistory]

Instances

Instances details

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

data ChargebackCategory Source #

Constructors

CanceledRecurringPayment
CustomerDispute
Fraudulent
General
ProcessingError
NotDefined

Instances

Instances details

Bounded ChargebackCategory Source #
Instance details Defined in Circle.Types Methods minBound :: ChargebackCategory # maxBound :: ChargebackCategory #
Enum ChargebackCategory Source #
Instance details Defined in Circle.Types Methods succ :: ChargebackCategory -> ChargebackCategory # pred :: ChargebackCategory -> ChargebackCategory # toEnum :: Int -> ChargebackCategory # fromEnum :: ChargebackCategory -> Int # enumFrom :: ChargebackCategory -> [ChargebackCategory] # enumFromThen :: ChargebackCategory -> ChargebackCategory -> [ChargebackCategory] # enumFromTo :: ChargebackCategory -> ChargebackCategory -> [ChargebackCategory] # enumFromThenTo :: ChargebackCategory -> ChargebackCategory -> ChargebackCategory -> [ChargebackCategory] #
Eq ChargebackCategory Source #
Instance details Defined in Circle.Types Methods (==) :: ChargebackCategory -> ChargebackCategory -> Bool # (/=) :: ChargebackCategory -> ChargebackCategory -> Bool #
Show ChargebackCategory Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ChargebackCategory -> ShowS # show :: ChargebackCategory -> String # showList :: [ChargebackCategory] -> ShowS #
ToJSON ChargebackCategory Source #
Instance details Defined in Circle.Types Methods toJSON :: ChargebackCategory -> Value # toEncoding :: ChargebackCategory -> Encoding # toJSONList :: [ChargebackCategory] -> Value # toEncodingList :: [ChargebackCategory] -> Encoding #
FromJSON ChargebackCategory Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ChargebackCategory # parseJSONList :: Value -> Parser [ChargebackCategory] #
HasCodec ChargebackCategory Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ChargebackCategory # listCodecForStringCompatibility :: JSONCodec [ChargebackCategory] #

data ChargebackHistory Source #

Constructors

ChargebackHistory
Fields chargebackHistoryType :: !ChargebackHistoryType chargebackHistoryAmount :: !MoneyAmount chargebackHistoryFee :: !(Maybe MoneyAmount) chargebackHistoryDescription :: !Text chargebackHistorySettlementId :: !(Maybe UUID) chargebackHistoryCreateDate :: !UTCTime

Instances

Instances details

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

data ChargebackHistoryType Source #

Constructors

FirstChargeback
SecondChargeback
ChargebackReversal
Representment
ChargebackSettlement

Instances

Instances details

Bounded ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods minBound :: ChargebackHistoryType # maxBound :: ChargebackHistoryType #
Enum ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods succ :: ChargebackHistoryType -> ChargebackHistoryType # pred :: ChargebackHistoryType -> ChargebackHistoryType # toEnum :: Int -> ChargebackHistoryType # fromEnum :: ChargebackHistoryType -> Int # enumFrom :: ChargebackHistoryType -> [ChargebackHistoryType] # enumFromThen :: ChargebackHistoryType -> ChargebackHistoryType -> [ChargebackHistoryType] # enumFromTo :: ChargebackHistoryType -> ChargebackHistoryType -> [ChargebackHistoryType] # enumFromThenTo :: ChargebackHistoryType -> ChargebackHistoryType -> ChargebackHistoryType -> [ChargebackHistoryType] #
Eq ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods (==) :: ChargebackHistoryType -> ChargebackHistoryType -> Bool # (/=) :: ChargebackHistoryType -> ChargebackHistoryType -> Bool #
Show ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ChargebackHistoryType -> ShowS # show :: ChargebackHistoryType -> String # showList :: [ChargebackHistoryType] -> ShowS #
ToJSON ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods toJSON :: ChargebackHistoryType -> Value # toEncoding :: ChargebackHistoryType -> Encoding # toJSONList :: [ChargebackHistoryType] -> Value # toEncodingList :: [ChargebackHistoryType] -> Encoding #
FromJSON ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ChargebackHistoryType # parseJSONList :: Value -> Parser [ChargebackHistoryType] #
HasCodec ChargebackHistoryType Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ChargebackHistoryType # listCodecForStringCompatibility :: JSONCodec [ChargebackHistoryType] #

data ReversalsRequest Source #

Instances

Instances details

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

data ReversalResponseBody Source #

Response body for methods that call the "reversals" endpoint

Constructors

ReversalResponseBody
Fields reversalResponseBodyId :: !UUID reversalResponseBodyPaymentId :: !UUID reversalResponseBodyAmount :: !MoneyAmount reversalResponseBodyDescription :: !Text reversalResponseBodyStatus :: !Status reversalResponseBodyReason :: !ReversalReason reversalResponseBodyFees :: !MoneyAmount reversalResponseBodyCreateDate :: !UTCTime reversalResponseBodyUpdateDate :: !UTCTime

Instances

Instances details

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

data ReversalReason Source #

Constructors

ReversalDuplicate
ReversalFraudulent
ReversalRequestedByCustomer
ReversalBankTransactionError
ReversalInvalidAccountNumber
ReversalInsufficientFunds
ReversalPaymentStoppedByIssuer
ReversalPaymentReturned
ReversalBankAccountIneligible
ReversalInvalidACHRTN
ReversalUnauthorizedTransaction
ReversalPaymentFailed

Instances

Instances details

Bounded ReversalReason Source #
Instance details Defined in Circle.Types Methods minBound :: ReversalReason # maxBound :: ReversalReason #
Enum ReversalReason Source #
Instance details Defined in Circle.Types Methods succ :: ReversalReason -> ReversalReason # pred :: ReversalReason -> ReversalReason # toEnum :: Int -> ReversalReason # fromEnum :: ReversalReason -> Int # enumFrom :: ReversalReason -> [ReversalReason] # enumFromThen :: ReversalReason -> ReversalReason -> [ReversalReason] # enumFromTo :: ReversalReason -> ReversalReason -> [ReversalReason] # enumFromThenTo :: ReversalReason -> ReversalReason -> ReversalReason -> [ReversalReason] #
Eq ReversalReason Source #
Instance details Defined in Circle.Types Methods (==) :: ReversalReason -> ReversalReason -> Bool # (/=) :: ReversalReason -> ReversalReason -> Bool #
Show ReversalReason Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ReversalReason -> ShowS # show :: ReversalReason -> String # showList :: [ReversalReason] -> ShowS #
ToJSON ReversalReason Source #
Instance details Defined in Circle.Types Methods toJSON :: ReversalReason -> Value # toEncoding :: ReversalReason -> Encoding # toJSONList :: [ReversalReason] -> Value # toEncodingList :: [ReversalReason] -> Encoding #
FromJSON ReversalReason Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser ReversalReason # parseJSONList :: Value -> Parser [ReversalReason] #
HasCodec ReversalReason Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec ReversalReason # listCodecForStringCompatibility :: JSONCodec [ReversalReason] #

data PaymentIntentRequest Source #

Instances

Instances details

type CircleRequest PaymentIntentRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentIntentRequest = CircleResponseBody PaymentIntentResponseBody

data PaymentIntentsRequest Source #

Instances

Instances details

CircleHasParam PaymentIntentsRequest PaymentIntentContextQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaymentStatusQueryParams Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PageSizeQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest ToQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest FromQueryParam Source #
Instance details Defined in Circle.Types
CircleHasParam PaymentIntentsRequest PaginationQueryParams Source #
Instance details Defined in Circle.Types
type CircleRequest PaymentIntentsRequest Source #
Instance details Defined in Circle.Types type CircleRequest PaymentIntentsRequest = CircleResponseBody [PaymentIntentResponseBody]

data CreatePaymentIntentRequestBody Source #

Request body to create a payment intent for a blockchain payment

Constructors

CreatePaymentIntentRequestBody
Fields createPaymentIntentIdempotencyKey :: !UUID createPaymentIntentAmount :: !MoneyAmount createPaymentIntentSettlementCurrency :: !SupportedCurrencies createPaymentIntentPaymentMethods :: [PaymentMethodData]

Instances

Instances details

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

data PaymentIntentResponseBody Source #

Response body for methods that call the "paymentIntents" endpoint

Instances

Instances details

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

data PaymentMethodData Source #

Constructors

PaymentMethodData
Fields paymentMethodType :: !Text paymentMethodDataChain :: !Chain paymentMethodDataAddress :: !(Maybe HexString)

Instances

Instances details

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

data TimelineData Source #

Constructors

TimelineData
Fields timelineDataStatus :: !PaymentIntentStatus timelineDataContext :: !PaymentIntentContext timelineDataTime :: !UTCTime

Instances

Instances details

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

data ReturnsRequest Source #

Instances

Instances details

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

data WalletRequest Source #

Instances

Instances details

type CircleRequest WalletRequest Source #
Instance details Defined in Circle.Types type CircleRequest WalletRequest = CircleResponseBody WalletResponseBody

data WalletsRequest Source #

Instances

Instances details

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

data WalletResponseBody Source #

Response body for methods that call the "wallets" endpoint

Constructors

WalletResponseBody
Fields walletResponseBodyWalletId :: !WalletId walletResponseBodyEntityId :: !UUID walletResponseBodyType :: !Text walletResponseBodyDescription :: !(Maybe Text) walletResponseBodyBalances :: [MoneyAmount]

Instances

Instances details

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

data CreateWalletRequestBody Source #

Request body to create a Circle wallet.

Constructors

CreateWalletRequestBody
Fields createWalletRequestBodyIdempotencyKey :: !UUID createWalletRequestBodyDescription :: !(Maybe Text)

Instances

Instances details

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

utcToCircle :: UTCTime -> Text Source #

tshow :: Show a => a -> 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 B, if A 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) can never parse a 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.

Constructors

This a
That b

Instances

Instances details

Bifunctor ThisOrThat Source #
Instance details Defined in Circle.Types Methods bimap :: (a -> b) -> (c -> d) -> ThisOrThat a c -> ThisOrThat b d # first :: (a -> b) -> ThisOrThat a c -> ThisOrThat b c # second :: (b -> c) -> ThisOrThat a b -> ThisOrThat a c #
(Eq a, Eq b) => Eq (ThisOrThat a b) Source #
Instance details Defined in Circle.Types Methods (==) :: ThisOrThat a b -> ThisOrThat a b -> Bool # (/=) :: ThisOrThat a b -> ThisOrThat a b -> Bool #
(Show a, Show b) => Show (ThisOrThat a b) Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> ThisOrThat a b -> ShowS # show :: ThisOrThat a b -> String # showList :: [ThisOrThat a b] -> ShowS #
Generic (ThisOrThat a b) Source #
Instance details Defined in Circle.Types Associated Types type Rep (ThisOrThat a b) :: Type -> Type # Methods from :: ThisOrThat a b -> Rep (ThisOrThat a b) x # to :: Rep (ThisOrThat a b) x -> ThisOrThat a b #
(ToJSON a, ToJSON b) => ToJSON (ThisOrThat a b) Source #
Instance details Defined in Circle.Types Methods toJSON :: ThisOrThat a b -> Value # toEncoding :: ThisOrThat a b -> Encoding # toJSONList :: [ThisOrThat a b] -> Value # toEncodingList :: [ThisOrThat a b] -> Encoding #
(FromJSON a, FromJSON b) => FromJSON (ThisOrThat a b) Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser (ThisOrThat a b) # parseJSONList :: Value -> Parser [ThisOrThat a b] #
type Rep (ThisOrThat a b) Source #
Instance details Defined in Circle.Types type Rep (ThisOrThat a b) = D1 ('MetaData "ThisOrThat" "Circle.Types" "circle-0.1.0.0-inplace" 'False) (C1 ('MetaCons "This" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "That" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 b)))

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 Status Source #

Constructors

Pending
Complete
Failed

Instances

Instances details

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

data PaymentStatus Source #

Constructors

PaymentPending
Confirmed
Paid
PaymentFailed
ActionRequired

Instances

Instances details

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

data PaymentIntentStatus Source #

Constructors

PaymentIntentCreated
PaymentIntentPending
PaymentIntentComplete
PaymentIntentExpired
PaymentIntentFailed

Instances

Instances details

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

data PaymentIntentContext Source #

Constructors

ContextUnderpaid
ContextPaid
ContextOverpaid

Instances

Instances details

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

data Address Source #

Constructors

Address
Fields addressCity :: !(Maybe City) addressCountry :: !(Maybe ISO3166Alpha2) addressLine1 :: !(Maybe AddressLine) addressLine2 :: !(Maybe AddressLine) addressDistrict :: !(Maybe District)

Instances

Instances details

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

data BankAccountType Source #

Constructors

Wire
Sen

Instances

Instances details

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

data ACHBankAccountType Source #

Constructors

RetailType
BusinessType

Instances

Instances details

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

data DestinationBankAccount Source #

Constructors

DestinationBankAccount
Fields destinationBankAccountType :: !BankAccountType destinationBankAccountId :: !UUID destinationBankAccountName :: !(Maybe Text)

Instances

Instances details

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

data SupportedCurrencies Source #

Constructors

USD
EUR
BTC
ETH

Instances

Instances details

Bounded SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods minBound :: SupportedCurrencies # maxBound :: SupportedCurrencies #
Enum SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods succ :: SupportedCurrencies -> SupportedCurrencies # pred :: SupportedCurrencies -> SupportedCurrencies # toEnum :: Int -> SupportedCurrencies # fromEnum :: SupportedCurrencies -> Int # enumFrom :: SupportedCurrencies -> [SupportedCurrencies] # enumFromThen :: SupportedCurrencies -> SupportedCurrencies -> [SupportedCurrencies] # enumFromTo :: SupportedCurrencies -> SupportedCurrencies -> [SupportedCurrencies] # enumFromThenTo :: SupportedCurrencies -> SupportedCurrencies -> SupportedCurrencies -> [SupportedCurrencies] #
Eq SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods (==) :: SupportedCurrencies -> SupportedCurrencies -> Bool # (/=) :: SupportedCurrencies -> SupportedCurrencies -> Bool #
Show SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SupportedCurrencies -> ShowS # show :: SupportedCurrencies -> String # showList :: [SupportedCurrencies] -> ShowS #
ToJSON SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods toJSON :: SupportedCurrencies -> Value # toEncoding :: SupportedCurrencies -> Encoding # toJSONList :: [SupportedCurrencies] -> Value # toEncodingList :: [SupportedCurrencies] -> Encoding #
FromJSON SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SupportedCurrencies # parseJSONList :: Value -> Parser [SupportedCurrencies] #
HasCodec SupportedCurrencies Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SupportedCurrencies # listCodecForStringCompatibility :: JSONCodec [SupportedCurrencies] #

newtype Amount Source #

Constructors

Amount
Fields unAmount :: Text

Instances

Instances details

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

data BlockchainFeeType Source #

Constructors

BlockchainLeaseFee
TotalPaymentFees

Instances

Instances details

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

data BlockchainFeeMoneyAmount Source #

Constructors

BlockchainFeeMoneyAmount
Fields blockchainFeeMoneyAmountType :: !BlockchainFeeType blockchainFeeMoneyAmountAmount :: !Amount blockchainFeeMoneyAmountCurrency :: !SupportedCurrencies

Instances

Instances details

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

data MoneyAmount Source #

Constructors

MoneyAmount
Fields moneyAmountAmount :: !Amount moneyAmountCurrency :: !SupportedCurrencies

Instances

Instances details

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

data TransferFeeAmount Source #

Constructors

TransferFeeAmount
Fields transferFeeAmountAmount :: !Amount transferFeeAmountCurrency :: !SupportedCurrencies transferFeeAmountType :: !Text

Instances

Instances details

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

data Decision Source #

Constructors

Approved
Denied
Review

Instances

Instances details

Eq Decision Source #
Instance details Defined in Circle.Types Methods (==) :: Decision -> Decision -> Bool # (/=) :: Decision -> Decision -> Bool #
Show Decision Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Decision -> ShowS # show :: Decision -> String # showList :: [Decision] -> ShowS #
Generic Decision Source #
Instance details Defined in Circle.Types Associated Types type Rep Decision :: Type -> Type # Methods from :: Decision -> Rep Decision x # to :: Rep Decision x -> Decision #
ToJSON Decision Source #
Instance details Defined in Circle.Types Methods toJSON :: Decision -> Value # toEncoding :: Decision -> Encoding # toJSONList :: [Decision] -> Value # toEncodingList :: [Decision] -> Encoding #
FromJSON Decision Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Decision # parseJSONList :: Value -> Parser [Decision] #
HasCodec Decision Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Decision # listCodecForStringCompatibility :: JSONCodec [Decision] #
type Rep Decision Source #
Instance details Defined in Circle.Types type Rep Decision = D1 ('MetaData "Decision" "Circle.Types" "circle-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Approved" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Denied" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Review" 'PrefixI 'False) (U1 :: Type -> Type)))

data RiskEvaluation Source #

Constructors

RiskEvaluation
Fields riskEvaluationDecision :: !Decision riskEvaluationReason :: !Text

Instances

Instances details

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

data Adjustments Source #

Constructors

Adjustments
Fields adjustmentsFXCredit :: !MoneyAmount adjustmentsFXDebit :: !MoneyAmount

Instances

Instances details

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

data BillingDetails Source #

Constructors

BillingDetails
Fields billingDetailsName :: !Text billingDetailsCity :: !City billingDetailsCountry :: !ISO3166Alpha2 billingDetailsLine1 :: !AddressLine billingDetailsLine2 :: !(Maybe AddressLine) billingDetailsDistrict :: !(Maybe District) billingDetailsPostalCode :: !PostalCode

Instances

Instances details

Eq BillingDetails Source #
Instance details Defined in Circle.Types Methods (==) :: BillingDetails -> BillingDetails -> Bool # (/=) :: BillingDetails -> BillingDetails -> Bool #
Show BillingDetails Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> BillingDetails -> ShowS # show :: BillingDetails -> String # showList :: [BillingDetails] -> ShowS #
Generic BillingDetails Source #
Instance details Defined in Circle.Types Associated Types type Rep BillingDetails :: Type -> Type # Methods from :: BillingDetails -> Rep BillingDetails x # to :: Rep BillingDetails x -> BillingDetails #
ToJSON BillingDetails Source #
Instance details Defined in Circle.Types Methods toJSON :: BillingDetails -> Value # toEncoding :: BillingDetails -> Encoding # toJSONList :: [BillingDetails] -> Value # toEncodingList :: [BillingDetails] -> Encoding #
FromJSON BillingDetails Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser BillingDetails # parseJSONList :: Value -> Parser [BillingDetails] #
HasCodec BillingDetails Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec BillingDetails # listCodecForStringCompatibility :: JSONCodec [BillingDetails] #
type Rep BillingDetails Source #
Instance details Defined in Circle.Types type Rep BillingDetails = D1 ('MetaData "BillingDetails" "Circle.Types" "circle-0.1.0.0-inplace" 'False) (C1 ('MetaCons "BillingDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "billingDetailsName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "billingDetailsCity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 City) :: S1 ('MetaSel ('Just "billingDetailsCountry") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ISO3166Alpha2))) :: ((S1 ('MetaSel ('Just "billingDetailsLine1") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AddressLine) :: S1 ('MetaSel ('Just "billingDetailsLine2") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe AddressLine))) :: (S1 ('MetaSel ('Just "billingDetailsDistrict") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe District)) :: S1 ('MetaSel ('Just "billingDetailsPostalCode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PostalCode)))))

data BankAddress Source #

Constructors

BankAddress
Fields bankAddressName :: !(Maybe Text) bankAddressCity :: !(Maybe City) bankAddressCountry :: !(Maybe ISO3166Alpha2) bankAddressLine1 :: !(Maybe AddressLine) bankAddressLine2 :: !(Maybe AddressLine) bankAddressDistrict :: !(Maybe District)

Instances

Instances details

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

data BeneficiaryDetails Source #

Constructors

BeneficiaryDetails
Fields beneficiaryDetailsName :: !Text beneficiaryDetailsAddress1 :: !(Maybe AddressLine) beneficiaryDetailsAddress2 :: !(Maybe AddressLine)

Instances

Instances details

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

data BeneficiaryBankDetails Source #

Constructors

BeneficiaryBankDetails

Fields

beneficiaryBankDetailsName :: !Text
beneficiaryBankDetailsSwiftCode :: !SwiftCode
beneficiaryBankDetailsRoutingNumber :: !RoutingNumber
beneficiaryBankDetailsAccountNumber :: !AccountNumber
beneficiaryBankDetailsCurrency :: !SupportedCurrencies
beneficiaryBankDetailsAddress :: !AddressLine
beneficiaryBankDetailsCity :: !City
beneficiaryBankDetailsPostalCode :: !PostalCode
beneficiaryBankDetailsCountry :: !ISO3166Alpha2

Instances

Instances details

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

newtype ProcessorToken Source #

Constructors

ProcessorToken
Fields unProcessorToken :: Text

Instances

Instances details

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

newtype AddressLine Source #

Constructors

AddressLine
Fields unAddressLine :: Text

Instances

Instances details

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

newtype URL Source #

Constructors

URL
Fields unURL :: Text

Instances

Instances details

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

urlRegex :: Regex Source #

mkURL :: Text -> Maybe URL Source #

urlToText :: URL -> Text Source #

urlToByteString :: URL -> ByteString Source #

newtype AccountNumber Source #

Constructors

AccountNumber
Fields unAccountNumber :: Text

Instances

Instances details

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

accountNumberRegex :: Regex Source #

mkAccountNumber :: Text -> Maybe AccountNumber Source #

accountNumberToText :: AccountNumber -> Text Source #

type AccountNumberMask = Refined (SizeEqualTo 4) Text Source #

accountNumberLastFour :: AccountNumber -> AccountNumberMask Source #

accountNumberToByteString :: AccountNumber -> ByteString Source #

compileAccountNumber :: QuasiQuoter Source #

newtype RoutingNumber Source #

Constructors

RoutingNumber
Fields unRoutingNumber :: Text

Instances

Instances details

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

routingNumberRegex :: Regex Source #

mkRoutingNumber :: Text -> Maybe RoutingNumber Source #

routingNumberToText :: RoutingNumber -> Text Source #

routingNumberToByteString :: RoutingNumber -> ByteString Source #

compileRoutingNumber :: QuasiQuoter Source #

newtype Iban Source #

Constructors

Iban
Fields unIban :: Text

Instances

Instances details

Eq Iban Source #
Instance details Defined in Circle.Types Methods (==) :: Iban -> Iban -> Bool # (/=) :: Iban -> Iban -> Bool #
Read Iban Source #
Instance details Defined in Circle.Types Methods readsPrec :: Int -> ReadS Iban # readList :: ReadS [Iban] # readPrec :: ReadPrec Iban # readListPrec :: ReadPrec [Iban] #
Show Iban Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Iban -> ShowS # show :: Iban -> String # showList :: [Iban] -> ShowS #
ToJSON Iban Source #
Instance details Defined in Circle.Types Methods toJSON :: Iban -> Value # toEncoding :: Iban -> Encoding # toJSONList :: [Iban] -> Value # toEncodingList :: [Iban] -> Encoding #
FromJSON Iban Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Iban # parseJSONList :: Value -> Parser [Iban] #
HasCodec Iban Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Iban # listCodecForStringCompatibility :: JSONCodec [Iban] #
Lift Iban Source #
Instance details Defined in Circle.Types Methods lift :: Iban -> Q Exp # liftTyped :: Iban -> Q (TExp Iban) #

mkIban :: Text -> Maybe Iban Source #

compileIban :: QuasiQuoter Source #

ibanToText :: Iban -> Text Source #

newtype Email 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

Email
Fields getEmailText :: Text

Instances

Instances details

Eq Email Source #
Instance details Defined in Circle.Types Methods (==) :: Email -> Email -> Bool # (/=) :: Email -> Email -> Bool #
Ord Email Source #
Instance details Defined in Circle.Types Methods compare :: Email -> Email -> Ordering # (<) :: Email -> Email -> Bool # (<=) :: Email -> Email -> Bool # (>) :: Email -> Email -> Bool # (>=) :: Email -> Email -> Bool # max :: Email -> Email -> Email # min :: Email -> Email -> Email #
Show Email Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> Email -> ShowS # show :: Email -> String # showList :: [Email] -> ShowS #
ToJSON Email Source #
Instance details Defined in Circle.Types Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding #
FromJSON Email Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser Email # parseJSONList :: Value -> Parser [Email] #
HasCodec Email Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec Email # listCodecForStringCompatibility :: JSONCodec [Email] #
Lift Email Source #
Instance details Defined in Circle.Types Methods lift :: Email -> Q Exp # liftTyped :: Email -> Q (TExp Email) #

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.

emailToText :: Email -> Text Source #

Convenience function for APIs that take emails as Text

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 City Source #

Constructors

City
Fields unCity :: Text

Instances

Instances details

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

newtype PostalCode Source #

Constructors

PostalCode
Fields unPostalCode :: Text

Instances

Instances details

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

newtype SwiftCode Source #

Constructors

SwiftCode
Fields unSwiftCode :: Text

Instances

Instances details

Eq SwiftCode Source #
Instance details Defined in Circle.Types Methods (==) :: SwiftCode -> SwiftCode -> Bool # (/=) :: SwiftCode -> SwiftCode -> Bool #
Ord SwiftCode Source #
Instance details Defined in Circle.Types Methods compare :: SwiftCode -> SwiftCode -> Ordering # (<) :: SwiftCode -> SwiftCode -> Bool # (<=) :: SwiftCode -> SwiftCode -> Bool # (>) :: SwiftCode -> SwiftCode -> Bool # (>=) :: SwiftCode -> SwiftCode -> Bool # max :: SwiftCode -> SwiftCode -> SwiftCode # min :: SwiftCode -> SwiftCode -> SwiftCode #
Show SwiftCode Source #
Instance details Defined in Circle.Types Methods showsPrec :: Int -> SwiftCode -> ShowS # show :: SwiftCode -> String # showList :: [SwiftCode] -> ShowS #
ToJSON SwiftCode Source #
Instance details Defined in Circle.Types Methods toJSON :: SwiftCode -> Value # toEncoding :: SwiftCode -> Encoding # toJSONList :: [SwiftCode] -> Value # toEncodingList :: [SwiftCode] -> Encoding #
FromJSON SwiftCode Source #
Instance details Defined in Circle.Types Methods parseJSON :: Value -> Parser SwiftCode # parseJSONList :: Value -> Parser [SwiftCode] #
HasCodec SwiftCode Source #
Instance details Defined in Circle.Types Methods codec :: JSONCodec SwiftCode # listCodecForStringCompatibility :: JSONCodec [SwiftCode] #
Lift SwiftCode Source #
Instance details Defined in Circle.Types Methods lift :: SwiftCode -> Q Exp # liftTyped :: SwiftCode -> Q (TExp SwiftCode) #

swiftCountryCodes :: Set Text Source #

swiftCodeRegex :: Regex Source #

mkSwiftCode :: Text -> Maybe SwiftCode Source #

compileSwiftCode :: QuasiQuoter 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

getCountryFromSwiftCode :: SwiftCode -> Text Source #

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.

newtype District Source #

Constructors

District
Fields unDistrict :: Text

Instances

Instances details

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

newtype ISO3166Alpha2 Source #

Constructors

ISO3166Alpha2
Fields unISO3166Alpha2 :: Text

Instances

Instances details

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

newtype TrackingReference Source #

Constructors

TrackingReference
Fields unTrackingReference :: Text

Instances

Instances details

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

newtype HexString Source #

Constructors

HexString
Fields unHexString :: Text

Instances

Instances details

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

newtype WalletId Source #

Constructors

WalletId
Fields unWalletId :: Text

Instances

Instances details

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

Orphan instances

HasCodec UUID Source #
Instance details Methods codec :: JSONCodec UUID # listCodecForStringCompatibility :: JSONCodec [UUID] #

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