Skip to main content
Skip table of contents

Use Case: Import Custom Payment Tokens from Another Platform

You can work with Payrix to import tokenized payment methods for your Merchant’s customers from a pre-existing payments processor as part of your migration process. This time-saving step can help you transition quickly from another payment platform to Payrix as a seamless experience for your Merchants and their customers. This tutorial will walk you through the steps to perform the secure, one-time migration of your Merchants' customer payment tokens.

Objective

Migrate your existing customer tokens from another processor to Payrix.


Audience

  • Referrers

Environment

N/A


Prerequisites

Prerequisites:

  • You must have a fully boarded Payrix account to perform any of the actions described in the use case guides.

  • You must have the legal authority within your organization to initiate the transfer.

  • The entity level(s) for each of your existing tokens (user or merchant).

  • An encrypted SFTP server to facilitate token files transfers by you or your existing processor.

Warnings

Warnings will provide insight or advice to avoid risk, visibility, and product performance issues during this use case.

Warning: Token migration requires coordination with the existing processor and Payrix operational teams. This process cannot be performed independently.

Tips

Tips will provide suggestions to streamline or better prepare you to apply this use case tutorial.

Tip: You will be notified once the import has been completed. At that time you can request GET /tokens for the existing processor tokens to determine the new equivalent Payrix Token IDs.

Tip: Request a copy of Payrix’s most current Attestation of Compliance (“AOC”) and/or Report on Compliance (“ROC”) from your relationship manager before beginning the process to streamline the process of legal verification from your existing processor.

Additional Resources

Payrix Public PGP Encryption Key
CODE
-----BEGIN PGP PUBLIC KEY BLOCK-----

