Transactions

Add Tip to a Transaction

put

Add a tip amount to an existing captured transaction identified by the transaction ID.

Path parameters

idanyRequired

A unique identifier for the transaction returned by the Capture a Transaction endpoint.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

tip-amountstringRequired

The value of the tip to be added to the transaction (in decimal format). For example, "0.08" for 8 cents.

Example: 0.08

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

put

/rest/v2/transactions/{id}

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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Void Transaction

post

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.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/void

POST /rest/v2/transactions/void HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Start a Sale Transaction

post

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.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/sale

POST /rest/v2/transactions/sale HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Refund Transaction

post

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.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/refund

POST /rest/v2/transactions/refund HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Process Forced Sale Transaction

post

Process forced sale transactions of $1 or more without prior authorization. Forced sale transactions under $1 are declined during testing.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/forced-sale

POST /rest/v2/transactions/forced-sale HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Capture a Transaction

post

Process the previously authorized transactions.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/capture

POST /rest/v2/transactions/capture HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Authorize Transaction with 3-D Secure Authentication

post

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.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

amountstring · enumRequired

Total transaction amount.

Example: 80.0Possible values:

typestring · enumRequired

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

Example: SALEPossible values:

cardstringOptional

Card number or payment token.

Example: 4111111111111111

secure3dstring · enumRequired

3‑D Secure cryptogram or CAVV (Cardholder Authentication Verification Value) provided by the 3DS provider.

Example: AAEBBBYSNAAAAA+gcCAjdAAAAAA=Possible values:

secure3d-ecistring · enumRequired

Electronic Commerce Indicator from the issuer.

Example: 05Possible values:

secure3d-platformstringRequired

Name of the platform or provider used to perform 3‑D Secure (3DS) authentication.

Example: EVERVAULT

secure3d-directory-server-transaction-idstringRequired

Directory Server Transaction ID that ties the authentication to the transaction authorization.

Example: ccb4016e-776c-56f1-8000-0000849d676e

secure3d-protocol-versionstringRequired

3‑D Secure protocol version used to ensure correct liability and routing.

Example: 2.2.0

idstring · enumOptional

Transaction identifier from a previous sale or authorization.

Possible values:

cscstringOptional

Card security code.

Example: 999

commentsstring · enumOptional

Additional notes for the transaction.

Example: Bad tipper .90 on 80.00 transactionPossible values:

cvmstring · enumOptional

Cardholder verification method.

Example: NON (None)Possible values:

exp-datestringOptional

Card expiration date in MMyy format.

Example: 0932

track2-datastringOptional

Clear-text Track 2 data.

Example: text

encrypted-track-datastringOptional

Encrypted track data; requires track-format.

Example: text

track-formatstring · enumOptional

Format of encrypted track data.

Possible values:

tip-amountstring · enumOptional

Tip amount applied to the transaction.

Example: 0.9Possible values:

invoicestringOptional

Merchant-defined invoice number.

Example: invoice123

authorization-codestring · enumOptional

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

Example: AC789UPossible values:

purchase-orderstring · enumOptional

Merchant-defined purchase order number.

Example: PO789Possible values:

email-receiptstringOptional

Indicates whether to send an email receipt to the customer.

Example: false

email-addressstring · enumOptional

The customer's email address.

Example: [email protected]Possible values:

customer-idstring · enumOptional

Merchant-defined customer identifier.

Example: Customer 1234Possible values:

order-idstring · enumOptional

Merchant-defined order identifier.

Example: 99988dPossible values:

descriptionstring · enumOptional

Description of the transaction.

Example: Transaction descPossible values:

client-ipstring · enumOptional

IP address where the request originated.

Example: 127.0.0.1Possible values:

billing-is-shippingstringOptional

Indicates whether billing and shipping addresses match.

Example: false

create-tokenstringOptional

Creates a payment token during the transaction.

Example: false

merchant-legacy-tokenstringOptional

Indicates use of a legacy payment token.

Example: false

token-descriptionstring · enumOptional

Description for the created token.

Example: textPossible values:

card-typestring · enumOptional

Card brand when creating a token.

Example: VISAPossible values:

emv-datastringOptional

EMV transaction data payload.

Example: text

key-serial-numberstringOptional

Key serial number for EMV encryption.

Example: text

emv-entry-methodstring · enumOptional

Method used to capture EMV data.

Example: EMV_DIPPossible values:

software-typestring · enumOptional

Identifies the integrating application.

Example: MySoftware_Version1.3Possible values:

software-type-versionstringOptional

Version of the integrating application.

Example: text

pin-datastringOptional

Encrypted PIN data for PIN-based transactions.

Example: text

contactlessstringOptional

Indicates contactless usage (full EMV only).

Example: false

contactless-devicestringOptional

Indicates contactless device usage (full EMV only).

Example: false

sales-tax-amountstring · enumOptional

Sales tax amount applied to the transaction.

