QuickBooks Online Payments API overview

Need to accept payments? Process credit card payments on your eCommerce website or set up online processing for your customer's site. In the same app, easily record transactions in QuickBooks Online.

The QuickBooks Online Payments API is a RESTful API that is used to access QuickBooks companies.

Common use cases

The QuickBooks Online Payments API can be used to perform a variety of tasks associated with accounting, supporting both US and selected global locales.

  • Process payment transactions and record them in QuickBooks Online
  • Store bank accounts and credit card details for repeated use
  • Retrieve QuickBooks Online reports
  • Process or refund charges


Included in each resource page is pertinent information for using that resource along with sample request and response payloads for each operation. The samples are constructed such that they can be used directly in operations sent to a sandbox account (US only) without modification.

Types of operations

  • Single requests—Send a single request and process its response individually.
  • Query requests—Send a query via the Intuit Developer SQL-like query language. Results are returned in one response, or paged as needed.
  • Batch operations—Batch multiple operations into a single request. For example, in a single batch request an application can create a customer, update an invoice, and read an account. Compared to multiple, single requests, a single batch request can improve an application's performance by decreasing network roundtrips and increasing throughput.

How do I find out more?

  • Our SDKs do the heavy lifting for you.
  • Developer guide topics help you better understand implementing various use cases.
  • The API Reference pages below give you details on every resource and method.
  • Reach out to other developers on our live community.

All complex types are listed below.

address

streetAddress:
optional
string, maximum 30 characters
Full street adddress, which may include house number and street name (CR acceptable).
city:
optional
string, maximum 30 characters
City.
region:
required if no postalCode is provided
string, maximum 30 characters
Region within a country. State, province, prefecture or region component.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
postalCode:
required if no region is provided
string, maximum 10 characters
Postal code.

bankaccount

created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
updated:
system generated
string
Time the object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
id:
system generated
string
The unique bank account identifier.
name:
required
string, maximum 64 characters
The name of the bank account holder.
routingNumber:
required
string, exactly 9 characters
The bank routing number. For security purposes, only the last four digits are displayed.
accountNumber:
required
string, minimum 4 characters, maximum 17 characters
The bank account number to be used. For security purposes, only the last four digits are displayed.
accountType:
required
BankAccountTypeEnum
The type of account to be used. Valid values include:
  • PERSONAL_CHECKING—the account is a checking account.
  • PERSONAL_SAVINGS—the account is a savings account.
phone:
required
string, exactly 10 characters
A phone number to be associated with the account.
default:
optional
boolean
A flag to indicate whether the account is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one account is flagged as true, all other stored accounts in the collection will automatically be set to false.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
inputType:
optional
BankAccountInputTypeEnum
Specifies the input type. Valid values include:
  • KEYED—A manually-entered account key.

capturerequest

amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00 through 99999.99.
context:
optional
PaymentContext, default is null
Additional data you wish to store with this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
description:
optional
string, default is null
Text you would like to store with the transaction.

card

created:
system generated
string
The date on which the Card object was created, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
updated:
system generated
string
The date on which the Card object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
id:
system generated
string
System generated id for this record.
number:
required
string
Credit/debit card number.
expMonth:
required
string
Two digits indicating the card's expiration month.
expYear:
required
string
Four digits indicating the card's expiration year.
cvc:
required
string
Up to four digits for the Card Verification Code on the back of the card. The number of digits will vary depending on the card provider. Note that for security purposes, this value cannot be stored; it must be supplied in a transaction request and then destroyed.
name:
optional
string, maximum 30 characters
Cardholder's name as it appears on the card.
address:
optional
address
Address.
streetAddress:
optional
string, maximum 30 characters
Full street adddress, which may include house number and street name (CR acceptable).
city:
optional
string, maximum 30 characters
City.
region:
required if no postalCode is provided
string, maximum 30 characters
Region within a country. State, province, prefecture or region component.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
postalCode:
required if no region is provided
string, maximum 10 characters
Postal code.
default:
optional
boolean
A flag to indicate whether the card is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one card is flagged as true, all other stored cards in the collection will automatically be set to false.
commercialCardCode:
optional
string, maximum 25 characters
Specific code that is applicable when the card used is a commercial card (corporate cards). This can be used to track a particular purchase order or authorization code for commercial purchases.
cvcVerification:
system generated
string
Date of the CVC verification (output only).
isBusiness:
optional
boolean
Set to True if the card is a business card.
cardType:
system generated
enum
The type of card in use. Valid types are:
  • VISA
  • MC
  • AMEX
  • DISC
  • DINERS
  • JCB

cardpresent

track1:
optional
string, between 25 and 78 chars
track2:
optional
string, between 23 and 39 chars
ksn:
optional
string, between 12 and 20 chars
pinBlock:
optional
string, exactly 16 chars

