Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 3.36 KB

ChargeRequest.md

File metadata and controls

21 lines (16 loc) · 3.36 KB

Square.Connect.Model.ChargeRequest

Properties

Name Type Description Notes
IdempotencyKey string 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 keys for more information.
AmountMoney 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.
CardNonce string 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]
CustomerCardId string 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]
DelayCapture 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]
ReferenceId string 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 string An optional note to associate with the transaction. This value cannot exceed 60 characters. [optional]
CustomerId string 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]
BillingAddress Address The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. [optional]
ShippingAddress Address The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. [optional]
BuyerEmailAddress string The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. [optional]

[Back to Model list] [Back to API list] [Back to README]