CardTransactionRequest
Possible values: [CHECKING, SAVINGS]
Optional ACH entry description; at most 10 alphanumeric characters or spaces.
Possible values: <= 10 characters
Possible values: [CCD, PPD, TEL, WEB]
EPX ACH first name. Required for non-CCD SEC codes.
ACH sale only. Transaction invoice number. 1-25 printable ASCII characters.
Possible values: <= 25 characters
EPX ACH last name. Required for non-CCD SEC codes.
EPX ACH receiver name. Required for CCD SEC code.
ACH ABA routing number. Required with achAccountType and must contain exactly 9 digits.
Possible values: <= 9 characters
additionalTaxDetails object[]
Standalone tax details for a card-not-present sale whose tax is not represented by itemized lines. Availability depends on the selected payment route; if the selected route does not support these details, the sale is rejected before payment submission. Each detail's taxAmount is in minor currency units, and amounts must sum to the top-level taxAmount. taxRate is a percentage from 0 to 100 with at most two decimals (for example, 6.25 means 6.25%). Do not combine with lineItems or level3.
Possible values: >= 0
Possible values: [TAXABLE, NON_TAXABLE]
Possible values: [SALES_TAX, VAT, GST]
Transaction amount in minor currency units, tip included.
Possible values: >= 0 and <= 99999999
billing objectnullable
cardData objectnullable
Possible values: [MANUAL, SWIPE, FALLBACK_SWIPE, EMV, CONTACTLESS, TOKEN, INTERNET, PHONE, MAIL]
Three-letter ISO 4217 currency code; omit to use the merchant's default currency. The current ACH contract is USD-only for adapters that advertise achSale.
Optional customer identifier associated with the payment.
Possible values: [RE, EC, RS, DM, HC, LD]
level2 objectnullable
Possible values: [LEVEL2, LEVEL3]
Possible values: >= 0
level3 objectnullable
additionalTaxDetails object[]
Possible values: >= 0
Possible values: [TAXABLE, NON_TAXABLE]
Possible values: [SALES_TAX, VAT, GST]
Possible values: [LEVEL2, LEVEL3]
Possible values: >= 0
Possible values: >= 0
Possible values: >= 0
lineItems object[]required
Possible values: >= 1
Possible values: non-empty
Possible values: >= 0
Possible values: [AMOUNT, PERCENTAGE]
Possible values: >= 0
Possible values: non-empty
Possible values: >= 1
Possible values: >= 0
Possible values: >= 0
Possible values: >= 0
lineItems object[]nullable
Possible values: <= 64 characters
Possible values: <= 255 characters
Possible values: >= 0
Possible values: <= 64 characters
Possible values: <= 64 characters
Possible values: >= 1
Possible values: >= 0
Possible values: >= 0
Possible values: >= 0
Possible values: <= 16 characters
Location identifier selected by the authorized caller.
metadata object
Optional string metadata attached to the transaction.
Optional string metadata attached to the transaction.
Possible values: >= 1 and <= 99999999
Required for virtual-terminal routes: immutable server quote bound to this payment identity.
Possible values: <= 64 characters
Possible values: [CARD_PRESENT, CARD_NOT_PRESENT, ACH]
Possible values: [RECURRING, SUBSCRIPTION, STANDING_ORDER, INSTALLMENT, UNSCHEDULED]
Optional tip in minor currency units, ALREADY INCLUDED in amount and never added to it. Omit or send 0 for no tip; must not exceed amount.
Possible values: >= 0 and <= 99999999
{
"acceptorCustomerServicePhoneNumber": "string",
"acceptorPhoneNumber": "string",
"acceptorStreetAddress": "string",
"acceptorURLAddress": "string",
"achAccountType": "CHECKING",
"achDescription": "string",
"achEntryCode": "CCD",
"achFirstName": "string",
"achInvoiceNumber": "string",
"achLastName": "string",
"achReceiverName": "string",
"achRoutingNumber": "string",
"additionalTaxDetails": [
{
"taxAmount": 0,
"taxCategory": "TAXABLE",
"taxRate": "string",
"taxType": "SALES_TAX"
}
],
"amount": 0,
"approvalCode": "string",
"authTimestamp": "string",
"authorizationIndicator": "string",
"autoTokenize": true,
"avsAddress": "string",
"avsZipCode": "string",
"billing": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"billingAddress": "string",
"billingStreet": "string",
"billingType": "string",
"billingZip": "string",
"cardData": {
"cardBrand": "string",
"cardHolderName": "string",
"cardNumber": "string",
"cardholderName": "string",
"cvv": "string",
"expirationDate": "string",
"hostedCard": "string"
},
"cardDataSource": "MANUAL",
"cardHolderName": "string",
"cardNumber": "string",
"cardOnFile": "string",
"cardOnFileTransactionIdentifier": "string",
"cardholderName": "string",
"citStatusIndicator": "string",
"credentialConsentSource": "string",
"credentialConsentVersion": "string",
"currency": "string",
"currentPaymentCount": 0,
"customerCode": "string",
"customerId": "string",
"customerVATNumber": "string",
"cvv": "string",
"description": "string",
"destinationCountryCode": "string",
"dutyCharges": 0,
"expirationDate": "string",
"expirationMonth": "string",
"expirationYear": "string",
"expiryMonth": "string",
"expiryYear": "string",
"industryType": "RE",
"isRecurring": true,
"lastRegisteredChangeDate": "string",
"level2": {
"chargeDescriptor": "string",
"commercialCardLevel": "LEVEL2",
"customerCode": "string",
"customerRefID": "string",
"purchaseOrder": "string",
"shipToZip": "string",
"supplierReferenceNumber": "string",
"taxAmount": 0,
"taxIndicator": "string"
},
"level3": {
"additionalTaxDetails": [
{
"taxAmount": 0,
"taxCategory": "TAXABLE",
"taxRate": "string",
"taxType": "SALES_TAX"
}
],
"commercialCardLevel": "LEVEL2",
"customerVATNumber": "string",
"destinationCountryCode": "string",
"discountAmount": 0,
"dutyAmount": 0,
"freightAmount": 0,
"lineItems": [
{
"commodityCode": "string",
"description": "string",
"discountAmount": 0,
"discountName": "string",
"discountPercentage": "string",
"discountPriority": 0,
"discountStackable": true,
"discountType": "AMOUNT",
"lineTotal": 0,
"productCode": "string",
"quantity": 0,
"taxAmount": 0,
"taxName": "string",
"taxPercentage": "string",
"unitCost": 0,
"unitOfMeasure": "string"
}
],
"orderDate": "string",
"purchaseOrder": "string",
"salesTax": 0,
"shipFromZip": "string",
"shipToZip": "string",
"summaryCommodityCode": "string",
"vatInvoice": "string"
},
"lineItems": [
{
"commodityCode": "string",
"description": "string",
"discountAmount": 0,
"productCode": "string",
"productId": "string",
"quantity": 0,
"taxAmount": 0,
"totalAmount": 0,
"unitCost": 0,
"unitOfMeasure": "string"
}
],
"locationId": "string",
"metadata": {},
"mitStatusIndicator": "string",
"orderDate": "string",
"originalApprovedAmountMinor": 0,
"originalRecurringAmount": 0,
"partialAuthSupport": true,
"paymentCount": 0,
"purchaseOrder": "string",
"quoteId": "string",
"receiptEmail": "string",
"receiptPhone": "string",
"recurringType": "string",
"registeredUserIndicator": "string",
"savedPaymentMethodId": "string",
"serviceLocationCity": "string",
"serviceLocationCountryCode": "string",
"serviceLocationCountrySubdivision": "string",
"serviceLocationGeoCoordinates": "string",
"serviceLocationPostalCode": "string",
"shipFromZip": "string",
"shipToZip": "string",
"shippingCharges": 0,
"skipDuplicateCheck": true,
"source": "CARD_PRESENT",
"storedCredentialReason": "RECURRING",
"summaryCommodityCode": "string",
"taxAmount": 0,
"tipAmount": 0,
"vatInvoice": "string",
"zip": "string"
}