ChargeRequest
June 26, 2019 ยท View on GitHub
squareconnect.models.charge_request
Description
Defines the parameters that can be included in the body of a request to the Charge endpoint.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See Idempotency for more information. | |
| amount_money | Money | The amount of money to charge. Note that you specify the amount in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See Working with monetary amounts for details. The value of `currency` must match the currency associated with the business that is charging the card. | |
| card_nonce | str | A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the same application that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional] |
| customer_card_id | str | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you must also provide a value for `customer_id`. | [optional] |
| delay_capture | bool | If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the CaptureTransaction endpoint) or a Void (with the VoidTransaction endpoint). Default value: `false` | [optional] |
| reference_id | str | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] |
| note | str | An optional note to associate with the transaction. This value cannot exceed 60 characters. | [optional] |
| customer_id | str | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional] |
| billing_address | Address | The buyer's billing address. | [optional] |
| shipping_address | Address | The buyer's shipping address, if available. | [optional] |
| buyer_email_address | str | The buyer's email address, if available. | [optional] |
| order_id | str | The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must exactly match the value of the order's `total_money` field. | [optional] |
| additional_recipients | list[AdditionalRecipient] | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox. | [optional] |
| verification_token | str | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. | [optional] |