Mobile Transactions

Start mobile sale transaction

post

Create a mobile sale transaction using a mobile transaction token that involves authorization and capture. Transactions of $1.00 or greater are approved and automatically added to the open batch for settlement.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

mobilejwtanyRequired

The transaction token returned from the successfulTransactionToken method of the Mobile framework.

Body

application/jsonapplication/xml

typestring · enumRequired

Type of transaction.

Example: SALEPossible values:

cardstringOptional

Credit card number.

Example: 4111111111111111

amountstringRequired

Total transaction amount.

Example: 80.0

idstringOptional

Unique identifier for the transaction request.

Example: text

cscstringOptional

Card Security Code (CVV).

Example: 999

invoicestringOptional

Invoice number for the transaction.

Example: invoice123

descriptionstringOptional

Description of the transaction

Example: Transaction desc

commentsstringOptional

Additional comments related to the transaction.

Example: Paint the canoe red

software-typestringRequired

Type of software initiating the transaction.

Example: MySoftware_Version1.3

software-type-versionstringRequired

Version of the software used.

Example: text

sales-tax-typestring · enumOptional

Type of sales tax.

Example: LOCAL_SALES_TAXPossible values:

sales-tax-amountstringOptional

Amount of sales tax applied.

Example: 90.0

service-feestringOptional

Additional service fee.

Example: 2.9

signature-base-64-imagestringOptional

Base64-encoded signature image.

Example: text

tip-amountstringOptional

Tip amount included in the transaction.

Example: 0.9

authorization-codestringOptional

Code used to authorize the transaction.

Example: AC789U

purchase-orderstringOptional

Purchase order number.

Example: PO789

email-receiptstringOptional

Indicates if a receipt should be emailed.

Example: false

email-addressstringOptional

Email address of the customer.

Example: [e-mail]

customer-idstringOptional

Identifier for the customer.

Example: Customer 1234

order-idstringOptional

Unique identifier for the order.

Example: 99988d

client-ipstringOptional

IP address of the client initiating the transaction.

Example: 127.0.0.1

billing-is-shippingstringOptional

Indicates if billing and shipping addresses are the same.

Example: false

create-tokenstringOptional

Indicates if a token should be created for future use.

Example: false

token-descriptionstringOptional

Description for the token if created.

Example: text

check-fieldstringOptional

Field to be checked for validation.

Example: invoice

check-field-midbooleanOptional

Validates MID (Merchant ID) field.

Example: true

card-inquirybooleanOptional

If true, performs a card inquiry.

Example: true

secure3dstringOptional

3D Secure authentication data.

Example: text

secure3d-ecistringOptional

Electronic Commerce Indicator for 3D Secure.

Example: text

add-tax-to-amountbooleanOptional

Indicates whether sales tax should be added to the total amount used for authorization and capture

Example: false

Responses

200

Successful Transaction

application/jsonapplication/xml

Contains all details related to the authorized transaction.

amountstringOptional

Total value associated with the transaction.

currencystringOptional

Currency used for the transaction.

idstringOptional

Unique transaction ID.

Example: 123456

invoicestringOptional

Invoice number associated with the transaction.

Example: Test56

descriptionstringOptional

Description of the transaction.

Example: transaction description

commentsstringOptional

Comments associated with the transaction.

Example: These are my comments

serverIdstringOptionalDeprecated

createdstringOptional

Date and time when the transaction was created.

Example: 8/10/2017 12:12:12:00 UTC

typestring · enumOptional

Identifies the transaction type.

Example: SALEPossible values:

resultstring · enumOptional

Result of the transaction. For example, APPROVED.

Example: APPROVEDPossible values:

cardstringOptional

Card number used for the transaction.

cscstringOptional

Card Security Code used.

Example: 999

cvmstring · enumOptional

Cardholder Verification Method used.

Example: NONPossible values:

authorization-codestringOptional

Code indicating the transaction authorization.

Example: AE12368

avs-result-codestring · enumOptional

Result code from Address Verification Service.

Example: XPossible values:

avs-result-code-descriptionstringOptional

Description of the AVS result.

Example: All digits match (9-digit Zip Code)

csc-result-codestring · enumOptional

Result code from CSC verification.

Example: XPossible values:

csc-result-code-descriptionstringOptional

Description of the CSC result.

Example: Service provider did not respond

tip-adjusted-amountstringOptional

Amount of the adjusted tip.

Example: 1.0

avs-streetstringOptional

Street used in AVS check.

Example: Example Street

avs-zipstringOptional

ZIP code used in AVS check.

Example: 85284

token-descriptionstringOptional

Description of the token created.

