StripeAPI.Operations.PostChargesChargeDispute

Contains the different functions to run the operation postChargesChargeDispute

Documentation

postChargesChargeDispute

Arguments

:: forall m. MonadHTTP m

=> Text

charge | Constraints: Maximum length of 5000

-> Maybe PostChargesChargeDisputeRequestBody

The request body to send

-> ClientT m (Response PostChargesChargeDisputeResponse)

Monadic computation which returns the result of the operation

POST /v1/charges/{charge}/dispute

data PostChargesChargeDisputeRequestBody

Defines the object schema located at paths./v1/charges/{charge}/dispute.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostChargesChargeDisputeRequestBody

Fields

• postChargesChargeDisputeRequestBodyEvidence :: Maybe PostChargesChargeDisputeRequestBodyEvidence'

  evidence: Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.

• postChargesChargeDisputeRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postChargesChargeDisputeRequestBodyMetadata :: Maybe PostChargesChargeDisputeRequestBodyMetadata'Variants

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

• postChargesChargeDisputeRequestBodySubmit :: Maybe Bool

  submit: Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).

Instances

Eq PostChargesChargeDisputeRequestBody

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

(==) :: PostChargesChargeDisputeRequestBody -> PostChargesChargeDisputeRequestBody -> Bool

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

Show PostChargesChargeDisputeRequestBody

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

showsPrec :: Int -> PostChargesChargeDisputeRequestBody -> ShowS

show :: PostChargesChargeDisputeRequestBody -> String

showList :: [PostChargesChargeDisputeRequestBody] -> ShowS

ToJSON PostChargesChargeDisputeRequestBody

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

toJSON :: PostChargesChargeDisputeRequestBody -> Value

toEncoding :: PostChargesChargeDisputeRequestBody -> Encoding

toJSONList :: [PostChargesChargeDisputeRequestBody] -> Value

toEncodingList :: [PostChargesChargeDisputeRequestBody] -> Encoding

FromJSON PostChargesChargeDisputeRequestBody

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

parseJSON :: Value -> Parser PostChargesChargeDisputeRequestBody

parseJSONList :: Value -> Parser [PostChargesChargeDisputeRequestBody]

mkPostChargesChargeDisputeRequestBody :: PostChargesChargeDisputeRequestBody

Create a new PostChargesChargeDisputeRequestBody with all required fields.

data PostChargesChargeDisputeRequestBodyEvidence'

Defines the object schema located at paths./v1/charges/{charge}/dispute.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.evidence in the specification.

Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.

Constructors

PostChargesChargeDisputeRequestBodyEvidence'

Fields

• postChargesChargeDisputeRequestBodyEvidence'AccessActivityLog :: Maybe Text

  access_activity_log

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'BillingAddress :: Maybe Text

  billing_address

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'CancellationPolicy :: Maybe Text

  cancellation_policy

• postChargesChargeDisputeRequestBodyEvidence'CancellationPolicyDisclosure :: Maybe Text

  cancellation_policy_disclosure

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'CancellationRebuttal :: Maybe Text

  cancellation_rebuttal

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'CustomerCommunication :: Maybe Text

  customer_communication

• postChargesChargeDisputeRequestBodyEvidence'CustomerEmailAddress :: Maybe Text

  customer_email_address

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'CustomerName :: Maybe Text

  customer_name

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'CustomerPurchaseIp :: Maybe Text

  customer_purchase_ip

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'CustomerSignature :: Maybe Text

  customer_signature

• postChargesChargeDisputeRequestBodyEvidence'DuplicateChargeDocumentation :: Maybe Text

  duplicate_charge_documentation

• postChargesChargeDisputeRequestBodyEvidence'DuplicateChargeExplanation :: Maybe Text

  duplicate_charge_explanation

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'DuplicateChargeId :: Maybe Text

  duplicate_charge_id

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'ProductDescription :: Maybe Text

  product_description

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'Receipt :: Maybe Text

  receipt

• postChargesChargeDisputeRequestBodyEvidence'RefundPolicy :: Maybe Text

  refund_policy

• postChargesChargeDisputeRequestBodyEvidence'RefundPolicyDisclosure :: Maybe Text

  refund_policy_disclosure

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'RefundRefusalExplanation :: Maybe Text

  refund_refusal_explanation

  Constraints:

  • Maximum length of 20000
• postChargesChargeDisputeRequestBodyEvidence'ServiceDate :: Maybe Text

  service_date

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'ServiceDocumentation :: Maybe Text

  service_documentation

