StripeAPI.Operations.PostRecipients

Contains the different functions to run the operation postRecipients

Documentation

postRecipients

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> PostRecipientsRequestBody

The request body to send

-> m (Either HttpException (Response PostRecipientsResponse))

Monad containing the result of the operation

POST /v1/recipients

<p>Creates a new <code>Recipient</code> object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.</p>

postRecipientsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostRecipientsRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/recipients

The same as postRecipients but returns the raw ByteString

postRecipientsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostRecipientsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostRecipientsResponse))

POST /v1/recipients

Monadic version of postRecipients (use with runWithConfiguration)

postRecipientsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostRecipientsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/recipients

Monadic version of postRecipientsRaw (use with runWithConfiguration)

data PostRecipientsRequestBody

Defines the data type for the schema postRecipientsRequestBody

Constructors

PostRecipientsRequestBody

Fields

• postRecipientsRequestBodyBankAccount :: Maybe String

  bank_account: A bank account to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details, with the options described below.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyCard :: Maybe String

  card: A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyDescription :: Maybe String

  description: An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyEmail :: Maybe String

  email: The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyExpand :: Maybe ([] String)

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

• postRecipientsRequestBodyMetadata :: Maybe PostRecipientsRequestBodyMetadata'

  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`.

• postRecipientsRequestBodyName :: String

  name: The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyTaxId :: Maybe String

  tax_id: The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN.

  Constraints:

  • Maximum length of 5000
• postRecipientsRequestBodyType :: String

  type: Type of the recipient: either `individual` or `corporation`.

  Constraints:

  • Maximum length of 5000

Instances

Eq PostRecipientsRequestBody

Defined in StripeAPI.Operations.PostRecipients

Methods

(==) :: PostRecipientsRequestBody -> PostRecipientsRequestBody -> Bool

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

Show PostRecipientsRequestBody

Defined in StripeAPI.Operations.PostRecipients

Methods

showsPrec :: Int -> PostRecipientsRequestBody -> ShowS

show :: PostRecipientsRequestBody -> String

showList :: [PostRecipientsRequestBody] -> ShowS

ToJSON PostRecipientsRequestBody

Defined in StripeAPI.Operations.PostRecipients

Methods

toJSON :: PostRecipientsRequestBody -> Value

toEncoding :: PostRecipientsRequestBody -> Encoding

toJSONList :: [PostRecipientsRequestBody] -> Value

toEncodingList :: [PostRecipientsRequestBody] -> Encoding

FromJSON PostRecipientsRequestBody

Defined in StripeAPI.Operations.PostRecipients

Methods

parseJSON :: Value -> Parser PostRecipientsRequestBody

parseJSONList :: Value -> Parser [PostRecipientsRequestBody]

data PostRecipientsRequestBodyMetadata'

Defines the data type for the schema postRecipientsRequestBodyMetadata'

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

PostRecipientsRequestBodyMetadata'

Instances

Eq PostRecipientsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostRecipients

Methods

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

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

Show PostRecipientsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostRecipients

Methods

showsPrec :: Int -> PostRecipientsRequestBodyMetadata' -> ShowS

show :: PostRecipientsRequestBodyMetadata' -> String

showList :: [PostRecipientsRequestBodyMetadata'] -> ShowS

ToJSON PostRecipientsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostRecipients

Methods

toJSON :: PostRecipientsRequestBodyMetadata' -> Value

toEncoding :: PostRecipientsRequestBodyMetadata' -> Encoding

toJSONList :: [PostRecipientsRequestBodyMetadata'] -> Value

toEncodingList :: [PostRecipientsRequestBodyMetadata'] -> Encoding

FromJSON PostRecipientsRequestBodyMetadata'

Defined in StripeAPI.Operations.PostRecipients

Methods

parseJSON :: Value -> Parser PostRecipientsRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostRecipientsRequestBodyMetadata']

data PostRecipientsResponse

Represents a response of the operation postRecipients.

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

Constructors

PostRecipientsResponseError String

Means either no matching case available or a parse error

PostRecipientsResponse200 Recipient

Successful response.

PostRecipientsResponseDefault Error

Error response.

Instances

Eq PostRecipientsResponse

Defined in StripeAPI.Operations.PostRecipients

Methods

(==) :: PostRecipientsResponse -> PostRecipientsResponse -> Bool

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

Show PostRecipientsResponse

Defined in StripeAPI.Operations.PostRecipients

Methods

showsPrec :: Int -> PostRecipientsResponse -> ShowS

show :: PostRecipientsResponse -> String

showList :: [PostRecipientsResponse] -> ShowS