original-amountstringOptional

Original amount before adjustments.

Example: 12.0

tip-amountstringOptional

Tip amount included in the transaction.

Example: 0.2

ref-idstringOptional

Reference ID for the transaction.

Example: 568972

entry-methodstringOptional

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

Example: EMV_DIP

first-recurring-transactionstringOptional

Indicates whether this is the first recurring transaction.

Example: false

batch-string-idstringOptional

Identifies the settlement batch ID.

Example: 000101

order-idstringOptional

Order id passed in with the transaction.

Example: order99

purchase-orderstringOptional

Purchase order number.

Example: purcahseOrder88

customer-idstringOptional

Customer id passed in with the transaction.

Example: 1234Customer

email-addressstringOptional

Email address associated with the transaction.

Example: [e-mail]

display-messagestringOptional

Displayable message about transaction result.

Example: Transaction Approved

result-codestringOptional

Result code associated with transaction result.

Example: 000

billing-is-shippingstringOptional

Indicates if billing and shipping addresses are the same.

Example: true

tip-adjustedstringOptional

Indicates if the tip was adjusted.

Example: false

exp-datestringOptional

Expiration date of the card.

Example: 1232

client-ipstringOptional

IP address of the client initiating the transaction.

Example: 127.0.0.1

voidedstringOptional

Indicates if the transaction was voided.

Example: false

pendingstringOptional

Indicates if the transaction is pending.

Example: false

voided-authstringOptional

Indicates if the authorization was voided.

Example: false

settledstringOptional

Indicates if the transaction has been settled.

Example: false

statusstringOptional

Status of the transaction. For example, approved.

Example: approved

emv-datastringOptional

Raw EMV data string.

Example: 0099daje93993903

key-serial-numberstringOptional

Serial number of the encryption key used.

Example: 0099daje93993903

emv-entry-methodstring · enumOptional

Method used to enter EMV data.

Example: EMV_DIPPossible values:

software-typestringOptional

Type of software used for the transaction.

Example: MySoftware_Version1.3

customer-first-namestringOptional

First name of the customer.

Example: John

customer-last-namestringOptional

Last name of the customer.

Example: Doe

plan-namestringOptional

Name of the payment plan used.

Example: Plan 56

card-typestringOptional

Type of card used. For example, VISA.

Example: VISA

contactlessstringOptional

Indicates if contactless payment was used.

Example: false

contactless-devicestringOptional

Indicates if a contactless device was used.

Example: false

sales-tax-typestringOptional

Type of sales tax applied.

sales-tax-amountstringOptional

Amount of sales tax applied.

Example: 6.0

add-tax-to-amountbooleanOptional

Indicates if tax was added to the transaction amount.

Example: false

emv-data-responsestringOptional

Response data from EMV processing.

signature-base-64-imagestringOptional

Base64-encoded image of the signature.

last-fourstringOptional

Last four digits of the card number.

check-field-duplicatebooleanOptional

Indicates if a duplicate check was performed.

service-feestringOptional

Service fee applied to the transaction

base-amountstringOptional

Base amount before taxes and fees.

merchant-idstringOptional

Identifier for the merchant.

terminal-idstringOptional

Identifier for the terminal used.

surcharge-appliedbooleanOptional

Indicates if a surcharge was applied.

partial-authorizationbooleanOptional

Indicates if partial authorization was allowed.

Example: false

partial-approvedbooleanOptional

Indicates if the transaction was partially approved.

Example: false

secure3d-ecistringOptional

Electronic Commerce Indicator for 3D Secure.

secure3d-result-codestringOptional

Result code from 3D Secure authentication.

total-amountstringOptional

Total amount including all charges.

processing-party-referencestringOptional

Reference ID from the processing party.

original-processing-party-referencestringOptional

Reference of the original transaction assigned by the processing party.

external-transaction-referencestringOptional

External reference ID for the transaction.

funding-referencestringOptional

Reference for the funding transaction.

token-idstringOptional

Identifier of the payment token.

network-transaction-referencestringOptional

Reference ID from the payment network for the transaction.

create-tokenbooleanOptional

Indicates if a token should be created for the transaction.

motobooleanOptional

Indicates whether the transaction is MOTO.

issuer_idstringOptional

Identifier for the card issuer.

Example: 10

digital-wallet-typestringOptional

Type of digital wallet used. For example, GOOGLE.

Example: GOOGLE

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

402

Business Exception (decline, etc)

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

post/rest/v2/mobile/transactions/sale

HTTPcURLJavaScriptPython

POST /rest/v2/mobile/transactions/sale HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1813

