Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 3.81 KB

ChargeRequest.md

File metadata and controls

22 lines (19 loc) · 3.81 KB
Raw

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. [default to null]
AmountMoney *Money [default to null]
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] [default to null]
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] [default to null]
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` or a Void (with the `VoidTransaction`. Default value: `false` [optional] [default to null]
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] [default to null]
Note string An optional note to associate with the transaction. This value cannot exceed 60 characters. [optional] [default to null]
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] [default to null]
BillingAddress *Address [optional] [default to null]
ShippingAddress *Address [optional] [default to null]
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] [default to null]
OrderId string 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] [default to null]
AdditionalRecipients []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] [default to null]
VerificationToken string A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. [optional] [default to null]

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