StripeAPI.Operations.GetBitcoinTransactions

Contains the different functions to run the operation getBitcoinTransactions

Documentation

getBitcoinTransactions

Arguments

:: forall m. MonadHTTP m

=> GetBitcoinTransactionsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetBitcoinTransactionsResponse)

Monadic computation which returns the result of the operation

GET /v1/bitcoin/transactions

<p>List bitcoin transacitons for a given receiver.</p>

data GetBitcoinTransactionsParameters

Defines the object schema located at paths./v1/bitcoin/transactions.GET.parameters in the specification.

Constructors

GetBitcoinTransactionsParameters

Fields

• getBitcoinTransactionsParametersQueryCustomer :: Maybe Text

  queryCustomer: Represents the parameter named 'customer'

  Only return transactions for the customer specified by this customer ID.

  Constraints:

  • Maximum length of 5000
• getBitcoinTransactionsParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named 'ending_before'

  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

  Constraints:

  • Maximum length of 5000
• getBitcoinTransactionsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getBitcoinTransactionsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• getBitcoinTransactionsParametersQueryReceiver :: Maybe Text

  queryReceiver: Represents the parameter named 'receiver'

  Constraints:

  • Maximum length of 5000
• getBitcoinTransactionsParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named 'starting_after'

  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetBitcoinTransactionsParameters

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

(==) :: GetBitcoinTransactionsParameters -> GetBitcoinTransactionsParameters -> Bool

(/=) :: GetBitcoinTransactionsParameters -> GetBitcoinTransactionsParameters -> Bool

Show GetBitcoinTransactionsParameters

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

showsPrec :: Int -> GetBitcoinTransactionsParameters -> ShowS

show :: GetBitcoinTransactionsParameters -> String

showList :: [GetBitcoinTransactionsParameters] -> ShowS

ToJSON GetBitcoinTransactionsParameters

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

toJSON :: GetBitcoinTransactionsParameters -> Value

toEncoding :: GetBitcoinTransactionsParameters -> Encoding

toJSONList :: [GetBitcoinTransactionsParameters] -> Value

toEncodingList :: [GetBitcoinTransactionsParameters] -> Encoding

FromJSON GetBitcoinTransactionsParameters

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

parseJSON :: Value -> Parser GetBitcoinTransactionsParameters

parseJSONList :: Value -> Parser [GetBitcoinTransactionsParameters]

mkGetBitcoinTransactionsParameters :: GetBitcoinTransactionsParameters

Create a new GetBitcoinTransactionsParameters with all required fields.

data GetBitcoinTransactionsResponse

Represents a response of the operation getBitcoinTransactions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetBitcoinTransactionsResponseError is used.

Constructors

GetBitcoinTransactionsResponseError String

Means either no matching case available or a parse error

GetBitcoinTransactionsResponse200 GetBitcoinTransactionsResponseBody200

Successful response.

GetBitcoinTransactionsResponseDefault Error

Error response.

Instances

Eq GetBitcoinTransactionsResponse

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

(==) :: GetBitcoinTransactionsResponse -> GetBitcoinTransactionsResponse -> Bool

(/=) :: GetBitcoinTransactionsResponse -> GetBitcoinTransactionsResponse -> Bool

Show GetBitcoinTransactionsResponse

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

showsPrec :: Int -> GetBitcoinTransactionsResponse -> ShowS

show :: GetBitcoinTransactionsResponse -> String

showList :: [GetBitcoinTransactionsResponse] -> ShowS

data GetBitcoinTransactionsResponseBody200

Defines the object schema located at paths./v1/bitcoin/transactions.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetBitcoinTransactionsResponseBody200

Fields

• getBitcoinTransactionsResponseBody200Data :: [BitcoinTransaction]

  data: Details about each object.

• getBitcoinTransactionsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getBitcoinTransactionsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetBitcoinTransactionsResponseBody200

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

(==) :: GetBitcoinTransactionsResponseBody200 -> GetBitcoinTransactionsResponseBody200 -> Bool

(/=) :: GetBitcoinTransactionsResponseBody200 -> GetBitcoinTransactionsResponseBody200 -> Bool

Show GetBitcoinTransactionsResponseBody200

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

showsPrec :: Int -> GetBitcoinTransactionsResponseBody200 -> ShowS

show :: GetBitcoinTransactionsResponseBody200 -> String

showList :: [GetBitcoinTransactionsResponseBody200] -> ShowS

ToJSON GetBitcoinTransactionsResponseBody200

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

toJSON :: GetBitcoinTransactionsResponseBody200 -> Value

toEncoding :: GetBitcoinTransactionsResponseBody200 -> Encoding

toJSONList :: [GetBitcoinTransactionsResponseBody200] -> Value

toEncodingList :: [GetBitcoinTransactionsResponseBody200] -> Encoding

FromJSON GetBitcoinTransactionsResponseBody200

Defined in StripeAPI.Operations.GetBitcoinTransactions

Methods

parseJSON :: Value -> Parser GetBitcoinTransactionsResponseBody200

parseJSONList :: Value -> Parser [GetBitcoinTransactionsResponseBody200]

mkGetBitcoinTransactionsResponseBody200

Arguments

:: [BitcoinTransaction]

getBitcoinTransactionsResponseBody200Data

-> Bool

getBitcoinTransactionsResponseBody200HasMore

-> Text

getBitcoinTransactionsResponseBody200Url

-> GetBitcoinTransactionsResponseBody200

Create a new GetBitcoinTransactionsResponseBody200 with all required fields.