{
  "type": "SALE",
  "card": "4111111111111111",
  "amount": "80.0",
  "id": "text",
  "billing": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "shipping": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "csc": "999",
  "invoice": "invoice123",
  "description": "Transaction desc",
  "comments": "Paint the canoe red",
  "software-type": "MySoftware_Version1.3",
  "software-type-version": "text",
  "sales-tax-type": "LOCAL_SALES_TAX",
  "sales-tax-amount": "90.0",
  "service-fee": "2.9",
  "signature-base-64-image": "text",
  "tip-amount": "0.9",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[e-mail]",
  "customer-id": "Customer 1234",
  "order-id": "99988d",
  "client-ip": "127.0.0.1",
  "billing-is-shipping": "false",
  "create-token": "false",
  "token-description": "text",
  "check-field": "invoice",
  "check-field-mid": true,
  "platform-fees": [
    {
      "fee-name": "DealManager"
    }
  ],
  "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"
        }
      ]
    }
  },
  "secure3d": "text",
  "secure3d-eci": "text",
  "add-tax-to-amount": false
}

application/jsonapplication/xml

{
  "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": "[e-mail]",
  "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"
}

Refund mobile transaction

post

Create the mobile refund transaction using a mobile transaction token for card-present refunds. Refund amounts must be less than or equal to the original transaction amount, and amounts of $1.00 or greater are approved during testing.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

mobilejwtanyRequired

The transaction token returned from the successfulTransactionToken method of the Mobile framework.

Body

application/jsonapplication/xml

typestring · enumRequired

Type of transaction.

Example: SALEPossible values:

cardstringOptional

Credit card number.

Example: 4111111111111111

amountstringRequired

Total transaction amount.

Example: 80.0

idstringOptional

Unique identifier for the transaction request.

Example: text

cscstringOptional

Card Security Code (CVV).

Example: 999

invoicestringOptional

Invoice number for the transaction.

Example: invoice123

descriptionstringOptional

Description of the transaction

Example: Transaction desc

commentsstringOptional

Additional comments related to the transaction.

Example: Paint the canoe red

software-typestringRequired

Type of software initiating the transaction.

Example: MySoftware_Version1.3

software-type-versionstringRequired

Version of the software used.

Example: text

sales-tax-typestring · enumOptional

Type of sales tax.

Example: LOCAL_SALES_TAXPossible values:

sales-tax-amountstringOptional

Amount of sales tax applied.

Example: 90.0

service-feestringOptional

Additional service fee.

Example: 2.9

signature-base-64-imagestringOptional

Base64-encoded signature image.

Example: text

tip-amountstringOptional

Tip amount included in the transaction.

Example: 0.9

authorization-codestringOptional

Code used to authorize the transaction.

Example: AC789U

purchase-orderstringOptional

Purchase order number.

Example: PO789

email-receiptstringOptional

Indicates if a receipt should be emailed.

Example: false

email-addressstringOptional

Email address of the customer.

Example: [e-mail]

customer-idstringOptional

Identifier for the customer.

Example: Customer 1234

order-idstringOptional

Unique identifier for the order.

Example: 99988d

client-ipstringOptional

IP address of the client initiating the transaction.

Example: 127.0.0.1

billing-is-shippingstringOptional

Indicates if billing and shipping addresses are the same.

Example: false

create-tokenstringOptional

Indicates if a token should be created for future use.

Example: false

token-descriptionstringOptional

Description for the token if created.

Example: text

check-fieldstringOptional

Field to be checked for validation.

Example: invoice

check-field-midbooleanOptional

Validates MID (Merchant ID) field.

Example: true

card-inquirybooleanOptional

If true, performs a card inquiry.

Example: true

secure3dstringOptional

3D Secure authentication data.

Example: text

secure3d-ecistringOptional

Electronic Commerce Indicator for 3D Secure.

Example: text

add-tax-to-amountbooleanOptional

Indicates whether sales tax should be added to the total amount used for authorization and capture

Example: false

Responses

200

Successful Transaction

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

402

Business Exception (decline, etc.)

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

post/rest/v2/mobile/transactions/refund

HTTPcURLJavaScriptPython

POST /rest/v2/mobile/transactions/refund HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1813

