StripeAPI.Operations.PostRecipientsId

Contains the different functions to run the operation postRecipientsId

Documentation

postRecipientsId

Arguments

:: forall m. MonadHTTP m

=> Text

id | Constraints: Maximum length of 5000

-> Maybe PostRecipientsIdRequestBody

The request body to send

-> ClientT m (Response PostRecipientsIdResponse)

Monadic computation which returns the result of the operation

POST /v1/recipients/{id}

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

<p>If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.</p>

data PostRecipientsIdRequestBody

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

Constructors

PostRecipientsIdRequestBody

Fields

• postRecipientsIdRequestBodyBankAccount :: 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
• postRecipientsIdRequestBodyCard :: Maybe Text

  card: A U.S. Visa or MasterCard debit card (not prepaid) 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 debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the card creation API. Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.

  Constraints:

  • Maximum length of 5000
• postRecipientsIdRequestBodyDefaultCard :: Maybe Text

  default_card: ID of the card to set as the recipient's new default for payouts.

  Constraints:

  • Maximum length of 5000
• postRecipientsIdRequestBodyDescription :: 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
• postRecipientsIdRequestBodyEmail :: 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
• postRecipientsIdRequestBodyExpand :: Maybe [Text]

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

• postRecipientsIdRequestBodyMetadata :: Maybe PostRecipientsIdRequestBodyMetadata'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`.

• postRecipientsIdRequestBodyName :: Maybe 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
• postRecipientsIdRequestBodyTaxId :: 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

Instances

Eq PostRecipientsIdRequestBody

Defined in StripeAPI.Operations.PostRecipientsId

Methods

(==) :: PostRecipientsIdRequestBody -> PostRecipientsIdRequestBody -> Bool

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

Show PostRecipientsIdRequestBody

Defined in StripeAPI.Operations.PostRecipientsId

Methods

showsPrec :: Int -> PostRecipientsIdRequestBody -> ShowS

show :: PostRecipientsIdRequestBody -> String

showList :: [PostRecipientsIdRequestBody] -> ShowS

ToJSON PostRecipientsIdRequestBody

Defined in StripeAPI.Operations.PostRecipientsId

Methods

toJSON :: PostRecipientsIdRequestBody -> Value

toEncoding :: PostRecipientsIdRequestBody -> Encoding

toJSONList :: [PostRecipientsIdRequestBody] -> Value

toEncodingList :: [PostRecipientsIdRequestBody] -> Encoding

FromJSON PostRecipientsIdRequestBody

Defined in StripeAPI.Operations.PostRecipientsId

Methods

parseJSON :: Value -> Parser PostRecipientsIdRequestBody

parseJSONList :: Value -> Parser [PostRecipientsIdRequestBody]

mkPostRecipientsIdRequestBody :: PostRecipientsIdRequestBody

Create a new PostRecipientsIdRequestBody with all required fields.

data PostRecipientsIdRequestBodyMetadata'Variants

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

PostRecipientsIdRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostRecipientsIdRequestBodyMetadata'Object Object

Instances

Eq PostRecipientsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipientsId

Methods

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

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

Show PostRecipientsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipientsId

Methods

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

show :: PostRecipientsIdRequestBodyMetadata'Variants -> String

showList :: [PostRecipientsIdRequestBodyMetadata'Variants] -> ShowS

ToJSON PostRecipientsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipientsId

Methods

toJSON :: PostRecipientsIdRequestBodyMetadata'Variants -> Value

toEncoding :: PostRecipientsIdRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostRecipientsIdRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostRecipientsIdRequestBodyMetadata'Variants] -> Encoding

FromJSON PostRecipientsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostRecipientsId

Methods

parseJSON :: Value -> Parser PostRecipientsIdRequestBodyMetadata'Variants

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

data PostRecipientsIdResponse

Represents a response of the operation postRecipientsId.

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

Constructors

PostRecipientsIdResponseError String

Means either no matching case available or a parse error

PostRecipientsIdResponse200 Recipient

Successful response.

PostRecipientsIdResponseDefault Error

Error response.

Instances

Eq PostRecipientsIdResponse

Defined in StripeAPI.Operations.PostRecipientsId

Methods

(==) :: PostRecipientsIdResponse -> PostRecipientsIdResponse -> Bool

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

Show PostRecipientsIdResponse

Defined in StripeAPI.Operations.PostRecipientsId

Methods

showsPrec :: Int -> PostRecipientsIdResponse -> ShowS

show :: PostRecipientsIdResponse -> String

showList :: [PostRecipientsIdResponse] -> ShowS