StripeAPI.Types.Issuing_Settlement

Contains the types generated from the schema Issuing_Settlement

Documentation

data Issuing'settlement

Defines the object schema located at components.schemas.issuing.settlement in the specification.

When a non-stripe BIN is used, any use of an issued card must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.

Constructors

Issuing'settlement

Fields

• issuing'settlementBin :: Text

  bin: The Bank Identification Number reflecting this settlement record.

  Constraints:

  • Maximum length of 5000
• issuing'settlementClearingDate :: Int

  clearing_date: The date that the transactions are cleared and posted to user's accounts.

• issuing'settlementCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• issuing'settlementCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• issuing'settlementId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• issuing'settlementInterchangeFees :: Int

  interchange_fees: The total interchange received as reimbursement for the transactions.

• issuing'settlementLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• issuing'settlementMetadata :: Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• issuing'settlementNetTotal :: Int

  net_total: The total net amount required to settle with the network.

• issuing'settlementNetworkFees :: Int

  network_fees: The total amount of fees owed to the network.

• issuing'settlementNetworkSettlementIdentifier :: Text

  network_settlement_identifier: The Settlement Identification Number assigned by the network.

  Constraints:

  • Maximum length of 5000
• issuing'settlementSettlementService :: Text

  settlement_service: One of `international` or `uk_national_net`.

  Constraints:

  • Maximum length of 5000
• issuing'settlementTransactionCount :: Int

  transaction_count: The total number of transactions reflected in this settlement.

• issuing'settlementTransactionVolume :: Int

  transaction_volume: The total transaction amount reflected in this settlement.

Instances

Eq Issuing'settlement

Defined in StripeAPI.Types.Issuing_Settlement

Methods

(==) :: Issuing'settlement -> Issuing'settlement -> Bool

(/=) :: Issuing'settlement -> Issuing'settlement -> Bool

Show Issuing'settlement

Defined in StripeAPI.Types.Issuing_Settlement

Methods

showsPrec :: Int -> Issuing'settlement -> ShowS

show :: Issuing'settlement -> String

showList :: [Issuing'settlement] -> ShowS

ToJSON Issuing'settlement

Defined in StripeAPI.Types.Issuing_Settlement

Methods

toJSON :: Issuing'settlement -> Value

toEncoding :: Issuing'settlement -> Encoding

toJSONList :: [Issuing'settlement] -> Value

toEncodingList :: [Issuing'settlement] -> Encoding

FromJSON Issuing'settlement

Defined in StripeAPI.Types.Issuing_Settlement

Methods

parseJSON :: Value -> Parser Issuing'settlement

parseJSONList :: Value -> Parser [Issuing'settlement]

mkIssuing'settlement

Arguments

:: Text

issuing'settlementBin

-> Int

issuing'settlementClearingDate

-> Int

issuing'settlementCreated

-> Text

issuing'settlementCurrency

-> Text

issuing'settlementId

-> Int

issuing'settlementInterchangeFees

-> Bool

issuing'settlementLivemode

-> Object

issuing'settlementMetadata

-> Int

issuing'settlementNetTotal

-> Int

issuing'settlementNetworkFees

-> Text

issuing'settlementNetworkSettlementIdentifier

-> Text

issuing'settlementSettlementService

-> Int

issuing'settlementTransactionCount

-> Int

issuing'settlementTransactionVolume

-> Issuing'settlement

Create a new Issuing'settlement with all required fields.