v1
latestOpenAPI 3.0.12026-07-2356172250.9 KBCreate Token-Only Transaction
Collect card data and generate a payment token for future use without authorizing or capturing funds.
Headers
An access API key issued to you by Xplor Pay.
Request body
Total transaction amount.
Transaction type to process. For example, SALE, AUTH, REFUND.
Card number or payment token.
Transaction identifier from a previous sale or authorization.
Card security code.
Merchant-defined invoice number.
Description of the transaction.
Additional notes for the transaction.
Cardholder verification method.
Card expiration date in MMyy format.
Clear-text Track 2 data.
Encrypted track data; requires track-format.
Format of encrypted track data.
Tip amount applied to the transaction.
Authorization code for a forced sale obtained from an external processor.
Merchant-defined purchase order number.
Indicates whether to send an email receipt to the customer.
The customer's email address.
Merchant-defined customer identifier.
Merchant-defined order identifier.
IP address where the request originated.
Indicates whether billing and shipping addresses match.
Creates a payment token during the transaction.
Indicates use of a legacy payment token.
Description for the created token.
Card brand when creating a token.
EMV transaction data payload.
Key serial number for EMV encryption.
Method used to capture EMV data.
Identifies the integrating application.
Version of the integrating application.
Encrypted PIN data for PIN-based transactions.
Indicates contactless usage (full EMV only).
Indicates contactless device usage (full EMV only).
Sales tax amount applied to the transaction.
Sales tax classification.
Field used for duplicate transaction checks.
Service fee applied to the transaction.
Enables merchant-level duplicate validation for EMV.
Indicates whether the card is American Express.
Indicates whether the transaction is processed on an SP30 terminal.
Validates the card before token storage.
Allows partial approval when full amount is unavailable.
The sales-tax-amount with respect to the total amount used for authorization and capture.
Response
Successful Sale Transaction
Total value associated with the transaction.
Currency used for the transaction.
Unique transaction ID.
Invoice number associated with the transaction.
Description of the transaction.
Comments associated with the transaction.
Date and time when the transaction was created.
Identifies the transaction type.
Result of the transaction. For example, APPROVED.
Card number used for the transaction.
Card Security Code used.
Cardholder Verification Method used.
Code indicating the transaction authorization.
Result code from Address Verification Service.
Description of the AVS result.
Result code from CSC verification.
Description of the CSC result.
Amount of the adjusted tip.
Street used in AVS check.
ZIP code used in AVS check.
Description of the token created.
Original amount before adjustments.
Tip amount included in the transaction.
Reference ID for the transaction.
Method used to enter payment data of the transaction. For example, Swipe/Manual.
Indicates whether this is the first recurring transaction.
Identifies the settlement batch ID.
Order id passed in with the transaction.
Purchase order number.
Customer id passed in with the transaction.
Email address associated with the transaction.
Displayable message about transaction result.
Result code associated with transaction result.
Indicates if billing and shipping addresses are the same.
Indicates if the tip was adjusted.
Expiration date of the card.
IP address of the client initiating the transaction.
Indicates if the transaction was voided.
Indicates if the transaction is pending.
Indicates if the authorization was voided.
Indicates if the transaction has been settled.
Status of the transaction. For example, approved.
Raw EMV data string.
Serial number of the encryption key used.
Method used to enter EMV data.
Type of software used for the transaction.
First name of the customer.
Last name of the customer.
Name of the payment plan used.
Type of card used. For example, VISA.
Indicates if contactless payment was used.
Indicates if a contactless device was used.
Type of sales tax applied.
Amount of sales tax applied.
Indicates if tax was added to the transaction amount.
Response data from EMV processing.
Base64-encoded image of the signature.
Last four digits of the card number.
Indicates if a duplicate check was performed.
Service fee applied to the transaction
Base amount before taxes and fees.
Identifier for the merchant.
Identifier for the terminal used.
Indicates if a surcharge was applied.
Indicates if partial authorization was allowed.
Indicates if the transaction was partially approved.
Electronic Commerce Indicator for 3D Secure.
Result code from 3D Secure authentication.
Total amount including all charges.
Reference ID from the processing party.
Reference of the original transaction assigned by the processing party.
External reference ID for the transaction.
Reference for the funding transaction.
Identifier of the payment token.
Reference ID from the payment network for the transaction.
Indicates if a token should be created for the transaction.
Indicates whether the transaction is MOTO.
Identifier for the card issuer.
Type of digital wallet used. For example, GOOGLE.