stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostSources

Description

Contains the different functions to run the operation postSources

Synopsis

Documentation

postSources Source #

Arguments

:: forall m. MonadHTTP m 
=> Maybe PostSourcesRequestBody

The request body to send

-> StripeT m (Response PostSourcesResponse)

Monadic computation which returns the result of the operation

POST /v1/sources

<p>Creates a new source object.</p>

data PostSourcesRequestBody Source #

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

Constructors

PostSourcesRequestBody 

Fields

data PostSourcesRequestBodyFlow' Source #

Defines the enum schema located at paths./v1/sources.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.flow in the specification.

The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.

Constructors

PostSourcesRequestBodyFlow'Other Value

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

PostSourcesRequestBodyFlow'Typed Text

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

PostSourcesRequestBodyFlow'EnumCodeVerification

Represents the JSON value "code_verification"

PostSourcesRequestBodyFlow'EnumNone

Represents the JSON value "none"

PostSourcesRequestBodyFlow'EnumReceiver

Represents the JSON value "receiver"

PostSourcesRequestBodyFlow'EnumRedirect

Represents the JSON value "redirect"

data PostSourcesRequestBodyMandate' Source #

Defines the object schema located at paths./v1/sources.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 PostSourcesRequestBodyMandate'Acceptance' Source #

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

data PostSourcesRequestBodyMandate'Acceptance'Offline' Source #

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

data PostSourcesRequestBodyMandate'Acceptance'Online' Source #

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

data PostSourcesRequestBodyMandate'Acceptance'Status' Source #

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

Constructors

PostSourcesRequestBodyMandate'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.

PostSourcesRequestBodyMandate'Acceptance'Status'Typed Text

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

PostSourcesRequestBodyMandate'Acceptance'Status'EnumAccepted

Represents the JSON value "accepted"

PostSourcesRequestBodyMandate'Acceptance'Status'EnumPending

Represents the JSON value "pending"

PostSourcesRequestBodyMandate'Acceptance'Status'EnumRefused

Represents the JSON value "refused"

PostSourcesRequestBodyMandate'Acceptance'Status'EnumRevoked

Represents the JSON value "revoked"

data PostSourcesRequestBodyMandate'Acceptance'Type' Source #

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

Constructors

PostSourcesRequestBodyMandate'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.

PostSourcesRequestBodyMandate'Acceptance'Type'Typed Text

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

PostSourcesRequestBodyMandate'Acceptance'Type'EnumOffline

Represents the JSON value "offline"

PostSourcesRequestBodyMandate'Acceptance'Type'EnumOnline

Represents the JSON value "online"

data PostSourcesRequestBodyMandate'Amount'Variants Source #

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

data PostSourcesRequestBodyMandate'Interval' Source #

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

Constructors

PostSourcesRequestBodyMandate'Interval'Other Value

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

PostSourcesRequestBodyMandate'Interval'Typed Text

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

PostSourcesRequestBodyMandate'Interval'EnumOneTime

Represents the JSON value "one_time"

PostSourcesRequestBodyMandate'Interval'EnumScheduled

Represents the JSON value "scheduled"

PostSourcesRequestBodyMandate'Interval'EnumVariable

Represents the JSON value "variable"

data PostSourcesRequestBodyMandate'NotificationMethod' Source #

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

Constructors

PostSourcesRequestBodyMandate'NotificationMethod'Other Value

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

PostSourcesRequestBodyMandate'NotificationMethod'Typed Text

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

PostSourcesRequestBodyMandate'NotificationMethod'EnumDeprecatedNone

Represents the JSON value "deprecated_none"

PostSourcesRequestBodyMandate'NotificationMethod'EnumEmail

Represents the JSON value "email"

PostSourcesRequestBodyMandate'NotificationMethod'EnumManual

Represents the JSON value "manual"

PostSourcesRequestBodyMandate'NotificationMethod'EnumNone

Represents the JSON value "none"

PostSourcesRequestBodyMandate'NotificationMethod'EnumStripeEmail

Represents the JSON value "stripe_email"

data PostSourcesRequestBodyOwner' Source #

Defines the object schema located at paths./v1/sources.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 PostSourcesRequestBodyOwner'Address' Source #

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

Constructors

PostSourcesRequestBodyOwner'Address' 

Fields

data PostSourcesRequestBodyReceiver' Source #

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

Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).

data PostSourcesRequestBodyReceiver'RefundAttributesMethod' Source #

Defines the enum schema located at paths./v1/sources.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.receiver.properties.refund_attributes_method in the specification.

Constructors

PostSourcesRequestBodyReceiver'RefundAttributesMethod'Other Value

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

PostSourcesRequestBodyReceiver'RefundAttributesMethod'Typed Text

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

PostSourcesRequestBodyReceiver'RefundAttributesMethod'EnumEmail

Represents the JSON value "email"

PostSourcesRequestBodyReceiver'RefundAttributesMethod'EnumManual

Represents the JSON value "manual"

PostSourcesRequestBodyReceiver'RefundAttributesMethod'EnumNone

Represents the JSON value "none"

Instances

Instances details
Eq PostSourcesRequestBodyReceiver'RefundAttributesMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

Show PostSourcesRequestBodyReceiver'RefundAttributesMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

ToJSON PostSourcesRequestBodyReceiver'RefundAttributesMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

FromJSON PostSourcesRequestBodyReceiver'RefundAttributesMethod' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

data PostSourcesRequestBodyRedirect' Source #

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

Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).

data PostSourcesRequestBodySourceOrder' Source #

Defines the object schema located at paths./v1/sources.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 PostSourcesRequestBodySourceOrder'Items' Source #

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

data PostSourcesRequestBodySourceOrder'Items'Type' Source #

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

Constructors

PostSourcesRequestBodySourceOrder'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.

PostSourcesRequestBodySourceOrder'Items'Type'Typed Text

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

PostSourcesRequestBodySourceOrder'Items'Type'EnumDiscount

Represents the JSON value "discount"

PostSourcesRequestBodySourceOrder'Items'Type'EnumShipping

Represents the JSON value "shipping"

PostSourcesRequestBodySourceOrder'Items'Type'EnumSku

Represents the JSON value "sku"

PostSourcesRequestBodySourceOrder'Items'Type'EnumTax

Represents the JSON value "tax"

data PostSourcesRequestBodySourceOrder'Shipping' Source #

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

data PostSourcesRequestBodySourceOrder'Shipping'Address' Source #

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

Instances

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

Defined in StripeAPI.Operations.PostSources

Show PostSourcesRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

ToJSON PostSourcesRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

FromJSON PostSourcesRequestBodySourceOrder'Shipping'Address' Source # 
Instance details

Defined in StripeAPI.Operations.PostSources

data PostSourcesRequestBodyUsage' Source #

Defines the enum schema located at paths./v1/sources.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.usage in the specification.

Constructors

PostSourcesRequestBodyUsage'Other Value

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

PostSourcesRequestBodyUsage'Typed Text

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

PostSourcesRequestBodyUsage'EnumReusable

Represents the JSON value "reusable"

PostSourcesRequestBodyUsage'EnumSingleUse

Represents the JSON value "single_use"

data PostSourcesResponse Source #

Represents a response of the operation postSources.

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

Constructors

PostSourcesResponseError String

Means either no matching case available or a parse error

PostSourcesResponse200 Source

Successful response.

PostSourcesResponseDefault Error

Error response.