v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB
Semi-Integrated Transactions

Create Token-Only Transaction

Collect card data and generate a payment token for future use without authorizing or capturing funds.

post/rest/v2/terminal/transactions/token-only

Headers

api-keystring required

An access API key issued to you by Xplor Pay.

Request body

amount'range[-infinity, 12]' required

Total transaction amount.

type'AUTH,SALE,REFUND,VOID,CAPTURE,FORCED SALE,CARD INQUIRY' required

Transaction type to process. For example, SALE, AUTH, REFUND.

cardstring

Card number or payment token.

id'range[-infinity, 19]'

Transaction identifier from a previous sale or authorization.

cscstring

Card security code.

invoicestring

Merchant-defined invoice number.

description'range[-infinity, 255]'

Description of the transaction.

comments'range[-infinity, 225]'

Additional notes for the transaction.

cvm'NON (None),MSG(Manual Signature),OFC(Offline Pin in the Clear),PIN(Online Pin),OFE(Offline Encrypted Pin)'

Cardholder verification method.

exp-datestring

Card expiration date in MMyy format.

track2-datastring

Clear-text Track 2 data.

encrypted-track-datastring

Encrypted track data; requires track-format.

track-format'MAGTEK,IDTECH,DEJAVOO,PAX'

Format of encrypted track data.

tip-amount'range[-infinity, 12]'

Tip amount applied to the transaction.

authorization-code'range[-infinity, 255]'

Authorization code for a forced sale obtained from an external processor.

purchase-order'range[-infinity, 255]'

Merchant-defined purchase order number.

email-receiptstring

Indicates whether to send an email receipt to the customer.

email-address'range[-infinity, 255]'

The customer's email address.

customer-id'range[-infinity, 255]'

Merchant-defined customer identifier.

order-id'range[-infinity, 255]'

Merchant-defined order identifier.

client-ip'range[-infinity, 255]'

IP address where the request originated.

billing-is-shippingstring

Indicates whether billing and shipping addresses match.

create-tokenstring

Creates a payment token during the transaction.

merchant-legacy-tokenstring

Indicates use of a legacy payment token.

token-description'range[-infinity, 255]'

Description for the created token.

card-type'VISA,MASTERCARD,AMERICAN EXPRESS,DISCOVER,DINERS CLUB,JCB'

Card brand when creating a token.

emv-datastring

EMV transaction data payload.

key-serial-numberstring

Key serial number for EMV encryption.

emv-entry-method'EMV_DIP,EMV_CONTACTLESS,EMV_FALLBACK_SWIPE,EMV_FALLBACK_NONTECH'

Method used to capture EMV data.

software-type'range[-infinity, 255]'

Identifies the integrating application.

software-type-versionstring

Version of the integrating application.

pin-datastring

Encrypted PIN data for PIN-based transactions.

contactlessstring

Indicates contactless usage (full EMV only).

contactless-devicestring

Indicates contactless device usage (full EMV only).

sales-tax-amount'range[-infinity, 12]'

Sales tax amount applied to the transaction.

sales-tax-type'LOCAL_SALES_TAX,TAX_EXEMPT'

Sales tax classification.

check-field'range[-infinity, 15]'

Field used for duplicate transaction checks.

service-fee'range[-infinity, 12]'

Service fee applied to the transaction.

check-field-midboolean

Enables merchant-level duplicate validation for EMV.

is-amexboolean

Indicates whether the card is American Express.

is-sp30boolean

Indicates whether the transaction is processed on an SP30 terminal.

card-inquiryboolean

Validates the card before token storage.

partial-authorizationboolean

Allows partial approval when full amount is unavailable.

add-tax-to-amountboolean

The sales-tax-amount with respect to the total amount used for authorization and capture.

Response

Successful Sale Transaction

amountstring

Total value associated with the transaction.

currencystring

Currency used for the transaction.

idstring

Unique transaction ID.

invoicestring

Invoice number associated with the transaction.

descriptionstring

Description of the transaction.

commentsstring

Comments associated with the transaction.

serverIdstring
createdstring

Date and time when the transaction was created.

type'AUTH' | 'SALE' | 'REFUND' | 'VOID' | 'CAPTURE' | 'FORCED SALE' | 'CARD INQUIRY'

Identifies the transaction type.

result'APPROVED' | 'DECLINED' | 'ERROR'

Result of the transaction. For example, APPROVED.

cardstring