chargerequest

amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00through 99999.99.
currency:
required
string
The valid value currently supported is USD.
token:
required
string
Preferred to specifying card or cardOnFile in order to ensure PCI compliance.
Opaque representation of the credit card associated with this charge, as returned by the token endpoint. Applications that access cardholder information using the Payments API are required to follow the payment application data security standard (PA DSS) established by the payment card industry, which specifies how cardholder data must be protected. As such, the token resource provides a programatic way to comply with this standard without having to hold sensitive card information on your own servers.
cardOnFile:
required if neither token nor card are specified
cardOnFile
The id for a card that has been previously stored on file.
card:
required if neither token nor cardOnFile are specified
card
Token is preferred in order to avoid PCI compliance requirements.
Explicit credit card details associated with this charge.
created:
system generated
string
The date on which the Card object was created, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
updated:
system generated
string
The date on which the Card object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
id:
system generated
string
System generated id for this record.
number:
required
string
Credit/debit card number.
expMonth:
required
string
Two digits indicating the card's expiration month.
expYear:
required
string
Four digits indicating the card's expiration year.
cvc:
required
string
Up to four digits for the Card Verification Code on the back of the card. The number of digits will vary depending on the card provider. Note that for security purposes, this value cannot be stored; it must be supplied in a transaction request and then destroyed.
name:
optional
string, maximum 30 characters
Cardholder's name as it appears on the card.
address:
optional
address
Address.
streetAddress:
optional
string, maximum 30 characters
Full street adddress, which may include house number and street name (CR acceptable).
city:
optional
string, maximum 30 characters
City.
region:
required if no postalCode is provided
string, maximum 30 characters
Region within a country. State, province, prefecture or region component.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
postalCode:
required if no region is provided
string, maximum 10 characters
Postal code.
default:
optional
boolean
A flag to indicate whether the card is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one card is flagged as true, all other stored cards in the collection will automatically be set to false.
commercialCardCode:
optional
string, maximum 25 characters
Specific code that is applicable when the card used is a commercial card (corporate cards). This can be used to track a particular purchase order or authorization code for commercial purchases.
cvcVerification:
system generated
string
Date of the CVC verification (output only).
isBusiness:
optional
boolean
Set to True if the card is a business card.
cardType:
system generated
enum
The type of card in use. Valid types are:
  • VISA
  • MC
  • AMEX
  • DISC
  • DINERS
  • JCB
context:
optional
PaymentContext
Additional data you wish to store for this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
capture:
optional
boolean, default is true
Capture flag.
  • true—The charge has been captured.
  • false—The charge is uncaptured and pending authorization.
description:
optional
string, maximum 4000 chars
Description.

charge

id:
system generated
string, system generated
System generated alpha-numeric id.
created:
system generated
string, system generated
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
status:
system generated
ChargeStatusEnum, system generated
Status of the transaction. Valid status types include:
  • AUTHORIZED—First half of the two-step authorize/capture payment flow. The customer's card issuing bank has authorized the cardholder's ability to pay, ensuring that the credit card account is in good standing with sufficient funds to complete the purchase.
  • DECLINED— The card authorization is declined, is rejected by PTS, or returned by the process.
  • CAPTURED—Second half of the two step authorize/capture payment flow.
  • CANCELLED—The transaction is cancelled.
  • SETTLED—The transaction has been funded to the merchant's bank account.
  • REFUNDED—The funds have been transferred back to the card holder.
amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00through 99999.99.
currency:
required
string
The valid value currently supported is USD.
token:
required if card is not specified
string
Opaque representation of the credit card associated with this charge, as returned by the token endpoint.
card:
required if token not specified
card
Explicit credit card details associated with this charge.
created:
system generated
string
The date on which the Card object was created, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
updated:
system generated
string
The date on which the Card object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
id:
system generated
string
System generated id for this record.
number:
required
string
Credit/debit card number.
expMonth:
required
string
Two digits indicating the card's expiration month.
expYear:
required
string
Four digits indicating the card's expiration year.
cvc:
required
string
Up to four digits for the Card Verification Code on the back of the card. The number of digits will vary depending on the card provider. Note that for security purposes, this value cannot be stored; it must be supplied in a transaction request and then destroyed.
name:
optional
string, maximum 30 characters
Cardholder's name as it appears on the card.
address:
optional
address
Address.
streetAddress:
optional
string, maximum 30 characters
Full street adddress, which may include house number and street name (CR acceptable).
city:
optional
string, maximum 30 characters
City.
region:
required if no postalCode is provided
string, maximum 30 characters
Region within a country. State, province, prefecture or region component.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
postalCode:
required if no region is provided
string, maximum 10 characters
Postal code.
default:
optional
boolean
A flag to indicate whether the card is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one card is flagged as true, all other stored cards in the collection will automatically be set to false.
commercialCardCode:
optional
string, maximum 25 characters
Specific code that is applicable when the card used is a commercial card (corporate cards). This can be used to track a particular purchase order or authorization code for commercial purchases.
cvcVerification:
system generated
string
Date of the CVC verification (output only).
isBusiness:
optional
boolean
Set to True if the card is a business card.
cardType:
system generated
enum
The type of card in use. Valid types are:
  • VISA
  • MC
  • AMEX
  • DISC
  • DINERS
  • JCB