{
  "type": "SALE",
  "card": "4111111111111111",
  "amount": "80.0",
  "id": "text",
  "billing": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "shipping": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "csc": "999",
  "invoice": "invoice123",
  "description": "Transaction desc",
  "comments": "Paint the canoe red",
  "software-type": "MySoftware_Version1.3",
  "software-type-version": "text",
  "sales-tax-type": "LOCAL_SALES_TAX",
  "sales-tax-amount": "90.0",
  "service-fee": "2.9",
  "signature-base-64-image": "text",
  "tip-amount": "0.9",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[e-mail]",
  "customer-id": "Customer 1234",
  "order-id": "99988d",
  "client-ip": "127.0.0.1",
  "billing-is-shipping": "false",
  "create-token": "false",
  "token-description": "text",
  "check-field": "invoice",
  "check-field-mid": true,
  "platform-fees": [
    {
      "fee-name": "DealManager"
    }
  ],
  "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"
        }
      ]
    }
  },
  "secure3d": "text",
  "secure3d-eci": "text",
  "add-tax-to-amount": false
}

application/jsonapplication/xml

{
  "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": "[e-mail]",
    "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 forced sale mobile transaction

post

Create a mobile forced sale transaction of $1 or more using a mobile transaction token to post a transaction without prior authorization.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

mobilejwtanyRequired

The transaction token returned from the successfulTransactionToken method of the Mobile framework.

Body

application/jsonapplication/xml

typestring · enumRequired

Type of transaction.

Example: SALEPossible values:

cardstringOptional

Credit card number.

Example: 4111111111111111

amountstringRequired

Total transaction amount.

Example: 80.0

idstringOptional

Unique identifier for the transaction request.

Example: text

cscstringOptional

Card Security Code (CVV).

Example: 999

invoicestringOptional

Invoice number for the transaction.

Example: invoice123

descriptionstringOptional

Description of the transaction

Example: Transaction desc

commentsstringOptional

Additional comments related to the transaction.

Example: Paint the canoe red

software-typestringRequired

Type of software initiating the transaction.

Example: MySoftware_Version1.3

software-type-versionstringRequired

Version of the software used.

Example: text

sales-tax-typestring · enumOptional

Type of sales tax.

Example: LOCAL_SALES_TAXPossible values:

sales-tax-amountstringOptional

Amount of sales tax applied.

Example: 90.0

service-feestringOptional

Additional service fee.

Example: 2.9

signature-base-64-imagestringOptional

Base64-encoded signature image.

Example: text

tip-amountstringOptional

Tip amount included in the transaction.

Example: 0.9

authorization-codestringOptional

Code used to authorize the transaction.

Example: AC789U

purchase-orderstringOptional

Purchase order number.

Example: PO789

email-receiptstringOptional

Indicates if a receipt should be emailed.

Example: false

email-addressstringOptional

Email address of the customer.

Example: [e-mail]

customer-idstringOptional

Identifier for the customer.

Example: Customer 1234

order-idstringOptional

Unique identifier for the order.

Example: 99988d

client-ipstringOptional

IP address of the client initiating the transaction.

Example: 127.0.0.1

billing-is-shippingstringOptional

Indicates if billing and shipping addresses are the same.

Example: false

create-tokenstringOptional

Indicates if a token should be created for future use.

Example: false

token-descriptionstringOptional

Description for the token if created.

Example: text

check-fieldstringOptional

Field to be checked for validation.

Example: invoice

check-field-midbooleanOptional

Validates MID (Merchant ID) field.

Example: true

card-inquirybooleanOptional

If true, performs a card inquiry.

Example: true

secure3dstringOptional

3D Secure authentication data.

Example: text

secure3d-ecistringOptional

Electronic Commerce Indicator for 3D Secure.

Example: text

add-tax-to-amountbooleanOptional

Indicates whether sales tax should be added to the total amount used for authorization and capture

Example: false

Responses

200

Successful Transaction

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

402

Business Exception (decline, etc.)

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

post/rest/v2/mobile/transactions/forced-sale

HTTPcURLJavaScriptPython

POST /rest/v2/mobile/transactions/forced-sale HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1813

{
  "type": "SALE",
  "card": "4111111111111111",
  "amount": "80.0",
  "id": "text",
  "billing": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "shipping": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "csc": "999",
  "invoice": "invoice123",
  "description": "Transaction desc",
  "comments": "Paint the canoe red",
  "software-type": "MySoftware_Version1.3",
  "software-type-version": "text",
  "sales-tax-type": "LOCAL_SALES_TAX",
  "sales-tax-amount": "90.0",
  "service-fee": "2.9",
  "signature-base-64-image": "text",
  "tip-amount": "0.9",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[e-mail]",
  "customer-id": "Customer 1234",
  "order-id": "99988d",
  "client-ip": "127.0.0.1",
  "billing-is-shipping": "false",
  "create-token": "false",
  "token-description": "text",
  "check-field": "invoice",
  "check-field-mid": true,
  "platform-fees": [
    {
      "fee-name": "DealManager"
    }
  ],
  "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"
        }
      ]
    }
  },
  "secure3d": "text",
  "secure3d-eci": "text",
  "add-tax-to-amount": false
}

