Make a Credit Card Sale

Use this request to create and request a sale to a credit cardholder.

SecurityApiKeyAuth
Request
header Parameters
IV
required
string

Initialization Vector for database encryption.

Request Body schema:
batchName
string (BatchName)

Optional, merchant-assigned name for a batch of transactions. The system creates a default batch name of System for transactions that do not include this element. When used, the value for this element should be stored and passed in the Batch Close transaction.

token
string (Token)

A Token replaces your sensitive card data with a jumble of letters and numbers that are useless to a hacker.

encryptedAccountData
string

Encrypted account data. Pace Software system decrypts and parses the message and completes fields in the account object as specified.

object (DeviceAndPeripherals)

An object containing the device ID and the ID of any peripherals.

deviceId
string (DeviceId)

The unique identifier for the device.

peripheralId
Array of strings (PeripheralId)

An array containing the IDs of the peripherals used with associated device.

object (Detail)

Object with transaction details

currencyCode
string (CurrencyCode)

The type of currency in ISO 4217 format. For example, the currencyCode for US Dollars is USD.

Value: "USD"
amount
required
number <double> (AmountNonZero) [ 0.01 .. 999999999.99 ] \d{0,8}\.\d{2}

The TOTAL amount of the transaction.

object (CreditAccount)

Object with Account information.

pan
required
string (Pan) ^(\d{13,19})$

Consumer’s credit card number. This number should be validated using the Luhn algorithm (mod-10) prior to transmission.

expiration
required
string (Exp)

The date the account will expire. Format MMYY.

cvv
required
string <int32> (Cvv)

Card verification value (CVV) is an additional security feature for CNP transactions. The CVV is printed (not embossed) on the card and is not encoded on the magnetic strip. This value is authenticated during a credit card authorization. The value is 3 digits for Visa and MasterCard and 4 digits for American Express. It is against regulations to store this data.

trackData
string (TrackData) <= 76 characters

Data read from Track of the magnetic stripe on a credit or debit card. The start, end, and lrc sentinels must be removed. It is against regulations to store this data.

firstName
string (FirstName) <= 30 characters

First name of user.

lastName
string (LastName)

Last name of user.

object (Address)

Object with address information

address1
string

Street address

address2
string

Optional, secondary address field

city
string

City

state
string

State

zip
string

Zip code

country
string

Country

Value: "USA"
phoneNumber
string
emailAddress
string
emvTlvData
string (EmvTlvData)

EMV data in TLV (tag-length-value) data format.

object (EmvData)
tag_DF79
string

Kernel version number. This field contains the version number of the contact or contactless kernel used to process the chip data in the transaction. The kernel version can be found on the EMVco issued contact L2 kernel certification letter and the card brand issued contactless L2 kernel certification letters. Only A/N characters should be used. If a kernel version number is not listed on the card brand issued contactless L2 kernel certification letter then the default value of "99999999" must be sent. (variable 1 - 32) For example--If the kernel version is "3.2.4B" then "324B" is all that should be sent.

tag_DF78
string

Device serial number. The manufacturer's unique serial number of the device that interacts with the chip card. (variable 1 - 20).

tag_50
string

Application Label. Mnemonic associated with the Application Identifier (AID) according to ISO/IEC 7816-5.

tag_9F12
string

Application Preferred Name. Preferred mnemonic associated with the AID.

tag_9F40
string

Additional Terminal Capabilities. Indicates the data input and output capabilities of the terminal.

tag_9F02
string

Authorized amount of the transaction (excluding adjustments).

tag_9F03
string

Secondary amount associated with the transaction representing a cashback amount.

tag_9F06
string

Application Identifier (AID) - Terminal. Identifies the application as described in ISO/IEC 7816-5.

Consists of the Registered Application Provider Identifier (RID) + a Proprietary Application Identifier Extension (PIX), e.g., A0000000031010 for Visa Debit/Credit.

tag_82
string

Application Interchange Profile. Indicates the capabilities of the card to support specific functions in the application.

tag_9F36
string

Application Transaction Counter. Counter maintained by the application in the ICC (incrementing the ATC is managed by the ICC).

tag_9F34
string

Cardholder Verification Method (CVM) Results. Identifies a method of verification of the cardholder supported by the application.

tag_9F39
string

POS Entry Mode. Indicates the method by which the PAN was entered, according to the first two digits of the ISO 8583:1987 POS Entry Mode.

