Migrate payment methods to Rainforest
Migrate previously-stored payment methods from other processors to Rainforest
Your merchants can request a migration of previously-stored payment methods from other processors to Rainforest. This will ensure that there is no impact to your users payment functionality during the migration to Rainforest. The migration process will differ per processor and Rainforest will work with your current processor to ensure all payment methods are migrated to the Rainforest ecosystem.
Rainforest will begin to process the import within 2 business days of receiving the migration data if the processor is on the following list:
Migrations from all other processors will be processed within 10 business days of receiving the migration data.
Migrate from Stripe
Request migration from merchant
The following document is a template designed to be branded as the platform and provided to merchants as part of the migration plan. The form should be reviewed and updated to reflect your brand and references. All yellow highlighted text within the template should be replaced with platform specific text.
Stripe data migration merchant template doc
Forward the migration to Rainforest
Once the merchant requests the migration from Stripe, they will receive an email from Stripe with the subject line:
Stripe export migration request {Merchant Name} (acct_XXX): migreq_XXX
The merchant should forward this email to you, and then you should forward this email to Rainforest at [email protected].
Do not alter the Stripe email
The subject line and contents of the export migration email should not be altered and must contain the exact contents from Stripe.
Rainforest to complete migration
Once Rainforest receives the Stripe migration, we will import the payment method data.
Webhooks
You can configure webhooks to listen to the payment_method.active
event. Rainforest will include the Stripe import information in the payment method's metadata
field:
{
"payment_method_id": "mtd_2wW7nOHfKV4Hk22rAqExtxLm4Pg",
// ...
"metadata": {
"stripe_import": {
"customer_id": "cus_EYLfV8O6we3rnb",
"description": "Jane Doe",
"id": "pm_1QxdT3BsBBqp73esI2eFfwa7",
"migration_request_id": "migreq_2wmEKs1qSlKJCUt0ryeoCZjI72s"
}
},
// ...
}
CVS Export
After the migration is complete, Rainforest can export the migrated payment methods, upon request.
Migrate from Square
Request migration from merchant
The following document is a template designed to be branded as the platform and provided to merchants as part of the migration plan. The form should be reviewed and updated to reflect your brand and references. All yellow highlighted text within the template should be replaced with platform specific text.
Square data migration merchant template doc
Provide additional information to Square
Once the merchant requests the migration from Square, Square will assign a Square Developer to complete the migration. They may ask the merchant for Rainforest's PCI AOC documentation. If they do, please reach out to Rainforest at [email protected] to receive the documentation.
Rainforest to complete migration
Square may take up to 2 weeks to complete the export of the payment method data and will work directly with Rainforest to complete the migration. Once Rainforest receives the Square migration, we will import the payment method data.
Webhooks
You can configure webhooks to listen to the payment_method.active
event. Rainforest will include the Square import information in the payment method's metadata
field:
{
"payment_method_id": "mtd_2taWoHnUpWXbUkEcpBrHTDQo5fb",
// ...
"metadata": {
"square_import": {
"customer_id": "ZAJ72GMDDN2JN7T8VX6KSRMCER",
"export_id": "MXP298WDQH3GN7D08ZR",
"id": "icard-QEMN8SfEnpk8BysM4GB"
}
},
// ...
}
CVS Export
After the migration is complete, Rainforest can export the migrated payment methods, upon request.
Migrate from other processors
For other processors, please reach out to the processor and ask for their process to export payment method data to your new payment provider.
The processor will have a process to encrypt the data utilizing Rainforest's PGP Public Key and instructions on how to complete the migration. This ensures that the payment method data is securely encrypted and only Rainforest has the ability to access the PCI and PII data. Please send these instructions to Rainforest to [email protected].
Once Rainforest receives the migration, we will import the payment method data. Import may take up to 10 business days to complete from a new processor.
Webhooks
You can configure webhooks to listen to the payment_method.active
event. Rainforest will include the Processor import information in the payment method's metadata
field:
{
"payment_method_id": "mtd_2taWoHnUpWXbUkEcpBrHTDQo5fb",
// ...
"metadata": {
"{processor name}_import": {
"customer_id": "",
"export_id": "",
"id": ""
}
},
// ...
}
CSV Export
After the migration is complete, Rainforest can export the migrated payment methods, upon request.
Migrate from your platform
If your platform is currently storing PCI data, Rainforest has two options to migrate the payment methods.
- Receive temporary access to the API to create payment methods
- Provide a CSV export of the payment method data in a specified format
After the migration, you should remove all PCI data from your system.
API
Rainforest will provide temporary access to the create payment method endpoint to store the card and ACH data in Rainforest's system. See the store payment methods via API guide for additional details.
CSV Export
Export the payment method data to a CSV in the following format:
field | description |
---|---|
id | Identifier from the platform's system. It will be included in the payment methods metadata. |
card_number | The card number, formatted with no spaces (e.g 0000000000000000). Must be set for a Card payment method. |
exp_month | The card expiration month, formatted MM. Must be set for a Card payment method. |
exp_year | The card expiration year, in 4-digits. Must be set for a Card payment method. |
account_number | The bank account number. Must be set for an ACH payment method. |
routing_number | The 9-digit routing number. Must be set for an ACH payment method. |
account_type | The account type, CHECKING or SAVINGS. Must be set for an ACH payment method. |
account_holder_type | The account holder type, PERSONAL or BUSINESS. Must be set for an ACH payment method. |
Email address. | |
phone | Phone number, including extension, formatted as +{country_code}{area_code}{7_digit_number} (i.e. +14041231234). |
name | First and last name. |
address_1 | First line of street address. |
address_2 | Second line of street address, if applicable. |
city | City for address. |
state | State, province, or region for address. |
postal_code | Postal code or ZIP code for address. |
country | 2-digit country code. Find country codes here: https://www.iso.org/obp |
metadata | Valid JSON key-value object to store additional information on the payment method. Key platform_import is reserved for Rainforest and will be merged on top of any metadata set in the CSV. |
All fields should follow the requirements outlined in the create payment method endpoint.
Utilize Rainforest's PGP Public Key to encrypt the CSV file and send to Rainforest at [email protected].
Example CSV
id,card_number,exp_month,exp_year,account_number,routing_number,account_type,account_holder_type,email,phone,name,address_1,address_2,city,state,postal_code,country,metadata
123456789,,,,4433221100,1234567,CHECKING,PERSONAL,[email protected],+18508675309,Jane Doe,123 Main Street,,Atlanta,GA,30308,US,"{"customer":"data","goes":"here"}"
Rainforest to complete migration
Rainforest will begin to process the import within 2 business days of receiving the migration data.
Webhooks
You can configure webhooks to listen to the payment_method.active
event. Rainforest will include the Platform import information in the payment method's metadata
field:
{
"payment_method_id": "mtd_2taWoHnUpWXbUkEcpBrHTDQo5fb",
// ...
"metadata": {
"platform_import": {
"id": "123456789",
"export_id": "2wow4mJ43zWBJUCd3ge6Dt94cHA"
},
// additional metadata passed in the metadata column
},
// ...
}
CVS Export
After the migration is complete, Rainforest can export the migrated payment methods, upon request.
Export migrated payment methods
Once Rainforest completes the migration, we can provide a CSV export with the following data to associate the processor's tokens with the Rainforest payment methods:
Column | Description |
---|---|
Source Method ID | The processor identifier |
Source Customer ID | The processor customer identifier, if provided. |
Source Method Type | The payment method type, CARD or ACH. |
Rainforest Payment Method ID | The Rainforest unique payment method identifier. Prefix is "mtd". |
Rainforest Payment Method Fingerprint | The Rainforest unique identifier of the payment method data. If the same card or ACH data is stored multiple times they will have the same fingerprint. |
Note: some processors may only provide a single identifier for the payment method and may not provide an additional customer identifier.
Updated 3 days ago