v1
latestOpenAPI 3.0.12026-07-2356172250.9 KBStart mobile sale transaction
Create a mobile sale transaction using a mobile transaction token that involves authorization and capture. Transactions of $1.00 or greater are approved and automatically added to the open batch for settlement.
Headers
An access API key issued to you by Xplor Pay.
The transaction token returned from the successfulTransactionToken method of the Mobile framework.
Request body
Type of transaction.
Credit card number.
Total transaction amount.
Unique identifier for the transaction request.
Card Security Code (CVV).
Invoice number for the transaction.
Description of the transaction
Additional comments related to the transaction.
Type of software initiating the transaction.
Version of the software used.
Type of sales tax.
Amount of sales tax applied.
Additional service fee.
Base64-encoded signature image.
Tip amount included in the transaction.
Code used to authorize the transaction.
Purchase order number.
Indicates if a receipt should be emailed.
Email address of the customer.
Identifier for the customer.
Unique identifier for the order.
IP address of the client initiating the transaction.
Indicates if billing and shipping addresses are the same.
Indicates if a token should be created for future use.
Description for the token if created.
Field to be checked for validation.
Validates MID (Merchant ID) field.
If true, performs a card inquiry.
3D Secure authentication data.
Electronic Commerce Indicator for 3D Secure.
Indicates whether sales tax should be added to the total amount used for authorization and capture
Response
Successful 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.