application/jsonapplication/xml

{
  "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": "[e-mail]",
    "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 mobile transaction

post

Create an authorization transactions on mobile of $1 or more using a mobile transaction token.

Header parameters

api-keyanyRequired

An access API key issued to you by Xplor Pay.

mobilejwtanyRequired

The transaction token returned from the successfulTransactionToken method of the Mobile framework.

Body

application/jsonapplication/xml

typestring · enumRequired

Type of transaction.

Example: SALEPossible values:

cardstringOptional

Credit card number.

Example: 4111111111111111

amountstringRequired

Total transaction amount.

Example: 80.0

idstringOptional

Unique identifier for the transaction request.

Example: text

cscstringOptional

Card Security Code (CVV).

Example: 999

invoicestringOptional

Invoice number for the transaction.

Example: invoice123

descriptionstringOptional

Description of the transaction

Example: Transaction desc

commentsstringOptional

Additional comments related to the transaction.

Example: Paint the canoe red

software-typestringRequired

Type of software initiating the transaction.

Example: MySoftware_Version1.3

software-type-versionstringRequired

Version of the software used.

Example: text

sales-tax-typestring · enumOptional

Type of sales tax.

Example: LOCAL_SALES_TAXPossible values:

sales-tax-amountstringOptional

Amount of sales tax applied.

Example: 90.0

service-feestringOptional

Additional service fee.

Example: 2.9

signature-base-64-imagestringOptional

Base64-encoded signature image.

Example: text

tip-amountstringOptional

Tip amount included in the transaction.

Example: 0.9

authorization-codestringOptional

Code used to authorize the transaction.

Example: AC789U

purchase-orderstringOptional

Purchase order number.

Example: PO789

email-receiptstringOptional

Indicates if a receipt should be emailed.

Example: false

email-addressstringOptional

Email address of the customer.

Example: [e-mail]

customer-idstringOptional

Identifier for the customer.

Example: Customer 1234

order-idstringOptional

Unique identifier for the order.

Example: 99988d

client-ipstringOptional

IP address of the client initiating the transaction.

Example: 127.0.0.1

billing-is-shippingstringOptional

Indicates if billing and shipping addresses are the same.

Example: false

create-tokenstringOptional

Indicates if a token should be created for future use.

Example: false

token-descriptionstringOptional

Description for the token if created.

Example: text

check-fieldstringOptional

Field to be checked for validation.

Example: invoice

check-field-midbooleanOptional

Validates MID (Merchant ID) field.

Example: true

card-inquirybooleanOptional

If true, performs a card inquiry.

Example: true

secure3dstringOptional

3D Secure authentication data.

Example: text

secure3d-ecistringOptional

Electronic Commerce Indicator for 3D Secure.

Example: text

add-tax-to-amountbooleanOptional

Indicates whether sales tax should be added to the total amount used for authorization and capture

Example: false

Responses

200

Successful Transaction

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: transaction

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

402

Business Exception (decline, etc.)

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

post/rest/v2/mobile/transactions/auth

HTTPcURLJavaScriptPython

POST /rest/v2/mobile/transactions/auth HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1813

{
  "type": "SALE",
  "card": "4111111111111111",
  "amount": "80.0",
  "id": "text",
  "billing": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "shipping": {
    "company": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "phone": "text",
    "first-name": "text",
    "last-name": "text",
    "from-zip": "text"
  },
  "csc": "999",
  "invoice": "invoice123",
  "description": "Transaction desc",
  "comments": "Paint the canoe red",
  "software-type": "MySoftware_Version1.3",
  "software-type-version": "text",
  "sales-tax-type": "LOCAL_SALES_TAX",
  "sales-tax-amount": "90.0",
  "service-fee": "2.9",
  "signature-base-64-image": "text",
  "tip-amount": "0.9",
  "authorization-code": "AC789U",
  "purchase-order": "PO789",
  "email-receipt": "false",
  "email-address": "[e-mail]",
  "customer-id": "Customer 1234",
  "order-id": "99988d",
  "client-ip": "127.0.0.1",
  "billing-is-shipping": "false",
  "create-token": "false",
  "token-description": "text",
  "check-field": "invoice",
  "check-field-mid": true,
  "platform-fees": [
    {
      "fee-name": "DealManager"
    }
  ],
  "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"
        }
      ]
    }
  },
  "secure3d": "text",
  "secure3d-eci": "text",
  "add-tax-to-amount": false
}

application/jsonapplication/xml

{
  "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": "[e-mail]",
    "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"
}