• postChargesChargeDisputeRequestBodyEvidence'ShippingAddress :: Maybe Text

  shipping_address

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'ShippingCarrier :: Maybe Text

  shipping_carrier

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'ShippingDate :: Maybe Text

  shipping_date

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'ShippingDocumentation :: Maybe Text

  shipping_documentation

• postChargesChargeDisputeRequestBodyEvidence'ShippingTrackingNumber :: Maybe Text

  shipping_tracking_number

  Constraints:

  • Maximum length of 5000
• postChargesChargeDisputeRequestBodyEvidence'UncategorizedFile :: Maybe Text

  uncategorized_file

• postChargesChargeDisputeRequestBodyEvidence'UncategorizedText :: Maybe Text

  uncategorized_text

  Constraints:

  • Maximum length of 20000

Instances

Eq PostChargesChargeDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

(==) :: PostChargesChargeDisputeRequestBodyEvidence' -> PostChargesChargeDisputeRequestBodyEvidence' -> Bool

(/=) :: PostChargesChargeDisputeRequestBodyEvidence' -> PostChargesChargeDisputeRequestBodyEvidence' -> Bool

Show PostChargesChargeDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

showsPrec :: Int -> PostChargesChargeDisputeRequestBodyEvidence' -> ShowS

show :: PostChargesChargeDisputeRequestBodyEvidence' -> String

showList :: [PostChargesChargeDisputeRequestBodyEvidence'] -> ShowS

ToJSON PostChargesChargeDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

toJSON :: PostChargesChargeDisputeRequestBodyEvidence' -> Value

toEncoding :: PostChargesChargeDisputeRequestBodyEvidence' -> Encoding

toJSONList :: [PostChargesChargeDisputeRequestBodyEvidence'] -> Value

toEncodingList :: [PostChargesChargeDisputeRequestBodyEvidence'] -> Encoding

FromJSON PostChargesChargeDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

parseJSON :: Value -> Parser PostChargesChargeDisputeRequestBodyEvidence'

parseJSONList :: Value -> Parser [PostChargesChargeDisputeRequestBodyEvidence']

mkPostChargesChargeDisputeRequestBodyEvidence' :: PostChargesChargeDisputeRequestBodyEvidence'

Create a new PostChargesChargeDisputeRequestBodyEvidence' with all required fields.

data PostChargesChargeDisputeRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/charges/{charge}/dispute.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostChargesChargeDisputeRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostChargesChargeDisputeRequestBodyMetadata'Object Object

Instances

Eq PostChargesChargeDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

(==) :: PostChargesChargeDisputeRequestBodyMetadata'Variants -> PostChargesChargeDisputeRequestBodyMetadata'Variants -> Bool

(/=) :: PostChargesChargeDisputeRequestBodyMetadata'Variants -> PostChargesChargeDisputeRequestBodyMetadata'Variants -> Bool

Show PostChargesChargeDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

showsPrec :: Int -> PostChargesChargeDisputeRequestBodyMetadata'Variants -> ShowS

show :: PostChargesChargeDisputeRequestBodyMetadata'Variants -> String

showList :: [PostChargesChargeDisputeRequestBodyMetadata'Variants] -> ShowS

ToJSON PostChargesChargeDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

toJSON :: PostChargesChargeDisputeRequestBodyMetadata'Variants -> Value

toEncoding :: PostChargesChargeDisputeRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostChargesChargeDisputeRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostChargesChargeDisputeRequestBodyMetadata'Variants] -> Encoding

FromJSON PostChargesChargeDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

parseJSON :: Value -> Parser PostChargesChargeDisputeRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostChargesChargeDisputeRequestBodyMetadata'Variants]

data PostChargesChargeDisputeResponse

Represents a response of the operation postChargesChargeDispute.

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), PostChargesChargeDisputeResponseError is used.

Constructors

PostChargesChargeDisputeResponseError String

Means either no matching case available or a parse error

PostChargesChargeDisputeResponse200 Dispute

Successful response.

PostChargesChargeDisputeResponseDefault Error

Error response.

Instances

Eq PostChargesChargeDisputeResponse

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

(==) :: PostChargesChargeDisputeResponse -> PostChargesChargeDisputeResponse -> Bool

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

Show PostChargesChargeDisputeResponse

Defined in StripeAPI.Operations.PostChargesChargeDispute

Methods

showsPrec :: Int -> PostChargesChargeDisputeResponse -> ShowS

show :: PostChargesChargeDisputeResponse -> String

showList :: [PostChargesChargeDisputeResponse] -> ShowS