mQINBFtWLsQBEAC4fChHoRZWzaRZsbiaGOJuf1uw3WwddiMfuWEJkVhjfr3tdfjX
mCfpqiB78iI3soMTYUpby3Ge9L3WgNidyZ9QcnWnP+6JC1q04U8+lte+yjYzOdgw
fKWetk9lbjGlXQ/0ORVutV2f8VamrEJRQq0zehyqwCCMFjTfT0jSkmL9uG9cKvtI
a/bhbYz201s27NCogDDYxZ+Qj8o2mFm4CM/fvQ+pJPauLu/wtxRsJDrPzIBmgpKD
s8lk/aAt4mnUTLB+4iYwvE7YDG9G6g1V7Jj31J7KDImPEnVruIm5aTTVD/3HPExa
/U1Vk14gCfgR4/3mMaukhbolu0DqFlmXzuXplIo5CGEHWCL0fVg3KL/ocMtHPzEU
Dsk6zH28s7YqYVwnJOX0OogSwWNiTGjR7fCaPtEtPawbQHY5UPKJ+8NShv5abeWf
UZfB232ZPprT53wWYU5ELcgicAIvz7bfr5UOonr28KeLB86Cf6jgCHqsR4uqZDVf
bhh4GJ5fgJfv7DCJ7OMQSOWDfSzfVLJWz2mhvbMR0oELVzt90OEImhYHZda3So+2
ws3VmS4C8/72m1m5UPn5n592Jh1+eOnq7FiIa2roCMQafEwcpQHnk7qcNptMWfz8
1eormZ53UWj2IC1D9LxNMtHSpG8Cf9USGUWP5yzVpczmqCTPC7tTikI/uwARAQAB
tA1wYXlyaXhfc2VjdXJliQJOBBMBCAA4FiEE3nCWHaDvntpm4idFZTx1BjeCUZYF
AltWLsQCGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQZTx1BjeCUZY9Bg/+
LWURdlIDQhl2F49RC21n1DDXcNlHEjS3PLul24BTkSaFBHpBd2othnLQ7KpC8HbV
F4K0uc5FlcV7qHXYXTkZsNki+IXTSC7dtf80uErlNvNxfzKjCuX+b8hLF9C2oaJk
ddIvpRg04YecSRoPUeFP8SnWVTC+wwDczE6hOdpMEL3W4fl/spwm6A6AaB0hjhIS
m6zNZl0vlWFlTnNwujVb24DQMr8GifIPCWcXVu+SY4i895JLWSCKNAd7FBXuGNk4
rm8wD8DY+yWh55zwwomYe/EkLgv98I/RG4A0hNK0r0aGFjJin6S74iZ+TT4TOTOc
edq9dzG6PTSwvAnwxIwF3ID8BsHHxtwzzdTArNUinM2exgYYpei7ttk/1pw7VIFO
dbnVqVdq2lIy9PBLMQxw0XArgesvFXpTjGcu/2+nykIoIcz/sTCU4Q79U0Hex/tJ
4rRu44M0UffnEtPyUl8Sd4fVXzFcHEio+SmjPTvvWvsg9Xs9/1TZaBLn/6y+hU1l
kjbCbF8BtPGvFgirGlNkwQxdzkZ9SUp+V7l1vC9DA1oa535gA/nuQHDKoZpPuymz
nTPETilFbjw1ZEpndZtnxE4wT4zcnQ5ZUi74/fT7HhBfzOj38i+IoKb3Ltjb2vnI
x1B9+K+TTLr5XYWXDOJDBjeOI1ri3C2Psl0zyCchrta5Ag0EW1YuxAEQAM1WL6EW
vJyWzGN8iwzW6vGEyZGAVToGicBTOaMHv5g2fCZz/lyb8mxAE9s5cvk+/w0CMjaT
IS/mfcYdkISjJZVRdLWP/bXv+MgIL4sVTPiNNT4RSWedPDfiUQ2Fks+QWV3NgvND
V8ojMSg17wxO2JXNX489GElcsJ20XUNlzrgfimtyPcNhvOBg21BJ68xwfPT7aoF5
ZHQrT2lzT8M55y0XcHgyih3SiasWTZ+EMZKbmb35MnLcgaMvn3ayfvhKrbladghH
2DpvyRFZPVgF26Z/cKeuns7adGbrzjOFszuFAyVVbzyYn5v34wASjD7F+qm5ykSO
SE2L0EPAtztIrdgGWskeLcFbG0nKHXz96oj5xlYcuMXs0vrtM7SBKPB9v/qegY2d
X1+JXB5vJTcOB3zOOeb3CtoH958W1yImvfQKx/MsnO6h2YFXk9NMJT5OV5DjmWdF
yrlohTCsBbAk0xevgCMZa3mSC7E+fo0sp2BpJ0Hp+U55wYtpzDN1NJR0qdWZWa/n
vA07kGBCFRA7UkC5rvj27LtyUSib8wkh9XSkxJLELjwbgCzG1eH3OIrGtsGXgbtn
4K/4Bh23se7XVjqEFnkN6DUFyhgioeftJ1Wx+TphfjVznUCMaSkDjeAa7AIQ3Fgz
WQ3wJgk7Qz7BMtyO2dqBi0YheHVum6t+4FAfABEBAAGJAjYEGAEIACAWIQTecJYd
oO+e2mbiJ0VlPHUGN4JRlgUCW1YuxAIbDAAKCRBlPHUGN4JRlitzEACK+JGMWaZ3
1w9Aq3x+pWDztnQn8WZnAFiNzNdL8zTZCOT3Ty1Bl5INisz1SDZGnyPRJSjmZRWp
CLHZrkTRhUpxq/2sapcMTT6DnC9X5JcPnomGudBhhOsA0KH7BhgY0G8PTIz91Nbq
Ystt97qb3heobl+x+TyLFiLyHyVfW4QR5cc/SNE+H2y43VFnWhhqlRIUGW0JpUbg
blEmOAOTK8OyjDwM/BwgISAl96ucaDWIhMhFIFnxdnNM3fZ2jjfLKeMGDQzofzhp
iPdV01TfPQ2QVEkrOKZQi1FVSyQrlAZyvoMRdYXe/NZFv1bi8poJ5gO8ceq93CbZ
+fmoaflifZjHs8LqT45MIgn3Lm4+MoIdVuPYiM8qvMr0ZmHp7XkMt8Rm8OjXPlvT
YIMM9dzycff0sjJ7Fwv0L9icGO+3T3plFrOkaHIw2JPoJhhknlfcD5m2meFg9ARd
jdRMnRrBgDEkgnKZ9f3/fYsFJU7EGOkh858oLwUWoVFDML11fH4oUXeAmbE0TJnK
CNgbcsk1Jc8fTgcLMzSRd4gz5moJ0QnmW8U241PfxW0X/2cmMXuaHefCdHkrs7k5
5ISnY9T/u4PUh93evaarUiw8CdHyO2uGJgEMKP8B4wThV/gGdhi7uKEBGi6+RZHk
tx/bUvZN0mR+RQkpkyiGmAAB82wUPpQFEg==
=Y0mE
-----END PGP PUBLIC KEY BLOCK-----

