QuickBooks: Create a charge — response body

API reference · Contract 2026-10-20

SDK schema: Create a charge — response body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
amount	JSON	Optional	The transaction amount. Valid values: Any value between 0.01 and 99999.99 . Decimal string
amount (anyOf 1)	JSON	Alternative
amount (anyOf 1) (anyOf 1)	number	Alternative
amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)	string	Alternative
authCode	string	Optional	The authorization code for the charge. Note : This is only available for uncaptured charges.
avsStreet	string	Optional	The address verification service (AVS). This service verifies the street address submitted by the customer for their credit or debit card. AVS compares the ZIP code submitted at the time of the transaction with what’s on file at the cardholder’s bank. AVS is supported by most US banks and some international banks. Valid responses: Pass Fail NotAvailable
avsZip	string	Optional	The address verification service (AVS). This service verifies the ZIP code submitted by the customer for their credit or debit card. AVS compares the ZIP code submitted at the time of the transaction with what’s on file at the cardholder’s bank. AVS is supported by most US banks and some international banks. Valid responses: Pass Fail NotAvailable
capture	JSON	Optional	A flag that indicates if the charge was captured. Valid values: True : The charge was captured False : The charge wasn’t captured. It’s pending authorization. Defaults to true .
capture (anyOf 1)	boolean	Alternative
capture (anyOf 2)	string	Alternative	Known values: true, false
captureDetail	Model	Optional	Expand Create a charge — response body — capture Detail Details about the captured charge. Available for previously authorized charges. Read only: true
card	Model	Optional	Expand Create a card — response body The credit or debit card used for the charge. Required if token isn’t specified. Conditionally required
cardSecurityCodeMatch	string	Optional	The 3 or 4 digit card security code number that appears on credit and debit cards. This number is not part of the main credit card number. This field indicates if the security code submitted at the time of the transaction matches what’s on file at the cardholder’s bank. Valid responses: Pass Fail NotAvailable
context	Model	Optional	Expand Create a charge — response body — context Additional info that will be stored with the transaction.
created	string	Optional	The time the object was originally created. In ISO 8601 date-time format. It appears as YYYY-MM-DDTHH:MM:SSZ . Read only: true
currency	string	Optional	The 3-letter ISO 4217 compliant currency code, which defines the currency for the charge.
description	string	Optional	Free form text description. Additional details associated with the charge.
id	string	Optional	The unique identifier for the charge. This is a system-generated alpha-numeric ID. Conditionally required
refundDetail	array	Optional
refundDetail[]	Model	Each item	Expand Create a charge — response body — refund Detail item Details for one or more refunds applied to this charge.
status	string	Optional	The status of the charge. Charge athorization and capture are a two part process. Learn more about charge states for the QuickBookls Payments API. Valid values: AUTHORIZED : The card’s issuing bank has authorized the cardholder’s ability to pay. This ensures the credit or debit card account is in good standing with sufficient funds. DECLINED : The card authorization was declined, rejected by the payment transaction service (PTS), or returned by the payment processor. CAPTURED : The payment is in the second part of the two-step authorization and capture process. CANCELLED : The transaction was cancelled. SETTLED : The payment was successfully funded. The money moved to the seller’s (i.e. merchant’s) bank account. At this point, the charge is complete. REFUNDED : The money successfully transferred back to the buyer (i.e. card holder). Read only: true
token	string	Optional	The opaque container for the credit or debit card account associated with the transaction. Required if the card isn’t specified. Tokens are preferred to directly specifying a card or cardOnFile to comply with PCI standards. Learn more about creating tokens.

Referenced models: Create a charge — response body — capture Detail, Create a card — response body, Create a charge — response body — context, Create a charge — response body — refund Detail item