create-payment-request.md

Create Payment Request

Describes a request to create a payment using CreatePayment.

Structure

Create Payment Request

Fields

Name	Type	Tags	Description
source_id	string	Required	The ID for the source of funds for this payment. This can be a payment token (card nonce) generated by the Square payment form or a card on file made with the Customers API. If recording a payment that the seller received outside of Square, specify either "CASH" or "EXTERNAL". For more information, see Take Payments. Constraints: Minimum Length: 1
idempotency_key	string	Required	A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters Note: The number of allowed characters might be less than the stated maximum, if multi-byte characters are used. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 45
amount_money	Money	Required	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
tip_money	Money	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
app_fee_money	Money	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
delay_duration	string	Optional	The duration of time after the payment's creation when Square automatically cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the delay_duration time period. This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value of 1 minute. Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (autocomplete=false). Default: - Card-present payments: "PT36H" (36 hours) from the creation time. - Card-not-present payments: "P7D" (7 days) from the creation time.
autocomplete	bool	Optional	If set to true, this payment will be completed when possible. If set to false, this payment is held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see Delayed capture. Default: true
order_id	string	Optional	Associates a previously created order with this payment.
customer_id	string	Optional	The Customer ID of the customer associated with the payment. This is required if the source_id refers to a card on file created using the Customers API.
location_id	string	Optional	The location ID to associate with the payment. If not specified, the default location is used.
reference_id	string	Optional	A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system (for example, you might specify an order ID that is generated by a third-party shopping cart). Limit 40 characters. Constraints: Maximum Length: 40
verification_token	string	Optional	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. For more information, see SCA Overview.
accept_partial_authorization	bool	Optional	If set to true and charging a Square Gift Card, a payment might be returned with amount_money equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment. This field cannot be true when autocomplete = true. For more information, see Partial amount with Square Gift Cards. Default: false
buyer_email_address	string	Optional	The buyer's email address. Constraints: Maximum Length: 255
billing_address	Address	Optional	Represents a physical address.
shipping_address	Address	Optional	Represents a physical address.
note	string	Optional	An optional note to be entered by the developer when creating a payment. Limit 500 characters. Constraints: Maximum Length: 500
statement_description_identifier	string	Optional	Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Note that the statement_description_identifier might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the seller taking the payment. Constraints: Maximum Length: 20
cash_details	Cash Payment Details	Optional	Stores details about a cash payment. Contains only non-confidential information. For more information, see Take Cash Payments.
external_details	External Payment Details	Optional	Stores details about an external payment. Contains only non-confidential information. For more information, see Take External Payments.

Example (as JSON)

{
  "amount_money": {
    "amount": 200,
    "currency": "USD"
  },
  "app_fee_money": {
    "amount": 10,
    "currency": "USD"
  },
  "autocomplete": true,
  "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
  "idempotency_key": "4935a656-a929-4792-b97c-8848be85c27c",
  "location_id": "XK3DBG77NJBFX",
  "note": "Brief description",
  "reference_id": "123456",
  "source_id": "ccof:uIbfJXhXETSP197M3GB"
}