PAN Entry Mode Meaning
00 Unknown
01 Manual
02 Magnetic stripe
03 Bar code
04 OCR
05 Integrated circuit card (ICC). CVV can be checked.
07 Auto entry via contactless EMV.
10 Merchant has Cardholder Credentials on File.
80 Fallback from integrated circuit card (ICC) to magnetic stripe
90 Magnetic stripe as read from track 2. CVV can be checked.
91 Auto entry via contactless magnetic stripe
95 Integrated circuit card (ICC). CVV may not be checked.
99 Same as original transaction.
tag_9F33
string

Terminal Capabilities. Indicates the card data input, CVM, and security capabilities of the terminal.

tag_9F1A
string

Terminal Country Code. Indicates the country of the terminal, represented according to ISO 3166

tag_9F35
string

Terminal Type. Indicates the environment of the terminal, its communications capability, and its operational control.

tag_95
string

Terminal Verification Results. Status of the different functions as seen from the terminal.

tag_5F2A
string

Transaction Currency Code. Indicates the currency code of the transaction according to ISO 4217.

tag_9A
string

Transaction Date. Local date that the transaction was authorized. Format YYMMDD.

tag_9B
string

Transaction Status Information. Indicates the functions performed in a transaction.

tag_9F21
string

Transaction Time. Local time that the transaction was authorized. Format HHMMSS.

tag_9C
string

Transaction Type. Indicates the type of financial transaction, represented by the first two digits of ISO 8583:1987 Processing Code

tag_9F37
string

Unpredictable Number. Value to provide variability and uniqueness to the generation of a cryptogram.

tag_5F2D
string <= 8 characters

Language Preference. One-four languages stored in order of preference, each represented by 2 alphabetical characters according to ISO 639 Note--EMVCo strongly recommends that cards be personalized with data element 5F2D coded in lowercase, but that terminals accept the data element whether it is coded in upper or lower case.

tag_5F34
string

Application Primary Account Number (PAN) Sequence Number. Identifies and differentiates cards with the same PAN.

tag_84
string

Dedicated File (DF) Name. Identifies the name of the DF as described in ISO/IEC 7816-4

tag_5F20
string

Cardholder Name. Indicates cardholder name according to ISO 7813

tag_9F26
string

Application Cryptogram. Cryptogram returned by the ICC in response of the GENERATE AC command.

tag_9F27
string

Cryptogram Information Data. Indicates the type of cryptogram and the actions to be performed by the terminal.

tag_9F10
string

Issuer Application Data. Contains proprietary application data for transmission to the issuer in an online transaction.

tag_57
string

Track 2 Equivalent Data. Contains the data elements of track 2 according to ISO/IEC 7813, excluding start sentinel, end sentinel, and Longitudinal Redundancy Check (LRC), as follows--Primary Account Number (n, var. up to 19) Field Separator (Hex 'D') (b) Expiration Date (MMYY) (n 4) Service Code (n 3) Discretionary Data (defined by individual payment systems) (n, var.) Pad with one Hex 'F' if needed to ensure whole bytes (b)

tag_5A
string

Application Primary Account Number (PAN). Valid cardholder account number.

tag_4F
string

Application Identifier (AID) – card. Identifies the application as described in ISO/IEC 7816-5.

tag_9F4C
string or null

ICC Dynamic Number. The 4- to 16-character ICC Dynamic Number is a time-variant numerical value generated by the chip card.

tag_9F6B
number or null <double>

Card Cardholder Verifications Methods (CVM) Limit.

tag_9F6E
string or null

Form Factor Indicator (FFI) or PayPass Third-Party Data.

FFI: The 8-character Form Factor Indicator indicates the form factor of the consumer payment device and the type of contactless interface over which the transaction was conducted. The Form Factor Indicator is both an implementation and issuer option. example: 12-34-56-78-9A

PayPass Third-Party Data: A 10- to 64-character PayPass Third-Party Data subfield contains proprietary data from a third party. The PayPass Third-Party Data value subfield is formatted in -coded binary format. example: 9F6E0401020304

tag_9F7C
string or null

Customer Exclusive Data (CED). The up to 64-character variable length Customer Exclusive Data contains issuer proprietary data for transmission to the issuer.

object (IndustryData)

Contains all the sub-elements or fields that identify an industry and include data unique to that industry.

industry
required
string

Type of industry data submitted with request. Options are:

  • card-not-present
  • fuel
  • hotel
  • restaurant
  • retail
  • supermarket
  • undefined
Enum: "card-not-present" "fuel" "hotel" "restaurant" "retail" "supermarket" "undefined"
integer or string <int32>