context:
optional
PaymentContext
Additional data you wish to store for this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
capture:
optional
boolean, default is true
Capture flag.
  • true—The charge has been captured.
  • false—The charge is uncaptured and pending authorization.
authCode:
system generated
string
Authorization code. Available for uncaptured charges, only.
captureDetail:
system generated
capture
Charge capture detail. Available for charges previously authorized.
created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00 through 99999.99.
context:
optional
PaymentContext, default is null
Additional data you wish to store with this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
description:
optional
string, default is null
Text you would like to store with the transaction.
refundDetail:
optional
array[refund]
Details for one or more refunds against this charge.
id:
system generated
string
System generated alpha-numeric id.
created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
status:
system generated
RefundStatusEnum
Status of the transaction. Valid status types include:
  • ISSUED—First half of the two-step refund transaction process. The refund is issued but not final until settled.
  • DECLINED—The refund request is denied.
  • SETTLED—The refund transaction has been funded to the credit card holder.
amount:
optional
number
Amount. If no number is specified, the full amount will be used.
context:
optional
PaymentContext
Additional data you wish to store for this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
description:
optional
string
Description.
description:
optional
string, maximum 4000 chars
Description.

checkcontext

deviceInfo:
optional
DeviceInfo
Information about the device used.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.

deviceinfo

id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.

echeck

created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
Ïid:
system generated
string
The unique check id.
authCode:
system generated
string
The authorization code for the echeck.
status:
system generated
ECheckStatus
The current status of the check. Valid status types include:
  • PENDING—The check is currently being processed.
  • SUCCEEDED— The check has been funded and the transaction was successful.
  • DECLINED—The check was rejected.
  • VOIDED—The check was voided.
  • REFUNDED—The check has been refunded.
amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.01through 99999.99.
bankAccount:
required if neither token nor bankAccountOnFile are specified
BankAccount
Explicit bank account details associated with this transaction.
token:
required if neither bankAccount nor bankAccountOnFile are specified
string
An opaque representation of the bank account associated with the debit, as returned by the token endpoint.
bankAccountOnFile:
required if neither bankAccount nor token are specified
string
The bank account details that have been previous stored on file.
context:
optional
CheckContext
Additional data that may be stored with the transaction.
paymentMode:
required
PaymentModeType
The payment mode. This is also known as the SEC Code. Valid codes include:
  • WEB—Internet-initiated entry mode, used for internet transactions.
description:
optional
string, maximum 4000 chars, optional
Descriptive text to be stored with the transaction.
checkNumber:
optional
string
The number for the echeck, if desired.

echeckrefundrequest

amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00through 99999.99.
context:
optional
PaymentContext, optional
Additional data you wish to store for this transaction.
deviceInfo:
optional
DeviceInfo
Information about the device used.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
description:
optional
string, maximum 4000 characters, optional
Description to be stored with the transaction.

echeckrefund

created:
system generated
string
Object creation time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
id:
system generated
string
System generated alpha-numeric id.
status:
system generated
ECheckRefundStatus
Current status of the refund transaction. Valid status types include:
  • PENDING—the refund is currently being processed.
  • SUCCEEDED—the refund has been successfully funded.
  • DECLINED—the refund was rejected.
type:
system generated
ECheckRefundType
Indicates the type of refund being processed. Valid types include:
  • VOID—the refund has been requested for a voided transaction.
  • REFUND—the refund has been requested for a refunded transaction.
amount:
required
number
Amount of the transaction. Valid values for amount are in the range 0.00through 99999.99.
context:
optional
CheckContext
Additional data that may be stored with the transaction.
description:
optional
string, maximum 4000 characters
Descriptive text to be stored with the transaction.

errors

error:
string
Error code.
type:
string
Error type.
message:
string
Reason for the error.
detail:
string
Additional detail of the error.
moreInfo:
string
More info.
infoLink:
string
Link to more information.

errortype

errors:
system generated
array[Error]
List of errors returned by the operation.
error:
string
Error code.
type:
string
Error type.
message:
string
Reason for the error.
detail:
string
Additional detail of the error.
moreInfo:
string
More info.
infoLink:
string
Link to more information.

