Information for Software Providers

Managing Your Software's Integration with Xplor Pay's Vault

How do I store cards in Xplor Pay's Vault?

Xplor Pay’s Quest platform offers a robust API for securely storing card data in our Vault. By storing tokens instead of actual card data, you significantly reduce your PCI scope. The Quest API allows you to pass a token ID in place of a card number when processing a transaction.

You can find our API documentation, including request and response examples, here.


Can I use tokens from a previous processor with Xplor Pay’s API?

Yes. If you’ve stored tokens with another processor, Xplor Pay enables you to continue using them after migration. Many processors offer token data export options. Merchants can request that their existing processor send this data to Xplor Pay for secure import into our Vault by contacting the existing processor's support team.

Xplor Pay will import the tokens, generate new token IDs, and map them to the original legacy token IDs.


What does the token transfer process look like?

Xplor Pay’s Application Support team coordinates with the previous processor to securely complete the data transfer. The typical steps include:

  1. Merchant notifies Xplor Pay, their ISV, and the previous processor of the intent to transfer token data.

  2. Xplor Pay creates an SFTP account for the processor and provides a PGP public key for encryption.

  3. The processor exports the data, encrypts it using Xplor Pay’s PGP key, and uploads it to the SFTP account.

  4. Xplor Pay downloads/decrypts and imports the data into our Vault.


How long does the transfer process take?

Export turnaround times vary by processor. They should provide an estimated timeframe when the export request is submitted.

Once Xplor Pay receives the token data file, we will complete the import into our Vault within five business days.


How do I use legacy tokens after they’ve been imported?

You have two options:

1

CSV Mapping File

Xplor Pay can provide a CSV file containing:

  • New Xplor Pay token ID

  • Corresponding legacy token ID

  • Card type

  • Expiration date

  • Last four digits of the card number

  • Merchant ID

  • Street address

  • ZIP code

You can use this data to replace the legacy token IDs in your database with the new Xplor Pay token IDs.

This is an example of the data file:

"clearent_token_id","legacy_token_id","card_type","card_exp_date","card_last_four","merchant_id","avs_address","avs_zip"
"1100005163794211268","aaaaaaaaaaaaaaaa","VISA","0623","1268","000001234567","123 Main Street","90210"
"1100003225094130286","bbbbbbbbbbbbbb","DISCOVER","0224","0286","000001234567","",""
"1100005821233683924","cccccccccccccc","AMERICAN EXPRESS","1221","3924","000001234567","","63141"
"1100005281083133682","ddddddddddddddd","MASTERCARD","1025","3682","000001234567","987 Payments Dr.","84020"
2

Continue Using Legacy Token IDs

You can continue using the original legacy token ID for transactions. To do this, include the "merchant-legacy-token": true parameter in your request body. This instructs Xplor Pay to look up the new token ID using the legacy token before processing the transaction.

Example:

{
  "type": "sale",
  "amount": "25.00",
  "software-type": "My Super Duper Point of Sale",
  "software-type-version": "2.3",
  "card": "16ab65d8-f915-4a10-a89b-b8b442a0cd27",
  "exp-date": "0524",
  "merchant-legacy-token": true
}

What if I still have questions?

We’re here to help.

  • If you’re still in the integration phase, feel free to ask questions in your dedicated Slack channel.

  • If you’re in production, contact our technical support team at 1-866-435-0666 and select option 1.

Last updated

Was this helpful?