You can create batch deployments from a CSV file upload. The batch deployments functionality is controlled at a Card Pool group level, and will not be visible unless you have it switched on by Visa Commercial Pay support. Contact Visa Commercial Pay support if you wish to have this functionality enabled.
-
Click More and then click Batch deployments from the dropdown.
-
Click Download sample file and open the CSV file from your device.
Clicking Download sample file will download a sample file named 'batchdeployments.csv.' Open this file to see an example of the information and format required to bulk upload deployments.
Clicking Download Card Pool list will download a sample file named CardPoolsList.csv. Open this file to see a list of the Card Pools available and the client ID associated with each Card Pool.
Remember
Copy the ClientID for the Card Pool you want to use from the CardPoolsList.csv and paste it in the ClientID column (column C) in the Sample File.
If you do not enter the ClientID correctly, you will receive the error message "Error creating deployment No cardpool found for client".
Enter the dates that you want the cards to be active for in ChargeStartDate (column I) and ChargeEndDate (column J). If the dates are not set correctly, you will receive the error message "Error creating allocation".
-
You will need to upload a file containing the details of the deployments. The deployments will be created from the Card Pool linked to the Client ID that you enter in the Client ID column. Any individual deployments in the batch that exceed the deployment amount will go through the usual approvals process.
Once you have added the details of your deployments to the file, click Choose file.
-
The file must be in CSV format and not exceed 1 MB
-
The first line must contain the column headings
-
Any values may be enclosed in double quotes ""
-
Where values contain commas, they must be encased in double quotes ""
-
-
Once the file is uploaded, click Upload.
Note
The Upload button will remain unavailable until a file in the correct format has been selected.
When the file has been processed, the results will appear on the page with the following information:
-
ID—the unique identifier for the batch deployment file upload.
-
File name—the name of the file that was uploaded.
-
Date of upload—the date the file was uploaded.
-
Uploaded by—the username of the user that uploaded the file.
-
Status—a green circle indicates that the file was correctly processed. The text status indicator specifies if the deployments were created successfully:
-
Completed—no deployment failures.
-
Completed with deployment failures—some or all deployments failed.
-
-
Row count—the number of rows that contained deployment details.
-
Deployment count—the number of successful deployments.
-
Failure count—the number of failed deployments.
Click on the batch deployment upload to view additional details:
-
Index—the file row of the deployment.
-
Created date—the date the deployment was uploaded.
-
Error code—the code for the specific error.
-
Error message—details of the deployment failure. This column is blank for successful deployments.
-
Deployment ID—the deployment ID of the created deployment. Clicking this will take you to the Deployment details page for that deployment.
Note
Code 100 in the error code column indicates a successful deployment.
-
You can view and manage previous batches from the Batch deployments page and re-upload a batch if a failure occurs. Re-uploading the batch does not remove the previously failed uploads from the list.
|
Field |
Description |
Format |
Quoted |
Max Length |
Mandatory |
Example |
|---|---|---|---|---|---|---|
|
SequenceNumber |
All deployment requests must be sequentially numbered. This is used for index purposes to reference the row. |
Numeric |
N |
8 |
Y |
1 |
|
ConsumerReference |
A unique reference provided for the Deployment. |
Alpha-Numeric |
Y |
50 |
Y |
REF1234 |
|
ClientID |
The unique identifier for the Card Pool. |
Numeric |
N |
10 |
Y |
654987 |
|
Type |
Details what type of Deployment is being made. |
Alpha |
Y |
20 |
Y |
Generic |
|
Amount |
The Deployment amount required. Decimal only excluding any symbols or currency. |
Numeric |
N |
10 |
Y |
95 |
|
Currency |
3-letter ISO currency code. This is not a currency conversion, the balance will be linked to the Card Pool currency. |
Alpha |
N |
3 |
Y |
GBP |
|
InvoiceAmount |
Used only when the purchase amount is different to the amount needed on the card. |
Numeric |
N |
10 |
N |
100 |
|
InvoiceAmountCurrency |
3-letter ISO currency code. |
Alpha |
N |
3 |
N |
GBP |
|
ChargeStartDate |
The date the card needs to be available from. |
yyyy-MM-dd |
N |
10 |
Y |
2024-05-01 |
|
ChargeEndDate |
The date the card needs to be available until. |
yyyy-MM-dd |
N |
10 |
Y |
2024-05-08 |
|
CustomerID |
A consumer defined Customer Identifier. |
Alpha-Numeric |
Y |
50 |
N |
APPINK01 |
|
CustomerName |
A consumer defined Customer Name. |
Alpha-Numeric |
Y |
50 |
N |
Test Company Inc |
|
NotificationEmailAddress |
Email address used for any status communications e.g. payment failure notices. |
Valid Email Address |
Y |
myemail@email.com |
||
|
SendPaymentEmail |
User should provide 1 to issue email to SupplierEmail, 0 to not. |
Numeric |
N |
1 |
Y |
1 |
|
SendPaymentFax |
User should provide 1 to issue fax to SupplierFax, 0 to not. |
Numeric |
N |
1 |
Y |
0 |
|
SupplierIdentifier |
User’s unique identifier for the Supplier. Note: When using Bank Transfer this must match an existing Supplier record. |
Alpha-Numeric |
Y |
50 |
N |
ABC1234G |
|
SupplierName |
The name of the supplier taking payment. |
Alpha-Numeric |
Y |
100 |
N |
My Supplier Ltd |
|
SupplierAddress1 |
Suppliers address line 1. |
Alpha-Numeric |
Y |
100 |
N |
Suite 10 |
|
SupplierAddress2 |
Suppliers address line 2. |
Alpha-Numeric |
Y |
100 |
N |
5 Green Road |
|
SupplierCity |
Suppliers city name. |
Alpha-Numeric |
Y |
100 |
N |
Capital City |
|
SupplierPostalCode |
Suppliers postcode or ZIP code. |
Alpha-Numeric |
N |
30 |
N |
CP 1TY |
|
SupplierCountryCode |
2-letter ISO country code. |
Alpha |
N |
2 |
N |
GB |
|
SupplierTelephone |
Suppliers telephone number. |
Alpha-Numeric |
N |
30 |
N |
0161 123 4567 |
|
SupplierFax |
Suppliers fax number. |
Alpha-Numeric |
N |
30 |
N |
0161 123 4567 |
|
SupplierEmail |
Suppliers email address. |
Valid Email Address |
Y |
100 |
N |
suppliersemail@email.com |
|
SupplierReference |
Supplier’s purchase or confirmation reference for the deployment. |
Alpha-Numeric |
Y |
50 |
N |
REF2134A |
|
DiscountOptionLevel |
Flag to indicate at which level the discount or fee percentage is applied: account level or deployment. 1 = use default, 2 = apply provided |
Numeric |
N |
1 |
Y* mandatory for Bank Transfer Only |
1 |
|
DiscountOptionPercentage |
Percentage of discount or fee share to be applied. Decimal. Default 0. Only required when Discount Option Level = 2 |
Numeric |
N |
1 |
N Y* mandatory for Bank Transfer Only |
0 |
|
STPEnabled |
Enabled for Straight Through Processing. |
Numeric |
N |
1 |
N |
0 |