Example: 90.0Possible values:

sales-tax-typestring · enumOptional

Sales tax classification.

Example: LOCAL_SALES_TAXPossible values:

check-fieldstring · enumOptional

Field used for duplicate transaction checks.

Example: invoicePossible values:

service-feestring · enumOptional

Service fee applied to the transaction.

Example: 2.9Possible values:

check-field-midbooleanOptional

Enables merchant-level duplicate validation for EMV.

Example: true

is-amexbooleanOptional

Indicates whether the card is American Express.

Example: false

is-sp30booleanOptional

Indicates whether the transaction is processed on an SP30 terminal.

Example: false

card-inquirybooleanOptional

Validates the card before token storage.

Example: true

partial-authorizationbooleanOptional

Allows partial approval when full amount is unavailable.

Example: false

add-tax-to-amountbooleanRequired

Indicates whether to add tax to the transaction amount.

Example: false

Responses

200

Successful Transaction

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

post

/rest/v2/transactions/auth

POST /rest/v2/transactions/auth HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2371

{
  "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": "range[-infinity, 19]",
  "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": "MAGTEK,IDTECH,DEJAVOO,PAX",
  "tip-amount": "0.9",
  "invoice": "invoice123",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[email protected]",
  "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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

Search Transactions

get

Search transactions for up to 90 days.

Query parameters

levelstring · enumOptional

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.

Default: terminalPossible values:

idstringOptional

A unique transaction identifier to search for a specific transaction, such as a void, capture, or refund.

amountstringOptional

The amount for which you want to search transactions.

min-amountstringOptional

Minimum transaction amount for which you want to search transactions.

max-amountstringOptional

Maximum transaction amount for which you want to search transactions.

typestringOptional

The type of transaction you want to search.

statusstring · enumOptional

The transaction status to search for a specific transaction. Possible values: APPROVED, DECLINED.

Possible values:

last-fourstringOptional

The last four digits of the card provided during the transaction.

authorization-codestringOptional

The authorization code issued by the payment provider.

invoicestringOptional

The invoice number, if it was included in the transaction request.

order-idstringOptional

A unique order identifier, if it was included in the transaction request.

purchase-orderstringOptional

Purchase order number associated with the transaction.

descriptionstringOptional

Description associated with the transaction.

customer-idstringOptional

Unique customer identifier associated with the transaction.

service-feestringOptional

Service fee amount for the transaction.

include-tip-adjboolean · enumOptional

Include tip-adjusted transactions. Default: false.

Default: falsePossible values:

ref-idstringOptional

A transaction reference identifier for which you want to search transactions.

batch-numberstringOptional

A batch number used to search for group transactions.

pendingstring · enumOptional

Include pending authorizations when you search transactions. Use "true" or "false".

Possible values:

settledboolean · enumOptional

Filter transactions by settlement status.

Possible values:

start-datestringOptional

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.

end-datestringOptional

The end date for the transaction search. Valid formats match those accepted for the start-date field.

pageintegerOptional

The page number for which you want to search transactions.

page-sizeintegerOptional

The size of the page for which you want to search transactions.

descendingboolean · enumOptional

The sort order for the transaction search list. Use true to display transaction list in descending order and false for ascending order.

Possible values:

order-bystringOptional

Field by which you want to sort the transaction results.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

Success

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

204

No Content

400

Bad Request

401

Unauthorized

402

Business Exception

500

Internal server error

get

/rest/v2/transactions

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",
    "action": {
      "url": "text",
      "method": "text",
      "type": "text",
      "environment": "text",
      "locale": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "payment-method-type": "text",
      "sub-type": "text",
      "client-key": "text",
      "qr-code-data": "text"
    },
    "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",
    "first-recurring-transaction": "false",
    "batch-string-id": "000101",
    "order-id": "order99",
    "purchase-order": "purcahseOrder88",
    "customer-id": "1234Customer",
    "email-address": "[email protected]",
    "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",
    "processing-party-reference": "text",
    "original-processing-party-reference": "text",
    "external-transaction-reference": "text",
    "funding-reference": "text",
    "token-id": "text",
    "network-transaction-reference": "text",
    "create-token": true,
    "moto": true,
    "issuer_id": "10",
    "digital-wallet-type": "GOOGLE"
  },
  "payloadType": "transaction"
}

PreviousTransactions NextModels

Last updated 17 days ago

Was this helpful?

hashtagAdd Tip to a Transaction

hashtagVoid Transaction

hashtagStart a Sale Transaction

hashtagRefund Transaction

hashtagProcess Forced Sale Transaction

hashtagCapture a Transaction

hashtagAuthorize Transaction with 3-D Secure Authentication

hashtagSearch Transactions

Add Tip to a Transaction

Void Transaction

Start a Sale Transaction

Refund Transaction

Process Forced Sale Transaction

Capture a Transaction

Authorize Transaction with 3-D Secure Authentication

Search Transactions