Creating and Editing PayVia Options and Dump Formats
Creating A PayVia Type
- In the Payments Admin, click the Pay Via Options tab, enter a name into the "New Pay Via Option" text box (at the bottom of the page), and click Add.
- Fill out:
- Pay Via Description: what affiliates will see as the name of the pay via type
- Allowable 'Minimum Payout' Choices: A comma-separated list of available minimum payout options for affiliates.
- Cost Per Payout: The fee to charge affiliates per pay out sent. Make it zero to disable cost or make it negative to give affiliates a bonus for each payout.
- Dump Format to Use: Choose the appropriate dump format to use (explained later)
- Click save
Editing Pay Via Fields
Click the Edit PayVia Fields button. From here, you'll be editing the pay via type's structure. You can add a new field to the structure by filling out the row and clicking Save.
- Name: The name of the field as shown to affiliates (ex: ePassporte ID)
- Type: Choose to display a text box or a multiple choice selection
- Required: Whether or not the field is a required field (ex: for the ePassporte ID, if it's not required, how would you pay them?)
- Minimum: The minimum length for the field (ex: 1)
- Maximum: The maximum length of the field (ex: 16)
- Unique: Prevents multiple affiliates from using the same value for this field
- Check Function: Validate input using this function. Use NONE to disable validation.
The four Action icons next to a field let you edit, remove, or change the order the options appear on the affiliate's sign-up form.
Pay Via Dump Formats
Dump formats are used to format and display your payment after they've been stored. Go to Payments Admin and click the Dump Formats tab to view the current dump formats. Create a dump format by typing in the name under "New Dump Format" or you can edit an existing one by clicking the Edit icon next to it.
Dump formats have the following sections:
- Name: the name of the dump format
- Dump Header: This is displayed at the very beginning of the dump.
- Entry Header: This is displayed before the affiliate's payment.
- Entry: This is the affiliate's payment
- Entry Footer: This is displayed after the affiliate's payment
- Dump Footer: This is displayed at the very end of the dump.
All the fields that you created in the PayVia form are available here, but with different names. Starting with the name you gave the field, the name is:
- prefixed with "$affiliate.payvia."
- all spaces are changed to underscores
For example, the "User ID" field becomes {affiliate.payvia.User_ID}.
The easiest way to create your own dump format is to duplicate a similar format and then make the necessary changes. NATS4 currently ships with more than 20 formats, so finding a similar format should be easy.
See Also
- Payment Dump Entry Numbers -- Adding entry numbers to your payment dumps
