HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostRecipients

Contains the different functions to run the operation postRecipients

  • 3 types
  • 2 values
datadata PostRecipientsRequestBody
#

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

Constructors

  • PostRecipientsRequestBody
    • 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

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances2Eq, Show