paymentcontext

tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.

refundrequest

amount:
required
number
Amount.
context:
optional
PaymentContext
Additional data you wish to store for this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
description:
optional
string
Description.

refund

id:
system generated
string
System generated alpha-numeric id.
created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
status:
system generated
RefundStatusEnum
Status of the transaction. Valid status types include:
  • ISSUED—First half of the two-step refund transaction process. The refund is issued but not final until settled.
  • DECLINED—The refund request is denied.
  • SETTLED—The refund transaction has been funded to the credit card holder.
amount:
optional
number
Amount. If no number is specified, the full amount will be used.
context:
optional
PaymentContext
Additional data you wish to store for this transaction.
tax:
optional
number
Sales Tax-required for commercial card processing
deviceInfo:
optional
DeviceInfo
For swiped transactions, information about the swiper.
id:
system generated
string
Device id.
type:
optional
string, maximum 200 characters
The type of device in use.
longitude:
optional
string, maximum 20 characters
Device's longitude.
latitude:
optional
string, maximum 20 characters
Device's latitude.
encrypted:
optional
boolean, optional
Device's encryption status.
phoneNumber:
optional
string, maximum 20 characters
Device's phone number, if available.
macAddress:
optional
string, maximum 50 characters
Device's mac address.
ipAddress:
optional
string, maximum 40 characters
Device's IP address.
recurring:
optional
boolean, default is false
This boolean value is set to true if the charge is recurring. This value ignored for capture and refund requests.
description:
optional
string
Description.

token

value:
required
string

System generated token value.

tokenrequest

card:
required if bankaccount is not specified
Card
Explicit credit card details associated with this charge.
created:
system generated
string
The date on which the Card object was created, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
updated:
system generated
string
The date on which the Card object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ.
id:
system generated
string
System generated id for this record.
number:
required
string
Credit/debit card number.
expMonth:
required
string
Two digits indicating the card's expiration month.
expYear:
required
string
Four digits indicating the card's expiration year.
cvc:
required
string
Up to four digits for the Card Verification Code on the back of the card. The number of digits will vary depending on the card provider. Note that for security purposes, this value cannot be stored; it must be supplied in a transaction request and then destroyed.
name:
optional
string, maximum 30 characters
Cardholder's name as it appears on the card.
address:
optional
address
Address.
streetAddress:
optional
string, maximum 30 characters
Full street adddress, which may include house number and street name (CR acceptable).
city:
optional
string, maximum 30 characters
City.
region:
required if no postalCode is provided
string, maximum 30 characters
Region within a country. State, province, prefecture or region component.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
postalCode:
required if no region is provided
string, maximum 10 characters
Postal code.
default:
optional
boolean
A flag to indicate whether the card is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one card is flagged as true, all other stored cards in the collection will automatically be set to false.
commercialCardCode:
optional
string, maximum 25 characters
Specific code that is applicable when the card used is a commercial card (corporate cards). This can be used to track a particular purchase order or authorization code for commercial purchases.
cvcVerification:
system generated
string
Date of the CVC verification (output only).
isBusiness:
optional
boolean
Set to True if the card is a business card.
cardType:
system generated
enum
The type of card in use. Valid types are:
  • VISA
  • MC
  • AMEX
  • DISC
  • DINERS
  • JCB
bankAccount:
required if card is not specified
bankAccount
Explicit bank account details associated with this charge.
created:
system generated
string
Object create time, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
updated:
system generated
string
Time the object was last updated, in ISO 8601 date-time format, such as YYYY-MM-DDTHH:MM:SSZ
id:
system generated
string
The unique bank account identifier.
name:
required
string, maximum 64 characters
The name of the bank account holder.
routingNumber:
required
string, exactly 9 characters
The bank routing number. For security purposes, only the last four digits are displayed.
accountNumber:
required
string, minimum 4 characters, maximum 17 characters
The bank account number to be used. For security purposes, only the last four digits are displayed.
accountType:
required
BankAccountTypeEnum
The type of account to be used. Valid values include:
  • PERSONAL_CHECKING—the account is a checking account.
  • PERSONAL_SAVINGS—the account is a savings account.
phone:
required
string, exactly 10 characters
A phone number to be associated with the account.
default:
optional
boolean
A flag to indicate whether the account is the default, which will be used when one is not explicitly specified. The flag defaults to false; when one account is flagged as true, all other stored accounts in the collection will automatically be set to false.
country:
optional
string, maximum 2 characters
ISO-standard country code. Refer to Country Code List for a list of codes.
inputType:
optional
BankAccountInputTypeEnum
Specifies the input type. Valid values include:
  • KEYED—A manually-entered account key.