Electronic Commerce Indicator (ECI) is a value returned by Directory Servers (namely Visa, MasterCard, JCB, and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.

  • m: mail order
  • t: telephone order
  • 3: query/lookup only for card present
  • 4: lookup only for card not present
  • 5: recurring payment
  • 6: installment payment
  • 7: Authenticated (3-D Secure) Visa Secure, Mastercard SecureCode, Amex SafeKey and Discover Protect Buy
  • 8: Non-Authenticated (authentication attempted) at 3-D Secure-capable merchant
  • 9: Secure (Non-3-D Secure) Online Payment
Enum: "m" "t" "3" "4" "5" "6" "7" "8" "9"
One of:

Electronic Commerce Indicator (ECI) is a value returned by Directory Servers (namely Visa, MasterCard, JCB, and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.

  • m: mail order
  • t: telephone order
  • 3: query/lookup only for card present
  • 4: lookup only for card not present
  • 5: recurring payment
  • 6: installment payment
  • 7: Authenticated (3-D Secure) Visa Secure, Mastercard SecureCode, Amex SafeKey and Discover Protect Buy
  • 8: Non-Authenticated (authentication attempted) at 3-D Secure-capable merchant
  • 9: Secure (Non-3-D Secure) Online Payment
integer <int32>

Electronic Commerce Indicator (ECI) is a value returned by Directory Servers (namely Visa, MasterCard, JCB, and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.

  • m: mail order
  • t: telephone order
  • 3: query/lookup only for card present
  • 4: lookup only for card not present
  • 5: recurring payment
  • 6: installment payment
  • 7: Authenticated (3-D Secure) Visa Secure, Mastercard SecureCode, Amex SafeKey and Discover Protect Buy
  • 8: Non-Authenticated (authentication attempted) at 3-D Secure-capable merchant
  • 9: Secure (Non-3-D Secure) Online Payment
Enum: "m" "t" "3" "4" "5" "6" "7" "8" "9"
purchaseId
string <= 25 characters

The purchase ID is the customer's PO number (if any).

market_specific_id
string

Market-specific identifier that can affect interchange rate.

  • a: auto rental
  • b: bill payment
  • h: hotel/lodging
Enum: "a" "b" "h"
object (ShipTo)

Contains all the sub-elements or fields used to define a shipping record in the system.

description
string (Description) <= 50 characters

Merchant-provided description to help identify a record in the system.

firstName
string (FirstName) <= 30 characters

First name of user.

lastName
string (LastName)

Last name of user.

object (Address)

Object with address information

address1
string

Street address

address2
string

Optional, secondary address field

city
string

City

state
string

State

zip
string

Zip code

country
string

Country

Value: "USA"
emailAddress
string

Email address of cardholder.

phoneNumber
string

Phone number of cardholder.

object (SoftDescriptors)

Contains all the sub-elements or fields used to create soft-descriptor data. This element is only supported for the CNP industry

merchantName
string (MerchantName) <= 25 characters

Merchant name that will appear on the cardholder’s statement. Should be as descriptive as possible to avoid customer inquires or chargebacks.

merchantPhoneNumber
string (MerchantPhoneNumber)

Merchant phone number that will appear on the cardholder’s statement. Should be a customer support number to deal with cardholder inquires.

merchantState
string (MerchantState) <= 2 characters

Merchant state that will appear on the cardholder’s statement.

object (CustomPropertiesInput)

An object containing user-defined key/value pairs.

property name*
additional property
string
echo
string (Echo)

Returns (echos) a user-provided value in the API response.

Responses
200

OK

400

Bad Request

401

Unauthorized access

403

Access forbidden

409

Conflict.

429

Too Many Requests

post/transactions/sale
Request samples
{
  • "batchName": "AA-001",
  • "token": "string",
  • "encryptedAccountData": "string",
  • "deviceAndPeripherals": {
    },
  • "details": {
    },
  • "account": {
    },
  • "industry": {
    },
  • "shipTo": {
    },
  • "softDescriptor": {
    },
  • "userDefinedFields": {
    },
  • "echo": "Hello World"
}
Response samples
{
  • "transactionMetadata": {
    },
  • "result": {
    },
  • "surcharge": {
    },
  • "cashDiscount": {
    },
  • "userDefinedFields": {
    },
  • "cryptoKeys": {
    },
  • "echo": "Hello World"
}
Copyright © Pace Software 2021–2023. All rights reserved.