Open navigation

Orange CRM Configuration Guide


The purpose of this guide is to provide Orange CRM users with guidelines for setting up FlexPay.
By following the outlined steps, you will have correctly configured your Orange CRM system allowing transactions to process correctly between your CRM and FlexPay. Of course, each user has their own unique way of leveraging their CRM, the guidelines below should assist you in respecting your internal processes while getting the best out of FlexPay.


You have received your FlexPay login credentials and your SFTP is already set up. If you have not received these yet, just reach out to your FlexPay Client Success Manager. 

Main Points of Configuration:

  1. Banking: You will need to add a new merchant bank specifically for FlexPay.
  2. Scheduled batch drops: Creating your batch job schedules to make sure that transactions are sent to FlexPay and returned to your CRM.
  3. Default Retry logic: There may be product-specific retry limits configured into the acquisition center. You will need to align these with FlexPay limits in order to allow the transaction to be efficiently recovered.


Merchant Banks:

  • Click on Add Merchant Bank.
  • Select your program from the drop down menu.
  • Create your FlexPay bank name under the name field. e.g. Product 1 FlexPay.
  • You will only be needing one merchant bank setup for all merchant gateways per program.

Setup Tab:

If fields are not listed here, please leave the field as default.

Orange CRM FieldDefaultFlexPay Setting
Bank APIblankFlexPay
Batch ModeblankFile Transfer
Batch Namedepends on the name given to merchant bankCreate a coherent name for the batch job being generated each day.
Bank Token[company code]This code is created in FlexPay when you add a "company" to your FlexPay account.
Bank Currency

USDSelect your currency

Processing options section:

If fields are not listed above, please leave the field as default.

Orange CRM FieldDefaultFlexPay Setting
Assign Customer ToEnableChoose FlexPay Bank Route **
1. Create a FlexPay Bank route - see how to create a bank route below as the full setup may require the FlexPay Merchant bank to be fully setup
2. Within the bank route, assign CASH and FlexPay merchant bank
3. Assign customer to FlexPay bank route
AVS SendEnableEnable
AVS Retry DeclineDisableEnable
AVS Trans FilterAll TransAll Trans

** Create a FlexPay Bank Route:

  1. Create a FlexPay Bank route directly from "Assign Customer To"
  2. Within the bank route, assign CASH and FlexPay merchant bank. You may have to do this directly from Bank --> Bank Route (and not from the merchant bank)
  3. Assign customer to FlexPay bank route

Note: Make sure that for inactive acquisition centers to set FlexPay up the acquisition center round robin and make them temporarily active so that it picks up transactions from this acquisition center. If all of the above steps are not followed, transactions can get stuck "in queue".

Gateway Response Codes:

Orange will properly auto-fill these.


File Delivery and Pickup:

If fields are not listed here, please leave the field as default.

Orange CRM FieldDefaultFlexPay Setting
Local Out Pathftp\FlexPay\Reflect your internal file transfer paths in the CRM (could very much be same as default)
Local In Pathftp\FlexPay\response\Reflect your internal file transfer paths in the CRM (could very much be same as default)
FTP SendDisableEnable
FT Port2222 (unless requested differently)
FTP User Nameblankwill be securely sent by FlexPay agent
FTP Passwordblankwill be securely sent by FlexPay agent
FTP Put PathInputs/Inputs
FTP Get PathOutputs/Outputs
FTP Get Filter*.**txt

Limits Tab:

If fields are not listed here, please leave the field as default.

Orange CRM FieldDefaultFlexPay Setting
Limits Apply ToAll TransactionsAll Transactions
Retry Day Interval71
Retry Max Attempts315
Single Batch LimitsEnableEnable
Sale/Capture, Auth only, Refund25000000.00 / 250000.00set these at your maximal value limits to ensure all transactions are sent to FlexPay
Retry Count Min/Max0/00/15
Batch Max Trans10000 - maximal amount of transactionsLeave defaulted *Note: when in test mode, would be good to reduce batch max trans to 1-5 transactions.
Batch Max Errors1000015
Batch Max Timeout99
Batch Max Minutes240240

You can configure the Daily Limits and Monthly Limits sections if there are existing limitations to how many transactions can be sent to FlexPay per day or month only.

Credit Cards Tab:

  • Enable the cards types which you are processing. Deposit bank should be "undeposited funds".
  • Set all Batch related to the field to their maximum capacities.
  • As there are no transaction fees within FlexPay the fee settings can be left at 0 values.

Acquisition center:

Billing Plans tab - specific initial fee schedule:

If we are processing the initial transaction of a client then the retry count will need to be adjusted here to ensure it is allowed to go through all of FlexPays attempts. Retry Amount/Attempt: Make sure retry attempts are at 15 minimum.

Batch Job Schedule:

  • From Merchant Bank Setup: Batch Jobs [Menu]->Click on the [NEW Batch Job] button. Follow parameters that best suit your internal processes.
  • Make sure that the new Batch Job is on the same queue as other batch jobs for that program, and follows the execution time.
  • There is a second batch job to verify or create, if it does not already exist, for the instance of Orange CRM you are working on. Each instance of Orange requires one FlexPay Import job to be created.
Orange CRM FieldFlexPay Setting
ServerSee your internal administrator
QueueSelect the queue on which the program was originally transacting
Job APIFlexPay Import
DescriptionFlexPay Import
Execution TimeSee your internal administrator
Time Interval1 day 

FTP Access:

Each CRM instance will need a folder named "FlexPay" in its Orange FTP server. Don’t forget to create this folder as this is where data gets posted from Orange to the server. 


Testing as such is not a required step as we have already done all the hard work for you with your CRM provider, however, you may wish to gradually increase traffic flow to FlexPay as you familiarize yourself with the platform.
A great way to test is doing the same steps that you would be doing to go live, however limiting the limits (as mentioned above), and process very few transactions. It is recommended that you do this by limiting the number of transaction per batch and slowly increase it at your own pace. For example, you may wish to send $5K of transactions on day one, then $8K on day two etc. If you do testing, please make sure to revert your settings (i.e putting the number of
transaction per batch back to agreed number). 

Going Live

Technically you are already live, however, you are now ready to send all you transactions to FlexPay and no longer wish to divert to other bank routes.

  • Under the limits tab in the FlexPay Merchant Bank, increase your amounts sent by batch to their maximum values.
  • Configure your pre-existing bank routes to refund only. (DO NOT DISABLE THEM).
  • Bank Assignments: The bank assignments will need to be rerouted so that your transactions all route to FlexPay. The "Assignments" tab is on the top right hand of your Merchant Bank screen. Go to the bank which you have set to "refund only", select the existing bank name by double clicking on them and re-select the FlexPay route. When you refresh there should be no more bank routes left in the dialogue box. Click save. Open your FlexPay bank route, all the routes will now be populated in its "Assignments" tab.

Upon the next batch run, your transactions will now be pointing to FlexPay.

And now you are ready to go!

Nic is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.