Card number used for the transaction.

cscstring

Card Security Code used.

cvm'NON (None)' | 'MSG(Manual Signature)' | 'OFC(Offline Pin in the Clear)' | 'PIN(Online Pin)' | 'OFE(Offline Encrypted Pin)'

Cardholder Verification Method used.

authorization-codestring

Code indicating the transaction authorization.

avs-result-code'X' | 'Y' | 'A' | 'W' | 'Z' | 'N' | 'U' | 'R' | 'S' | 'G'

Result code from Address Verification Service.

avs-result-code-descriptionstring

Description of the AVS result.

csc-result-code'M' | 'N' | 'P' | 'S' | 'U' | 'X'

Result code from CSC verification.

csc-result-code-descriptionstring

Description of the CSC result.

tip-adjusted-amountstring

Amount of the adjusted tip.

avs-streetstring

Street used in AVS check.

avs-zipstring

ZIP code used in AVS check.

token-descriptionstring

Description of the token created.

original-amountstring

Original amount before adjustments.

tip-amountstring

Tip amount included in the transaction.

ref-idstring

Reference ID for the transaction.

entry-methodstring

Method used to enter payment data of the transaction. For example, Swipe/Manual.

first-recurring-transactionstring

Indicates whether this is the first recurring transaction.

batch-string-idstring

Identifies the settlement batch ID.

order-idstring

Order id passed in with the transaction.

purchase-orderstring

Purchase order number.

customer-idstring

Customer id passed in with the transaction.

email-addressstring

Email address associated with the transaction.

display-messagestring

Displayable message about transaction result.

result-codestring

Result code associated with transaction result.

billing-is-shippingstring

Indicates if billing and shipping addresses are the same.

tip-adjustedstring

Indicates if the tip was adjusted.

exp-datestring

Expiration date of the card.

client-ipstring

IP address of the client initiating the transaction.

voidedstring

Indicates if the transaction was voided.

pendingstring

Indicates if the transaction is pending.

voided-authstring

Indicates if the authorization was voided.

settledstring

Indicates if the transaction has been settled.

statusstring

Status of the transaction. For example, approved.

emv-datastring

Raw EMV data string.

key-serial-numberstring

Serial number of the encryption key used.

emv-entry-method'EMV_DIP' | 'EMV_CONTACTLESS' | 'EMV_FALLBACK_SWIPE' | 'EMV_FALLBACK_NONTECH'

Method used to enter EMV data.

software-typestring

Type of software used for the transaction.

customer-first-namestring

First name of the customer.

customer-last-namestring

Last name of the customer.

plan-namestring

Name of the payment plan used.

card-typestring

Type of card used. For example, VISA.

contactlessstring

Indicates if contactless payment was used.

contactless-devicestring

Indicates if a contactless device was used.

sales-tax-typestring

Type of sales tax applied.

sales-tax-amountstring

Amount of sales tax applied.

add-tax-to-amountboolean

Indicates if tax was added to the transaction amount.

emv-data-responsestring

Response data from EMV processing.

signature-base-64-imagestring

Base64-encoded image of the signature.

last-fourstring

Last four digits of the card number.

check-field-duplicateboolean

Indicates if a duplicate check was performed.

service-feestring

Service fee applied to the transaction

base-amountstring

Base amount before taxes and fees.

merchant-idstring

Identifier for the merchant.

terminal-idstring

Identifier for the terminal used.

surcharge-appliedboolean

Indicates if a surcharge was applied.

partial-authorizationboolean

Indicates if partial authorization was allowed.

partial-approvedboolean

Indicates if the transaction was partially approved.

secure3d-ecistring

Electronic Commerce Indicator for 3D Secure.

secure3d-result-codestring

Result code from 3D Secure authentication.

total-amountstring

Total amount including all charges.

processing-party-referencestring

Reference ID from the processing party.

original-processing-party-referencestring

Reference of the original transaction assigned by the processing party.

external-transaction-referencestring

External reference ID for the transaction.

funding-referencestring

Reference for the funding transaction.

token-idstring

Identifier of the payment token.

network-transaction-referencestring

Reference ID from the payment network for the transaction.

create-tokenboolean

Indicates if a token should be created for the transaction.

motoboolean

Indicates whether the transaction is MOTO.

issuer_idstring

Identifier for the card issuer.

digital-wallet-typestring

Type of digital wallet used. For example, GOOGLE.