Importing Existing Tokens

1. Submit a Token Transfer Request

Submit a formal request to extract and transfer your existing tokens to Payrix.

Example Token Transfer Request Letter & Email

[Your Company Name]
[Your Address]
[City, State, Zip]
[Date]

[Processor Representative Name]
[Processor Company Name]
[Processor Address]
[City, State, Zip]

Subject: Request for Token Transfer to Payrix

Dear [Processor Representative],

I am writing to formally request the transfer of tokenized customer payment methods from our existing processor, [Processor Company Name], to our new processor, Payrix (WorldPay).

Reason for Transfer

Our decision to transition to Payrix is driven by [insert reason(s)]. We believe this change will significantly benefit our overall payment processing experience.

Technical Requirements & Legal Compliance

A Payrix representative will reach out to you to request the extracted token data in JSON file format or discuss another format that can be used for extracted token data, as well as the protocol to securely transfer the data using their public encryption key.

To help streamline the process, the Payrix representative can provide you with the current Payrix PCI Attestation of Compliance to ensure adherence to legal regulations.

Thank you for your attention to this matter. We appreciate your cooperation and look forward to a successful transition.

Sincerely,

[Your Name]
[Your Position]
[Your Contact Info]

2. Map the Token Data

Once your tokens have been successfully submitted from your existing processor to Payrix, Payrix will import and map each token to a new Payrix Token ID & Customer ID with associated customer information and related custom field data.

3. Link Tokens to their Associated Merchants

  • Step 1: Review your newly exported tokens, assigning them to their respective Merchants with the following information:

Token Import Data

Description

Merchant Name

The name of the Merchant who created and uses the token.

Merchant ID

The Payrix Merchant ID for the associated Merchant.

User Login ID

The Payrix User ID determining whether the account is a Referrer or Merchant

Import Level

Whether the custom field data is mapped to the Merchant account or one Merchant user.

Original Processor

The existing processor’s name and information.

File

The existing Token file, attached or linked from a Secure File Transfer Protocol (SFTP) server.

  • Step 2: Submit a request to your Payrix representative to import the newly exported tokens, assigning them to their respective Merchants collected information above.

Example Import Request Email

Hello,

Please complete a token import request for this merchant. Token transfer information is below.

  • Merchant Name: Beverly’s Salon

  • Merchant ID: t1_mer_abcxxxxxxxxxxxxxxxxx

  • User Login ID: t1_log_123xxxxxxxxxxxxxxxxx

  • Import Level: Merchant

  • Original Processor: GreatPay

  • File: [One or more SFTP links to tokens associated with this Merchant.]

Result: You have now successfully migrated your Merchants' customer payment tokens. These tokens will now be available for use as saved payment methods for customers, receiving new Payrix-generated IDs for each Token and Customer respectively, and then each is assigned to their associated Merchants.


Next Steps

After successfully importing the existing payment tokens, review the following use case guides for additional information on related topics:


Conclusion

You have now successfully imported your existing customer payment tokens for use in future transactions on the Payrix platform.


References

Click the links or items below to access any of the following pages:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.