StripeAPI.Operations.PostDisputesDispute

Contains the different functions to run the operation postDisputesDispute

Documentation

postDisputesDispute

Arguments

:: forall m. MonadHTTP m

=> Text

dispute | Constraints: Maximum length of 5000

-> Maybe PostDisputesDisputeRequestBody

The request body to send

-> ClientT m (Response PostDisputesDisputeResponse)

Monadic computation which returns the result of the operation

POST /v1/disputes/{dispute}

<p>When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p>

<p>Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our <a href="/docs/disputes/categories">guide to dispute types</a>.</p>

data PostDisputesDisputeRequestBody

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

Constructors

PostDisputesDisputeRequestBody

Fields

• postDisputesDisputeRequestBodyEvidence :: Maybe PostDisputesDisputeRequestBodyEvidence'

  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.

• postDisputesDisputeRequestBodyExpand :: Maybe [Text]

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

• postDisputesDisputeRequestBodyMetadata :: Maybe PostDisputesDisputeRequestBodyMetadata'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`.

• postDisputesDisputeRequestBodySubmit :: 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 PostDisputesDisputeRequestBody

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

(==) :: PostDisputesDisputeRequestBody -> PostDisputesDisputeRequestBody -> Bool

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

Show PostDisputesDisputeRequestBody

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

showsPrec :: Int -> PostDisputesDisputeRequestBody -> ShowS

show :: PostDisputesDisputeRequestBody -> String

showList :: [PostDisputesDisputeRequestBody] -> ShowS

ToJSON PostDisputesDisputeRequestBody

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

toJSON :: PostDisputesDisputeRequestBody -> Value

toEncoding :: PostDisputesDisputeRequestBody -> Encoding

toJSONList :: [PostDisputesDisputeRequestBody] -> Value

toEncodingList :: [PostDisputesDisputeRequestBody] -> Encoding

FromJSON PostDisputesDisputeRequestBody

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

parseJSON :: Value -> Parser PostDisputesDisputeRequestBody

parseJSONList :: Value -> Parser [PostDisputesDisputeRequestBody]

mkPostDisputesDisputeRequestBody :: PostDisputesDisputeRequestBody

Create a new PostDisputesDisputeRequestBody with all required fields.

data PostDisputesDisputeRequestBodyEvidence'

Defines the object schema located at paths./v1/disputes/{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

PostDisputesDisputeRequestBodyEvidence'

Fields

• postDisputesDisputeRequestBodyEvidence'AccessActivityLog :: Maybe Text

  access_activity_log

  Constraints:

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

  billing_address

  Constraints:

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

  cancellation_policy

• postDisputesDisputeRequestBodyEvidence'CancellationPolicyDisclosure :: Maybe Text

  cancellation_policy_disclosure

  Constraints:

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

  cancellation_rebuttal

  Constraints:

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

  customer_communication

• postDisputesDisputeRequestBodyEvidence'CustomerEmailAddress :: Maybe Text

  customer_email_address

  Constraints:

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

  customer_name

  Constraints:

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

  customer_purchase_ip

  Constraints:

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

  customer_signature

• postDisputesDisputeRequestBodyEvidence'DuplicateChargeDocumentation :: Maybe Text

  duplicate_charge_documentation

• postDisputesDisputeRequestBodyEvidence'DuplicateChargeExplanation :: Maybe Text

  duplicate_charge_explanation

  Constraints:

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

  duplicate_charge_id

  Constraints:

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

  product_description

  Constraints:

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

  receipt

• postDisputesDisputeRequestBodyEvidence'RefundPolicy :: Maybe Text

  refund_policy

• postDisputesDisputeRequestBodyEvidence'RefundPolicyDisclosure :: Maybe Text

  refund_policy_disclosure

  Constraints:

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

  refund_refusal_explanation

  Constraints:

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

  service_date

  Constraints:

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

  service_documentation

• postDisputesDisputeRequestBodyEvidence'ShippingAddress :: Maybe Text

  shipping_address

  Constraints:

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

  shipping_carrier

  Constraints:

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

  shipping_date

  Constraints:

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

  shipping_documentation

• postDisputesDisputeRequestBodyEvidence'ShippingTrackingNumber :: Maybe Text

  shipping_tracking_number

  Constraints:

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

  uncategorized_file

• postDisputesDisputeRequestBodyEvidence'UncategorizedText :: Maybe Text

  uncategorized_text

  Constraints:

  • Maximum length of 20000

Instances

Eq PostDisputesDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

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

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

Show PostDisputesDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

showsPrec :: Int -> PostDisputesDisputeRequestBodyEvidence' -> ShowS

show :: PostDisputesDisputeRequestBodyEvidence' -> String

showList :: [PostDisputesDisputeRequestBodyEvidence'] -> ShowS

ToJSON PostDisputesDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

toJSON :: PostDisputesDisputeRequestBodyEvidence' -> Value

toEncoding :: PostDisputesDisputeRequestBodyEvidence' -> Encoding

toJSONList :: [PostDisputesDisputeRequestBodyEvidence'] -> Value

toEncodingList :: [PostDisputesDisputeRequestBodyEvidence'] -> Encoding

FromJSON PostDisputesDisputeRequestBodyEvidence'

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

parseJSON :: Value -> Parser PostDisputesDisputeRequestBodyEvidence'

parseJSONList :: Value -> Parser [PostDisputesDisputeRequestBodyEvidence']

mkPostDisputesDisputeRequestBodyEvidence' :: PostDisputesDisputeRequestBodyEvidence'

Create a new PostDisputesDisputeRequestBodyEvidence' with all required fields.

data PostDisputesDisputeRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/disputes/{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

PostDisputesDisputeRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostDisputesDisputeRequestBodyMetadata'Object Object

Instances

Eq PostDisputesDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

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

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

Show PostDisputesDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

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

show :: PostDisputesDisputeRequestBodyMetadata'Variants -> String

showList :: [PostDisputesDisputeRequestBodyMetadata'Variants] -> ShowS

ToJSON PostDisputesDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

toJSON :: PostDisputesDisputeRequestBodyMetadata'Variants -> Value

toEncoding :: PostDisputesDisputeRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostDisputesDisputeRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostDisputesDisputeRequestBodyMetadata'Variants] -> Encoding

FromJSON PostDisputesDisputeRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

parseJSON :: Value -> Parser PostDisputesDisputeRequestBodyMetadata'Variants

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

data PostDisputesDisputeResponse

Represents a response of the operation postDisputesDispute.

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

Constructors

PostDisputesDisputeResponseError String

Means either no matching case available or a parse error

PostDisputesDisputeResponse200 Dispute

Successful response.

PostDisputesDisputeResponseDefault Error

Error response.

Instances

Eq PostDisputesDisputeResponse

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

(==) :: PostDisputesDisputeResponse -> PostDisputesDisputeResponse -> Bool

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

Show PostDisputesDisputeResponse

Defined in StripeAPI.Operations.PostDisputesDispute

Methods

showsPrec :: Int -> PostDisputesDisputeResponse -> ShowS

show :: PostDisputesDisputeResponse -> String

showList :: [PostDisputesDisputeResponse] -> ShowS