Transactions
Add a tip amount to an existing captured transaction identified by the transaction ID.
A unique identifier for the transaction returned by the Capture a Transaction endpoint.
An access API key issued to you by Xplor Pay.
The value of the tip to be added to the transaction (in decimal format). For example, "0.08" for 8 cents.
0.08Successful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
PUT /rest/v2/transactions/{id} HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"tip-amount": "0.08"
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Void transactions that are authorized, approved, or pending. Voided transactions are removed from the open batch and sent to the payment issuer. Transactions in closed batches cannot be voided.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/void HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Start sale transactions of $1 or more. Transactions below $1 are automatically declined during testing. Find the approved sale transactions in the Open batch to settle them.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/sale HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Refund an amount for a previously settled transaction. The refund process applies only to transactions that were settled using the sale and capture method. The following two options allow you to refund transactions: Matched refund: Use the ID and amount fields to process a matched refund for up to the total amount of the previous transaction. Unmatched refund: Use the card field to process an unmatched refund for an amount that is less than or greater than the total of the previous transaction.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/refund HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Process forced sale transactions of $1 or more without prior authorization. Forced sale transactions under $1 are declined during testing.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/forced-sale HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Process the previously authorized transactions.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/capture HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Pre-authorize or authorize transactions by including 3-D Secure (3DS) authentication data of $1 or more. Note: You can't use 3‑D Secure (3DS) data fields in the request to authenticate re‑authorized transactions. You can capture a pre‑authorized transaction later without adding 3‑D Secure (3DS) data fields to the request.
An access API key issued to you by Xplor Pay.
Total transaction amount.
80.0Transaction type to process. For example, SALE, AUTH, REFUND. Allowable values: AUTH, SALE, REFUND, VOID, CAPTURE, FORCED SALE, CARD INQUIRY.
SALECard number or payment token.
41111111111111113‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.
AAEBBBYSNAAAAA+gcCAjdAAAAAA=Electronic Commerce Indicator from the issuer.
05Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.
EVERVAULTDirectory Server Transaction ID that ties the authentication to the transaction authorization.
ccb4016e-776c-56f1-8000-0000849d676e3‑D Secure protocol version used to ensure correct liability and routing.
2.2.0Transaction identifier from a previous sale or authorization.
Card security code.
999Additional notes for the transaction.
Bad tipper .90 on 80.00 transactionCardholder verification method. Allowable values: NON (None), MSG(Manual Signature), OFC(Offline Pin in the Clear), PIN(Online Pin), OFE(Offline Encrypted Pin).
NON (None)Card expiration date in MMyy format.
0932Clear-text Track 2 data.
textEncrypted track data; requires track-format.
textFormat of encrypted track data. Allowable values: MAGTEK, IDTECH, DEJAVOO, PAX.
Tip amount applied to the transaction.
0.9Merchant-defined invoice number.
invoice123Authorization code for a forced sale obtained from an external processor.
AC789UMerchant-defined purchase order number.
PO789Indicates whether to send an email receipt to the customer.
falseThe customer's email address.
test@test.comMerchant-defined customer identifier.
Customer 1234Merchant-defined order identifier.
99988dDescription of the transaction.
Transaction descIP address where the request originated.
127.0.0.1Indicates whether billing and shipping addresses match.
falseCreates a payment token during the transaction.
falseIndicates use of a legacy payment token.
falseDescription for the created token.
textCard brand when creating a token. Allowable values: VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, DINERS CLUB, JCB.
VISAEMV transaction data payload.
textKey serial number for EMV encryption.
textMethod used to capture EMV data. Allowable values: EMV_DIP, EMV_CONTACTLESS, EMV_FALLBACK_SWIPE, EMV_FALLBACK_NONTECH.
EMV_DIPIdentifies the integrating application.
MySoftware_Version1.3Version of the integrating application.
textEncrypted PIN data for PIN-based transactions.
textIndicates contactless usage (full EMV only).
falseIndicates contactless device usage (full EMV only).
falseSales tax amount applied to the transaction.
90.0Sales tax classification. Allowable values: LOCAL_SALES_TAX, TAX_EXEMPT.
LOCAL_SALES_TAXField used for duplicate transaction checks.
invoiceService fee applied to the transaction.
2.9Enables merchant-level duplicate validation for EMV.
trueIndicates whether the card is American Express.
falseIndicates whether the transaction is processed on an SP30 terminal.
falseValidates the card before token storage.
trueAllows partial approval when full amount is unavailable.
falseIndicates whether to add tax to the transaction amount.
falseSuccessful Transaction
payload
Type of payload returned in the response.
transactionBad Request
Unauthorized
Business Exception
Internal server error
POST /rest/v2/transactions/auth HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2326
{
"amount": "80.0",
"type": "SALE",
"card": "4111111111111111",
"secure3d": "AAEBBBYSNAAAAA+gcCAjdAAAAAA=",
"secure3d-eci": "05",
"secure3d-platform": "EVERVAULT",
"secure3d-directory-server-transaction-id": "ccb4016e-776c-56f1-8000-0000849d676e",
"secure3d-protocol-version": "2.2.0",
"id": "text",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"csc": "999",
"comments": "Bad tipper .90 on 80.00 transaction",
"cvm": "NON (None)",
"exp-date": "0932",
"track2-data": "text",
"encrypted-track-data": "text",
"track-format": "text",
"tip-amount": "0.9",
"invoice": "invoice123",
"authorization-code": "AC789U",
"purchase-order": "PO789",
"email-receipt": false,
"email-address": "test@test.com",
"customer-id": "Customer 1234",
"order-id": "99988d",
"description": "Transaction desc",
"client-ip": "127.0.0.1",
"billing-is-shipping": "false",
"create-token": "false",
"merchant-legacy-token": false,
"token-description": "text",
"card-type": "VISA",
"emv-data": "text",
"key-serial-number": "text",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"software-type-version": "text",
"pin-data": "text",
"contactless": false,
"contactless-device": false,
"sales-tax-amount": "90.0",
"sales-tax-type": "LOCAL_SALES_TAX",
"check-field": "invoice",
"service-fee": "2.9",
"check-field-mid": true,
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"is-amex": false,
"is-sp30": false,
"card-inquiry": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"add-tax-to-amount": false
}{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Search transactions for up to 90 days.
The scope of the transaction search. Use terminal (default) to search transactions at the terminal level, and merchant to search transactions at the merchant level. The results include transactions from all terminals associated to the merchant. Allowable values = terminal, merchant.
terminalA unique transaction identifier to search for a specific transaction, such as a void, capture, or refund.
The amount for which you want to search transactions.
Minimum transaction amount for which you want to search transactions.
Maximum transaction amount for which you want to search transactions.
The type of transaction you want to search.
The transaction status to search for a specific transaction. Allowable values = APPROVED, DECLINED.
The last four digits of the card provided during the transaction.
The authorization code issued by the payment provider.
The invoice number, if it was included in the transaction request.
A unique order identifier, if it was included in the transaction request.
Purchase order number associated with the transaction.
Description associated with the transaction.
Unique customer identifier associated with the transaction.
Service fee amount for the transaction.
Include tip-adjusted transactions. Default: false.
falseA transaction reference identifier for which you want to search transactions.
A batch number used to search for group transactions.
Include pending authorizations when you search transactions. Use "true" or "false".
Filter transactions by settlement status.
The start date for the transaction search. Valid formats: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z.
The end date for the transaction search. Valid formats match those accepted for the start-date field.
The page number for which you want to search transactions.
The size of the page for which you want to search transactions.
The sort order for the transaction search list. Use true to display transaction list in descending order and false for ascending order.
trueField by which you want to sort the transaction results.
An access API key issued to you by Xplor Pay.
Success
payload
Type of payload returned in the response.
transactionNo Content
Bad Request
Unauthorized
Business Exception
Internal server error
GET /rest/v2/transactions HTTP/1.1
api-key: text
Accept: */*
{
"transaction": {
"amount": "text",
"currency": "text",
"id": "123456",
"invoice": "Test56",
"description": "transaction description",
"comments": "These are my comments",
"created": "8/10/2017 12:12:12:00 UTC",
"type": "SALE",
"result": "APPROVED",
"billing": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"shipping": {
"company": "text",
"street": "text",
"street2": "text",
"city": "text",
"state": "text",
"zip": "text",
"country": "text",
"phone": "text",
"first-name": "text",
"last-name": "text",
"from-zip": "text"
},
"card": "text",
"csc": "999",
"cvm": "NON",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"tip-adjusted-amount": "1.0",
"avs-street": "Example Street",
"avs-zip": "85284",
"token-description": "text",
"original-amount": "12.0",
"tip-amount": "0.2",
"ref-id": "568972",
"entry-method": "EMV_DIP",
"batch-string-id": "000101",
"order-id": "order99",
"purchase-order": "purcahseOrder88",
"customer-id": "1234Customer",
"email-address": "test@test.com",
"display-message": "Transaction Approved",
"result-code": "000",
"billing-is-shipping": true,
"tip-adjusted": "false",
"exp-date": "1232",
"client-ip": "127.0.0.1",
"voided": "false",
"pending": "false",
"voided-auth": "false",
"settled": "false",
"status": "approved",
"emv-data": "0099daje93993903",
"key-serial-number": "0099daje93993903",
"emv-entry-method": "EMV_DIP",
"software-type": "MySoftware_Version1.3",
"customer-first-name": "John",
"customer-last-name": "Doe",
"plan-name": "Plan 56",
"card-type": "VISA",
"contactless": "false",
"contactless-device": "false",
"sales-tax-type": "text",
"sales-tax-amount": "6.0",
"add-tax-to-amount": false,
"emv-data-response": "text",
"emv": {
"application-name": "Visa Debit",
"application-id": "A0000000041010",
"terminal-verification-results": "0400088000",
"transaction-status-information": "E800",
"iad": "ABC123",
"transaction-certificate": "CERT1234",
"application-transaction-counter": "0001"
},
"signature-base-64-image": "text",
"last-four": "text",
"check-field-duplicate": true,
"service-fee": "text",
"base-amount": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"merchant-id": "text",
"terminal-id": "text",
"surcharge-applied": true,
"level3": {
"vat-tax-amount": "0.0",
"vat-tax-rate": "0.0",
"order-date": "2024-10-15",
"customer-vat-registration-number": "DE123456789",
"summary-commodity-code": "1234",
"discount-amount": "0.0",
"destination-country-code": "USA",
"freight-amount": "0.0",
"duty-amount": "0.0",
"level3-items": {
"level3-items": [
{
"item-description": "text",
"item-commodity-code": "text",
"item-quantity": "text",
"item-unit-of-measure": "text",
"item-unit-cost": "text",
"item-product-code": "text",
"item-tax-amount": "text",
"item-tax-rate": "text",
"item-discount": "text",
"item-line-total": "text",
"item-net-gross-ind": "text",
"item-discount-rate": "text"
}
]
}
},
"partial-authorization": false,
"partial-approved": false,
"additional-amounts": [
{
"amount": "text",
"account-type": "text",
"amount-type": "text"
}
],
"secure3d-eci": "text",
"secure3d-result-code": "text",
"total-amount": "text",
"external-transaction-reference": "text",
"token-id": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE"
},
"payloadType": "transaction"
}Last updated
Was this helpful?