stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostSourcesSource

Description

Contains the different functions to run the operation postSourcesSource

Synopsis

Documentation

postSourcesSource Source #

Arguments

:: forall m. MonadHTTP m 
=> Text

source | Constraints: Maximum length of 5000

-> Maybe PostSourcesSourceRequestBody

The request body to send

-> StripeT m (Response PostSourcesSourceResponse)

Monadic computation which returns the result of the operation

POST /v1/sources/{source}

<p>Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

<p>This request accepts the <code>metadata</code> and <code>owner</code> as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our <a href="/docs/sources">payment method guides</a> for more detail.</p>

data PostSourcesSourceRequestBody Source #

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

Constructors

PostSourcesSourceRequestBody 

Fields

data PostSourcesSourceRequestBodyMandate' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate in the specification.

Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.

data PostSourcesSourceRequestBodyMandate'Acceptance' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance in the specification.

data PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.offline in the specification.

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.online in the specification.

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source #

Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.status in the specification.

Constructors

PostSourcesSourceRequestBodyMandate'Acceptance'Status'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSourcesSourceRequestBodyMandate'Acceptance'Status'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumAccepted

Represents the JSON value "accepted"

PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumPending

Represents the JSON value "pending"

PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRefused

Represents the JSON value "refused"

PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRevoked

Represents the JSON value "revoked"

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source #

Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.type in the specification.

Constructors

PostSourcesSourceRequestBodyMandate'Acceptance'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSourcesSourceRequestBodyMandate'Acceptance'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSourcesSourceRequestBodyMandate'Acceptance'Type'EnumOffline

Represents the JSON value "offline"

PostSourcesSourceRequestBodyMandate'Acceptance'Type'EnumOnline

Represents the JSON value "online"

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMandate'Amount'Variants Source #

Defines the oneOf schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.amount.anyOf in the specification.

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'Amount'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'Amount'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'Amount'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'Amount'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMandate'Interval' Source #

Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.interval in the specification.

Constructors

PostSourcesSourceRequestBodyMandate'Interval'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSourcesSourceRequestBodyMandate'Interval'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSourcesSourceRequestBodyMandate'Interval'EnumOneTime

Represents the JSON value "one_time"

PostSourcesSourceRequestBodyMandate'Interval'EnumScheduled

Represents the JSON value "scheduled"

PostSourcesSourceRequestBodyMandate'Interval'EnumVariable

Represents the JSON value "variable"

data PostSourcesSourceRequestBodyMandate'NotificationMethod' Source #

Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.notification_method in the specification.

Constructors

PostSourcesSourceRequestBodyMandate'NotificationMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSourcesSourceRequestBodyMandate'NotificationMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumDeprecatedNone

Represents the JSON value "deprecated_none"

PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumEmail

Represents the JSON value "email"

PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumManual

Represents the JSON value "manual"

PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumNone

Represents the JSON value "none"

PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumStripeEmail

Represents the JSON value "stripe_email"

Instances

Instances details
Eq PostSourcesSourceRequestBodyMandate'NotificationMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodyMandate'NotificationMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodyMandate'NotificationMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodyMandate'NotificationMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/sources/{source}.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`.

data PostSourcesSourceRequestBodyOwner' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.owner in the specification.

Information about the owner of the payment instrument that may be used or required by particular source types.

data PostSourcesSourceRequestBodyOwner'Address' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.owner.properties.address in the specification.

Constructors

PostSourcesSourceRequestBodyOwner'Address' 

Fields

data PostSourcesSourceRequestBodySourceOrder' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order in the specification.

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

data PostSourcesSourceRequestBodySourceOrder'Items' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.items.items in the specification.

data PostSourcesSourceRequestBodySourceOrder'Items'Type' Source #

Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.items.items.properties.type in the specification.

Constructors

PostSourcesSourceRequestBodySourceOrder'Items'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSourcesSourceRequestBodySourceOrder'Items'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumDiscount

Represents the JSON value "discount"

PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumShipping

Represents the JSON value "shipping"

PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumSku

Represents the JSON value "sku"

PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumTax

Represents the JSON value "tax"

Instances

Instances details
Eq PostSourcesSourceRequestBodySourceOrder'Items'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodySourceOrder'Items'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodySourceOrder'Items'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodySourceOrder'Items'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodySourceOrder'Shipping' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.shipping in the specification.

Instances

Instances details
Eq PostSourcesSourceRequestBodySourceOrder'Shipping' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodySourceOrder'Shipping' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodySourceOrder'Shipping' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodySourceOrder'Shipping' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source #

Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.shipping.properties.address in the specification.

Instances

Instances details
Eq PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

Show PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

ToJSON PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

FromJSON PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSourcesSource

data PostSourcesSourceResponse Source #

Represents a response of the operation postSourcesSource.

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

Constructors

PostSourcesSourceResponseError String

Means either no matching case available or a parse error

PostSourcesSourceResponse200 Source

Successful response.

PostSourcesSourceResponseDefault Error

Error response.