StripeAPI.Operations.PostRecipients

Contains the different functions to run the operation postRecipients

Documentation

postRecipients

Arguments

:: forall m. MonadHTTP m

=> PostRecipientsRequestBody

The request body to send

-> ClientT m (Response PostRecipientsResponse)

Monadic computation which returns 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>

data PostRecipientsRequestBody

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

Constructors

PostRecipientsRequestBody

Fields

• postRecipientsRequestBodyBankAccount :: Maybe Text

  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 Text

  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 Text

  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 Text

  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 [Text]

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

• postRecipientsRequestBodyMetadata :: Maybe PostRecipientsRequestBodyMetadata'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`.

• postRecipientsRequestBodyName :: Text

  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 Text

  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 :: Text

  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]

mkPostRecipientsRequestBody

Arguments

:: Text

postRecipientsRequestBodyName

-> Text

postRecipientsRequestBodyType

-> PostRecipientsRequestBody

Create a new PostRecipientsRequestBody with all required fields.

data PostRecipientsRequestBodyMetadata'Variants

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

PostRecipientsRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostRecipientsRequestBodyMetadata'Object Object

Instances

Eq PostRecipientsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipients

Methods

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

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

Show PostRecipientsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipients

Methods

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

show :: PostRecipientsRequestBodyMetadata'Variants -> String

showList :: [PostRecipientsRequestBodyMetadata'Variants] -> ShowS

ToJSON PostRecipientsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipients

Methods

toJSON :: PostRecipientsRequestBodyMetadata'Variants -> Value

toEncoding :: PostRecipientsRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostRecipientsRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostRecipientsRequestBodyMetadata'Variants] -> Encoding

FromJSON PostRecipientsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipients

Methods

parseJSON :: Value -> Parser PostRecipientsRequestBodyMetadata'Variants

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

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